Create Augmentation Job

POST

/v1/augmentation

const url = 'https://example.com/v1/augmentation';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"project_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","dataset_id":"lerobot/pusht","augmentation_type":"deterministic","name":"example","augment_transforms":"lighting","augment_mode":"stacked","augment_copies":3,"augment_copies_per_transform":{"additionalProperty":1},"augment_dataset_mode":"copy","augment_brightness_min":-15,"augment_brightness_max":15,"augment_contrast_min":-10,"augment_contrast_max":10,"augment_color_temp_min":4000,"augment_color_temp_max":6500,"noise_type":"mixed","noise_gaussian_sigma_min":3,"noise_gaussian_sigma_max":15,"noise_shot_scale_min":0.3,"noise_shot_scale_max":1,"blur_type":"mixed","blur_motion_kernel_min":5,"blur_motion_kernel_max":15,"blur_defocus_sigma_min":0.5,"blur_defocus_sigma_max":2.5,"occlusion_type":"mixed","occlusion_num_patches_min":1,"occlusion_num_patches_max":3,"occlusion_patch_width_min":0.05,"occlusion_patch_width_max":0.2,"occlusion_patch_height_min":0.05,"occlusion_patch_height_max":0.2,"cosmos_prompt":"A robot arm performing a task in a different environment.","cosmos_prompts":["example"],"cosmos_control_type":"edge","cosmos_control_weight":1,"cosmos_guidance":3,"cosmos_num_steps":4,"cosmos_seed":42,"cosmos_model_variant":"edge/distilled","cosmos_disable_guardrails":false,"cosmos_camera_name":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/augmentation \
  --header 'Content-Type: application/json' \
  --data '{ "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dataset_id": "lerobot/pusht", "augmentation_type": "deterministic", "name": "example", "augment_transforms": "lighting", "augment_mode": "stacked", "augment_copies": 3, "augment_copies_per_transform": { "additionalProperty": 1 }, "augment_dataset_mode": "copy", "augment_brightness_min": -15, "augment_brightness_max": 15, "augment_contrast_min": -10, "augment_contrast_max": 10, "augment_color_temp_min": 4000, "augment_color_temp_max": 6500, "noise_type": "mixed", "noise_gaussian_sigma_min": 3, "noise_gaussian_sigma_max": 15, "noise_shot_scale_min": 0.3, "noise_shot_scale_max": 1, "blur_type": "mixed", "blur_motion_kernel_min": 5, "blur_motion_kernel_max": 15, "blur_defocus_sigma_min": 0.5, "blur_defocus_sigma_max": 2.5, "occlusion_type": "mixed", "occlusion_num_patches_min": 1, "occlusion_num_patches_max": 3, "occlusion_patch_width_min": 0.05, "occlusion_patch_width_max": 0.2, "occlusion_patch_height_min": 0.05, "occlusion_patch_height_max": 0.2, "cosmos_prompt": "A robot arm performing a task in a different environment.", "cosmos_prompts": [ "example" ], "cosmos_control_type": "edge", "cosmos_control_weight": 1, "cosmos_guidance": 3, "cosmos_num_steps": 4, "cosmos_seed": 42, "cosmos_model_variant": "edge/distilled", "cosmos_disable_guardrails": false, "cosmos_camera_name": "example" }'

Start a new dataset augmentation job.

Applies deterministic transforms (lighting, noise, blur, occlusion) to a HuggingFace dataset and uploads the augmented result. The GPU instance is auto-selected based on the augmentation type.

Generative augmentation (Cosmos Transfer2.5) is currently disabled and will return 400 if requested.

Parameters

Header Parameters

x-api-key

Any of:

string
null

string

Request Body^required

application/json

AugmentationRequest

Request to start a dataset augmentation job.

Mirrors AugmentationJobCreateRequest in the training API. Field defaults must stay aligned — see q_training_api.models.training_models.

object

project_id

required

Project Id

Project ID to associate the job with

string format: uuid

dataset_id

required

Dataset Id

HuggingFace dataset ID to augment

string

augmentation_type

AugmentationType

‘deterministic’ applies fast CPU transforms (lighting, noise, blur, occlusion). ‘generative’ uses Cosmos Transfer2.5 to re-render frames in a target environment (currently disabled).

string

default: deterministic

Allowed values: deterministic generative

name

Any of:

string
null

string

<= 255 characters

augment_transforms

Augment Transforms

Comma-separated transforms: lighting, noise, blur, occlusion

string

default: lighting

augment_mode

Augment Mode

