Update a project
PATCH
/v1/projects/{projectId}curl -X PATCH 'https://api.embodiflow.io/v1/projects/{projectId}' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"dataFormat": "mcap",
"name": "string",
"description": "string",
"slug": "string",
"dataKind": "human",
"robotType": "string",
"defaultFps": 0,
"defaultTask": "string",
"requiresSegmentation": true
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Path parameters
- projectIdstringrequired
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.
- If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.
Request body
Content-Typeapplication/json
- dataFormatstring | null
Optional import default hint; null clears it.
Allowed valuesmcaprosbag1rosbag2lerobothdf5-embodiflowhdf5-agilexhdf5-realmanhdf5-dobotvideobvharia-vrsumi-gopro - namestring
- descriptionstring | null
- slugstring
- dataKindstringAllowed valueshumanrobotvideo
- robotTypestring | null
- defaultFpsnumber | null
- defaultTaskstring | null
- requiresSegmentationboolean
Responses
Success
- dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- slugstringrequired
- namestringrequired
- descriptionstring | nullrequired
- visibilitystringrequired
- statusstringrequired
- isSampleone ofrequired
- dataKindstringrequiredAllowed valueshumanrobotvideo
- dataFormatstring | null
- robotTypestring | nullrequired
- defaultFpsnumber | nullrequired
- defaultTaskstring | nullrequired
- requiresSegmentationone ofrequired
- lastAccessedAtstring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
- processingobject
- teamRuntimeobject
- handlestring
- refstring
- urlstring
Response example
{
"data": {
"id": "string",
"tenantId": "string",
"slug": "string",
"name": "string",
"description": "string",
"visibility": "string",
"status": "string",
"isSample": false,
"dataKind": "human",
"dataFormat": "string",
"robotType": "string",
"defaultFps": 0,
"defaultTask": "string",
"requiresSegmentation": false,
"lastAccessedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"processing": {
"state": "not_applicable",
"code": "PROJECT_PROCESSING_UNAVAILABLE",
"templateCode": "robot-standard",
"reason": "algorithms_missing",
"missingAlgorithms": [
"string"
]
},
"teamRuntime": {
"state": "ready"
},
"handle": "string",
"ref": "string",
"url": "string"
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1