Skip to content
Scenario Docs
Get started
API Reference
Models
Training Images

Add

POST/models/{modelId}/training-images

Add a new training image to the given modelId

Path ParametersExpand Collapse
modelId: string
Query ParametersExpand Collapse
originalAssets: optional boolean

If set to true, returns the original asset without transformation

Body ParametersJSONExpand Collapse
assetId: optional string

The asset ID to use as a training image (example: “asset_GTrL3mq4SXWyMxkOHRxlpw”). If provided, “data” and “name” parameters will be ignored.

assetIds: optional array of string

The asset IDs to use as training images (example: [“asset_GTrL3mq4SXWyMxkOHRxlpw”, “asset_GTrL3mq4SXWyMxkOHRxlpw”]) Used in batch mode, up to 10 asset IDs are allowed. Cannot be used with “assetId” or “data” and “name” parameters.

data: optional string

The training image as a data URL (example: “data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=”)

name: optional string

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

preset: optional "default" or "style" or "subject"

The preset to use for training images

One of the following:
"default"
"style"
"subject"
ReturnsExpand Collapse
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”)

Add

curl https://api.cloud.scenario.com/v1/models/$MODEL_ID/training-images \
    -H 'Content-Type: application/json' \
    -u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET" \
    -d '{}'
{
  "trainingImage": {
    "id": "id",
    "automaticCaptioning": "automaticCaptioning",
    "createdAt": "createdAt",
    "description": "description",
    "downloadUrl": "downloadUrl",
    "name": "name"
  }
}
Returns Examples
{
  "trainingImage": {
    "id": "id",
    "automaticCaptioning": "automaticCaptioning",
    "createdAt": "createdAt",
    "description": "description",
    "downloadUrl": "downloadUrl",
    "name": "name"
  }
}