‘stacked’ applies all transforms to each copy. ‘independent’ creates one copy per transform.

string

default: stacked

Allowed values: stacked independent

augment_copies

Augment Copies

Number of augmented copies per episode (when dataset_mode=copy)

integer

default: 3 >= 1 <= 20

augment_copies_per_transform

Any of:

object
null

object

key

additional properties

integer

augment_dataset_mode

Augment Dataset Mode

‘copy’ adds augmented copies to the original dataset. ‘inplace’ replaces the originals with augmented versions.

string

default: copy

Allowed values: copy inplace

augment_brightness_min

Augment Brightness Min

number

default: -15 >= -50

augment_brightness_max

Augment Brightness Max

number

default: 15 <= 50

augment_contrast_min

Augment Contrast Min

number

default: -10 >= -50

augment_contrast_max

Augment Contrast Max

number

default: 10 <= 50

augment_color_temp_min

Augment Color Temp Min

integer

default: 4000 >= 2000 <= 6500

augment_color_temp_max

Augment Color Temp Max

integer

default: 6500 >= 4000 <= 10000

noise_type

Noise Type

Gaussian, shot, read, or mixed

string

default: mixed

noise_gaussian_sigma_min

Noise Gaussian Sigma Min

number

default: 3 <= 50

noise_gaussian_sigma_max

Noise Gaussian Sigma Max

number

default: 15 <= 50

noise_shot_scale_min

Noise Shot Scale Min

number

default: 0.3 <= 5

noise_shot_scale_max

Noise Shot Scale Max

number

default: 1 <= 5

blur_type

Blur Type

Motion, defocus, or mixed

string

default: mixed

blur_motion_kernel_min

Blur Motion Kernel Min

integer

default: 5 >= 3 <= 50

blur_motion_kernel_max

Blur Motion Kernel Max

integer

default: 15 >= 3 <= 50

blur_defocus_sigma_min

Blur Defocus Sigma Min

number

default: 0.5 >= 0.1 <= 10

blur_defocus_sigma_max

Blur Defocus Sigma Max

number

default: 2.5 >= 0.1 <= 10

occlusion_type

Occlusion Type

Rectangle, overlay, or mixed

string

default: mixed

occlusion_num_patches_min

Occlusion Num Patches Min

integer

default: 1 >= 1 <= 10

occlusion_num_patches_max

Occlusion Num Patches Max

integer

default: 3 >= 1 <= 10

occlusion_patch_width_min

Occlusion Patch Width Min

number

default: 0.05 >= 0.01 <= 0.5

occlusion_patch_width_max

Occlusion Patch Width Max

number

default: 0.2 >= 0.01 <= 0.5

occlusion_patch_height_min

Occlusion Patch Height Min

number

default: 0.05 >= 0.01 <= 0.5

occlusion_patch_height_max

Occlusion Patch Height Max

number

default: 0.2 >= 0.01 <= 0.5

cosmos_prompt

Cosmos Prompt

Prompt for Cosmos Transfer2.5 generation

string

default: A robot arm performing a task in a different environment.

cosmos_prompts

Cosmos Prompts

Multiple prompts — overrides cosmos_prompt if non-empty

Array<string>

cosmos_control_type

Cosmos Control Type

Control type: edge, depth, seg, or vis

string

default: edge

cosmos_control_weight

Cosmos Control Weight

number

default: 1 <= 2

cosmos_guidance

Cosmos Guidance

integer

default: 3 >= 1 <= 20

cosmos_num_steps

Cosmos Num Steps

integer

default: 4 >= 1 <= 100

cosmos_seed

Cosmos Seed

integer

default: 42

cosmos_model_variant

Cosmos Model Variant

string

default: edge/distilled

cosmos_disable_guardrails

Cosmos Disable Guardrails

boolean

cosmos_camera_name

Any of:

string
null

string

Responses

200

Augmentation job created successfully

application/json

AugmentationResponse

Response after creating an augmentation job.

object

job_id

required

Job Id

Unique job identifier

string format: uuid

status

required

Status

Current job status

string

message

Any of:

string
null

string

Example ^generated

{
  "job_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": "example",
  "message": "example"
}

400

Invalid request parameters

application/json

ErrorResponse

Standard error response.

object

detail

required

Detail

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

401

Invalid or missing API key

application/json

ErrorResponse

Standard error response.

object

detail

required

Detail

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation error

Create Augmentation Job

Parameters

Header Parameters

Request Body required

Responses

200

Example generated

400

Example generated

401

Example generated

422

Request Body^required

Example ^generated

Example ^generated

Example ^generated