Skip to main content
POST
Create an export

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, e.g. cpb_live_… or cpb_test_….

Headers

Idempotency-Key
string<uuid>

A unique key (e.g. a UUID). Retrying with the same key returns the original response instead of doing the work twice.

Path Parameters

dataset_id
string
required
Example:

"DS-301"

Body

application/json
format
enum<string>
required

lerobot (Hugging Face LeRobot), rlds (RLDS / TFRecord), webdataset (.tar shards) or mp4-json (MP4 + JSON annotations).

Available options:
lerobot,
rlds,
webdataset,
mp4-json
destination
enum<string>
required

A connected integration, or link for a signed download link (24h).

Available options:
s3,
gcs,
hf,
link
task_ids
string[]

Only export these tasks. All tasks by default.

created_after
string<date-time>

Only export videos accepted after this time, for incremental exports.

include_rejected
boolean
default:false
blur_faces
boolean
default:true

Blur any faces or screens detected in frame.

Response

The export was queued.

id
string
Example:

"EXP-20931"

dataset_id
string
Example:

"DS-301"

status
enum<string>
Available options:
queued,
packaging,
ready,
failed
format
string
Example:

"lerobot"

destination
string
Example:

"s3"

videos
integer
Example:

7339

url
string | null

Where the export was delivered, once ready.

Example:

"s3://timefactories/datasets/DS-301/v1.2"

created_at
string<date-time>
completed_at
string<date-time> | null