Get a sample run

GET

/v1/algorithms/sample-runs/{id}

curl -X GET 'https://api.embodiflow.io/v1/algorithms/sample-runs/{id}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

idstringrequired

Responses

Success

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

{ "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" } } } }