Skip to main content
POST
Create Augmentation

Authorizations

Authorization
string
header
required

A Kite API key (kite_...), from Platform API → Keys in the dashboard.

Headers

Idempotency-Key
string | null
Maximum string length: 255
Kite-Version
enum<string>
default:2026-09-27

The dated contract your code was written against. Without it you get 2026-09-27; every response says which version served it.

Available options:
2026-09-27,
2026-10-12

Body

application/json
source
AugmentationSource · object
required
instructions
string
required
Required string length: 3 - 2000
config
AugmentationConfig · object
output
AugmentationOutput · object
model
string | null

'auto' (default: the planner picks per camera), 'relight' (colour and exposure transform of every episode), 'background' (a panorama behind the work cell; the robot, objects and table keep their pixels), 'world' (a 3D world rendered from each camera's pose, for moving cameras) or 'video' (generative video augmentation)

environments
AugmentationEnvironments · object | null

Background and world: what to put behind the work cell (default: 3 matched to the rig)

must_keep
string[] | null

Things that must keep their recorded pixels, besides the robot and what it handles; one behind the work cell means generative video

Maximum array length: 20
Required string length: 1 - 200
reference_images
ReferenceImage · object[] | null

Photos of the target look (e.g. from the deployment cameras): at most 5 MB each, 20 MB in total

Maximum array length: 6
webhook_metadata
Webhook Metadata · object | null

Opaque metadata echoed on the resource and future webhook events

Response

The augmentation, processing

One augmentation of a Hugging Face LeRobot dataset, keeping its motion: every episode relit, or new episodes generated by video augmentation.

id
string
required

aug_ + a time-ordered ULID

status
enum<string>
required
Available options:
processing,
succeeded,
failed,
canceled
progress
number
required

Of the current phase (import, generate, publish): it starts again from 0 at each

Required range: 0 <= x <= 1
model
string
required

auto until the planner decides, then relight, video, background, world or mixed

source
AugmentationSource · object
required
instructions
string
required
config
AugmentationConfig · object
required
output
AugmentationHuggingFaceOutput · object
required

Where the episodes go, as given at create

tokens
AugmentationTokens · object
required
object
enum<string>
default:augmentation
Available options:
augmentation
Allowed value: "augmentation"
status_message
string | null

What it is doing now, or the last thing it did

error
AugmentationError · object | null

Set when failed

pixel_exact
boolean | null

Whether what the request leaves alone keeps its recorded pixels: true for relight (each pixel recoloured in place) and background or world (the robot, objects and table keep their source pixels); false when generative video made any camera's clips (it redraws every pixel, so the robot and objects can drift or change; each episode's check says what was found). Null until planned

environments
AugmentationEnvironments · object | null

What the background and world engines put behind the work cell: exactly one of ids or prompt, or a filter and/or count to pick from your ready environments and the Kite library (fitted to the rig's light).

must_keep
string[] | null
plan
AugmentationPlan · object | null

Set once the run is planned: what it does and why

awaiting_approval
boolean
default:false

The preview passed and the run waits for POST /v1/augmentations/{id}/approve

gates
AugmentationGates · object | null

Background and world, once the episodes ran

webhook_metadata
Webhook Metadata · object | null
created_at
string | null