Create a sample run

POST

/v1/data-formats/{formatId}/sample-runs

curl -X POST 'https://api.embodiflow.io/v1/data-formats/{formatId}/sample-runs' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "recordingId": "00000000-0000-0000-0000-000000000000"
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

formatIdstringrequired

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

Content-Typeapplication/json

recordingIdstring (uuid)required

Responses

Success

dataobjectrequired
- idstringrequired
- formatIdstringrequired
- recordingIdstringrequired
- workflowRunIdstringrequired
- statestringrequired
  Allowed values
  queued
  running
  failed
  passed
- converterone ofrequired
- reportobjectrequired
- createdAtstringrequired

Response example

{
  "data": {
    "id": "string",
    "formatId": "string",
    "recordingId": "string",
    "workflowRunId": "string",
    "state": "queued",
    "converter": {
      "kind": "rig_profile",
      "rigProfileRevisionId": "string"
    },
    "report": {
      "verdict": "fail",
      "episodes": 0,
      "frames": 0,
      "features": [
        "string"
      ],
      "droppedTopics": [
        "string"
      ],
      "rules": [
        {
          "id": "string",
          "verdict": "string",
          "message": "string"
        }
      ],
      "errorCode": "string"
    },
    "createdAt": "string"
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1