Skip to content

Create Augmentation Job

POST
/v1/augmentation

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.

x-api-key
required
X-Api-Key
string
AugmentationRequest

Request to start a dataset augmentation job.

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
<= 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_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

Augmentation job created successfully

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

Invalid request parameters

ErrorResponse

Standard error response.

object
detail
required
Detail

Error message describing what went wrong

string

Invalid or missing API key

ErrorResponse

Standard error response.

object
detail
required
Detail

Error message describing what went wrong

string

Validation error