Create or reuse a cached version export
curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/versions/{versionNumber}/exports' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"format": "lerobot-v3",
"params": {},
"options": {
"episodePer": "episode",
"includeDerivedAction": true,
"includeImages": true,
"includeLabels": true,
"splits": "train",
"taskLanguage": "en",
"videoCodec": "av1",
"maxWidth": 0
}
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Path parameters
- projectIdstringrequired
- versionNumbernumberrequired
Header parameters
- Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.
Request body
- formatstringrequired
The format the project's bound export workflow writes (preview `workflow.format`): lerobot-v3 for the platform LeRobot exporter, workflow for a team export algorithm.
Allowed valueslerobot-v3lerobot-v21originalmp4-jsonrldshdf5-robomimicworkflow - paramsobject
Values for the bound export workflow's own parameters (preview `workflow.params`); a name it does not declare is refused with EXPORT_OPTION_UNSUPPORTED.
- optionsobject
- episodePerstringAllowed valuesepisodesubtask
- includeDerivedActionboolean
- includeImagesboolean
Embed camera frames in the file; meaningful for hdf5-robomimic.
- includeLabelsboolean
- splitsarray<string>
- taskLanguagestringAllowed valuesenzh
- videoCodecstringAllowed valuesav1h264keep
- maxWidthnumber
Camera width after export; 0 keeps the native size. Absent means 1024 for human projects and native for robot projects.
Responses
Success
- dataobjectrequired
- idstringrequired
- formatstringrequired
- optionsobjectrequired
- statestringrequiredAllowed valuesqueuedrunningsucceededfailedcancelled
- loadCheckstring | nullAllowed valuespassedfailednot_applicablenot_evaluated
- loadCheckErrorstring | null
- sizeBytesnumber | null
- createdAtstringrequired
- workflowRunIdstring | null
- progressobject | null
Progress of the running export step; null unless state is running.
{
"data": {
"id": "string",
"format": "string",
"options": {},
"state": "queued",
"loadCheck": "passed",
"loadCheckError": "string",
"sizeBytes": 0,
"createdAt": "string",
"workflowRunId": "string",
"progress": {}
}
}