Skip to content
Get started

Training Images

Add
POST/models/{modelId}/training-images
Replace Pairs
PUT/models/{modelId}/training-images/pairs
Replace
PUT/models/{modelId}/training-images/{trainingImageId}
Delete
DELETE/models/{modelId}/training-images/{trainingImageId}
ModelsExpand Collapse
TrainingImageAddResponse object { trainingImage }
trainingImage: object { id, automaticCaptioning, createdAt, 3 more }
id: string

The training image ID (example: “asset_GTrL3mq4SXWyMxkOHRxlpw”)

automaticCaptioning: string

Automatic captioning of the image

createdAt: string

The training image upload date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

description: string

Description for the image

downloadUrl: string

The URL of the image

name: string

The original file name of the image (example: “my-training-image.jpg”)

TrainingImageReplacePairsResponse object { count, pairs }
count: number

Number of training image pairs

pairs: array of object { instruction, sourceId, targetId }

Array of training image pairs

instruction: optional string

The instruction for the image pair, source to target

sourceId: optional string

The source asset ID (must be a training asset)

targetId: optional string

The target asset ID (must be a training asset)

TrainingImageReplaceResponse object { trainingImage }
trainingImage: object { id, automaticCaptioning, createdAt, 3 more }
id: string

The training image ID (example: “asset_GTrL3mq4SXWyMxkOHRxlpw”)

automaticCaptioning: string

Automatic captioning of the image

createdAt: string

The training image upload date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

description: string

Description for the image

downloadUrl: string

The URL of the image

name: string

The original file name of the image (example: “my-training-image.jpg”)

TrainingImageDeleteResponse = unknown