API Reference

Models

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Training Images

Add

client.models.trainingImages.add(stringmodelID, TrainingImageAddParams { originalAssets, assetId, assetIds, 3 more } params, RequestOptionsoptions?): TrainingImageAddResponse { trainingImage }

POST/models/{modelId}/training-images

Replace Pairs

client.models.trainingImages.replacePairs(stringmodelID, TrainingImageReplacePairsParams { body } params, RequestOptionsoptions?): TrainingImageReplacePairsResponse { count, pairs }

PUT/models/{modelId}/training-images/pairs

Replace

client.models.trainingImages.replace(stringtrainingImageID, TrainingImageReplaceParams { modelId, originalAssets, assetId, 4 more } params, RequestOptionsoptions?): TrainingImageReplaceResponse { trainingImage }

PUT/models/{modelId}/training-images/{trainingImageId}

Delete

client.models.trainingImages.delete(stringtrainingImageID, TrainingImageDeleteParams { modelId } params, RequestOptionsoptions?): TrainingImageDeleteResponse

DELETE/models/{modelId}/training-images/{trainingImageId}

ModelsExpand Collapse

TrainingImageAddResponse { trainingImage }

trainingImage: TrainingImage { 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 { count, pairs }

count: number

Number of training image pairs

pairs: Array<Pair>

Array of training image pairs

instruction?: string

The instruction for the image pair, source to target

sourceId?: string

The source asset ID (must be a training asset)

targetId?: string

The target asset ID (must be a training asset)

TrainingImageReplaceResponse { trainingImage }

trainingImage: TrainingImage { 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