Create a sample run

POST

/v1/algorithms/sample-runs

curl -X POST 'https://api.embodiflow.io/v1/algorithms/sample-runs' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "source": "string",
    "algorithmVersion": {
      "algorithmId": "00000000-0000-0000-0000-000000000000",
      "version": "string"
    },
    "inputs": {
      "recordingId": "00000000-0000-0000-0000-000000000000",
      "episode": {
        "recordingId": "00000000-0000-0000-0000-000000000000",
        "index": 0
      },
      "versionId": "00000000-0000-0000-0000-000000000000"
    },
    "window": {},
    "params": {}
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

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

sourcestring | null
algorithmVersionobject | null
- algorithmIdstring (uuid)required
- versionstringrequired
inputsobjectrequired
- recordingIdstring (uuid) | null
- episodeobject | null
- versionIdstring (uuid) | null
windowobject | null
paramsobject | null

Responses

Run accepted; poll GET for state

dataobjectrequired
- idstringrequired
- statestringrequired
  Allowed values
  queued
  running
  succeeded
  failed
  timed_out
- recordingIdsarray<string>required
- inputKindstringrequired
  Allowed values
  metadata_only
  recording_files
  version_files
- inputBytesnumber | nullrequired
- deadlineSecondsnumberrequired
- createdAtstringrequired
- startedAtstring | nullrequired
- finishedAtstring | nullrequired
- resultobjectrequired

Response example

{
  "data": {
    "id": "string",
    "state": "queued",
    "recordingIds": [
      "string"
    ],
    "inputKind": "metadata_only",
    "inputBytes": 0,
    "deadlineSeconds": 0,
    "createdAt": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "result": {
      "state": "succeeded",
      "durationMs": 0,
      "logs": "string",
      "logsTruncated": false,
      "outputs": [
        {
          "name": "string",
          "type": "string",
          "summary": "string"
        }
      ],
      "preview": {
        "contract": "embodiflow-sample-preview/v1",
        "category": "export",
        "window": {
          "startS": 0,
          "endS": 0
        },
        "outcome": "succeeded",
        "series": [
          {
            "name": "string",
            "type": "string",
            "unit": "string",
            "columns": [],
            "t": [],
            "y": [],
            "rows": 0
          }
        ],
        "recordingValues": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "episodeValues": [
          {
            "name": "string",
            "type": "string",
            "values": []
          }
        ],
        "checks": [
          {
            "id": "string",
            "title": "string",
            "status": "warn",
            "value": 0,
            "threshold": 0,
            "message": "string",
            "at": {},
            "episodeIndex": 0
          }
        ],
        "episodes": [
          {
            "index": 0,
            "startS": 0,
            "endS": 0,
            "task": "string",
            "labels": {},
            "confidence": 0
          }
        ],
        "selection": {
          "kept": 0,
          "dropped": 0,
          "items": [
            {}
          ]
        },
        "canonical": {
          "ok": false,
          "issues": [
            {}
          ]
        },
        "artifact": {
          "format": "string",
          "files": [
            {}
          ],
          "summary": {}
        },
        "logs": "string",
        "errors": [
          {
            "code": "string",
            "message": "string",
            "file": "string",
            "line": 0
          }
        ]
      },
      "error": {
        "code": "string",
        "message": "string"
      }
    }
  }
}

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