Get a dataset

GET

/v1/datasets/{datasetId}

curl -X GET 'https://api.embodiflow.io/v1/datasets/{datasetId}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

datasetIdstringrequired

Responses

Success

dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- slugstringrequired
- namestringrequired
- descriptionstring | nullrequired
- datasetTypestringrequired
- sourceTypestringrequired
- dataSourcestring | null
- consentAttestedone of
- canAttestConsentone of
- metadataSchemastring | null
- statusstringrequired
- currentVersionIdstring | nullrequired
- versionCountnumber
- currentVersionobject
- qualityStatusstring
  Allowed values
  failed
  warning
  error
  unchecked
  inspecting
  passed
- lastQualityInspectionAtstring | null
- recordingStatusobject
- updatedAtstringrequired
- createdAtstringrequired

Response example

{
  "data": {
    "id": "string",
    "tenantId": "string",
    "projectId": "string",
    "slug": "string",
    "name": "string",
    "description": "string",
    "datasetType": "string",
    "sourceType": "string",
    "dataSource": "string",
    "consentAttested": false,
    "canAttestConsent": false,
    "metadataSchema": "string",
    "status": "string",
    "currentVersionId": "string",
    "versionCount": 0,
    "currentVersion": {
      "id": "string",
      "datasetId": "string",
      "version": 0,
      "versionName": "string",
      "description": "string",
      "status": "string",
      "manifestVersion": 0,
      "metadataType": "string",
      "codebaseVersion": "string",
      "episodeCount": 0,
      "lerobotEpisodeCount": 0,
      "featureCount": 0,
      "fps": 0,
      "topicCount": 0,
      "frameCount": 0,
      "startTimeNs": 0,
      "endTimeNs": 0,
      "metadataProjectionJson": {},
      "contractVersion": "string",
      "provenanceCompleteness": "missing",
      "featureKeys": [
        "string"
      ],
      "itemCount": 0,
      "totalBytes": 0,
      "finalizedAt": "string",
      "createdAt": "string",
      "qualityStatus": "failed",
      "visibilityStatus": "active",
      "splitStrategy": "string",
      "splitConfigJson": {},
      "operationFacts": {
        "contractVersion": "embodiflow-recording-operation-facts/v1",
        "observedAt": "string",
        "processing": {
          "anyActive": false,
          "upload": {
            "activeCount": 0,
            "status": "string",
            "uploadBatchId": "string"
          },
          "workflow": {
            "activeCount": 0,
            "status": "queued",
            "workflowRunId": "string"
          },
          "quality": {
            "activeCount": 0,
            "status": "failed",
            "workflowRunId": "string"
          }
        },
        "health": {
          "status": "unknown",
          "primaryBlockerCode": "string",
          "openRepairCount": 0,
          "observedAt": "string",
          "stale": false
        },
        "playback": {
          "artifactAvailable": false,
          "reasonCode": "string"
        },
        "lastMeaningfulActivityAt": "string"
      }
    },
    "qualityStatus": "failed",
    "lastQualityInspectionAt": "string",
    "recordingStatus": {
      "lifecycle": "failed",
      "quality": "warn",
      "qualityCheckId": "string",
      "qualityVerdict": "warning",
      "stepId": "string",
      "stepWaitReason": "string",
      "noProgressSince": "string",
      "failure": {
        "code": "string",
        "reason": "string",
        "stepId": "string",
        "stepName": "string",
        "stepAlgorithm": {
          "slug": "string",
          "title": "string",
          "official": false
        },
        "stepRunId": "string",
        "runId": "string",
        "stepErrorCode": "string"
      },
      "runId": "string",
      "processingRefused": {
        "code": "string"
      }
    },
    "updatedAt": "string",
    "createdAt": "string"
  }
}

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

{ "data": { "id": "string", "tenantId": "string", "projectId": "string", "slug": "string", "name": "string", "description": "string", "datasetType": "string", "sourceType": "string", "dataSource": "string", "consentAttested": false, "canAttestConsent": false, "metadataSchema": "string", "status": "string", "currentVersionId": "string", "versionCount": 0, "currentVersion": { "id": "string", "datasetId": "string", "version": 0, "versionName": "string", "description": "string", "status": "string", "manifestVersion": 0, "metadataType": "string", "codebaseVersion": "string", "episodeCount": 0, "lerobotEpisodeCount": 0, "featureCount": 0, "fps": 0, "topicCount": 0, "frameCount": 0, "startTimeNs": 0, "endTimeNs": 0, "metadataProjectionJson": {}, "contractVersion": "string", "provenanceCompleteness": "missing", "featureKeys": [ "string" ], "itemCount": 0, "totalBytes": 0, "finalizedAt": "string", "createdAt": "string", "qualityStatus": "failed", "visibilityStatus": "active", "splitStrategy": "string", "splitConfigJson": {}, "operationFacts": { "contractVersion": "embodiflow-recording-operation-facts/v1", "observedAt": "string", "processing": { "anyActive": false, "upload": { "activeCount": 0, "status": "string", "uploadBatchId": "string" }, "workflow": { "activeCount": 0, "status": "queued", "workflowRunId": "string" }, "quality": { "activeCount": 0, "status": "failed", "workflowRunId": "string" } }, "health": { "status": "unknown", "primaryBlockerCode": "string", "openRepairCount": 0, "observedAt": "string", "stale": false }, "playback": { "artifactAvailable": false, "reasonCode": "string" }, "lastMeaningfulActivityAt": "string" } }, "qualityStatus": "failed", "lastQualityInspectionAt": "string", "recordingStatus": { "lifecycle": "failed", "quality": "warn", "qualityCheckId": "string", "qualityVerdict": "warning", "stepId": "string", "stepWaitReason": "string", "noProgressSince": "string", "failure": { "code": "string", "reason": "string", "stepId": "string", "stepName": "string", "stepAlgorithm": { "slug": "string", "title": "string", "official": false }, "stepRunId": "string", "runId": "string", "stepErrorCode": "string" }, "runId": "string", "processingRefused": { "code": "string" } }, "updatedAt": "string", "createdAt": "string" } }