Get the processing status of a dataset

GET/api/v1/datasets/{dataset_id}/status

Path ParametersExpand Collapse

dataset_id: string

ReturnsExpand Collapse

dataset_id: string

Dataset ID

status: "pending" or "running" or "awaiting_input" or 2 more

Current processing status. awaiting_input means the dataset is uploaded but waiting for you to start adaptation via datasets.run(column_mapping=...) — it will not progress on its own.

One of the following:

"pending"

"running"

"awaiting_input"

"succeeded"

"failed"

row_count: number

Number of rows in the dataset

progress: object { percent, processed_rows, total_rows }

Processing progress. Null when no run is active.

percent: number

Progress percentage (0-100)

processed_rows: number

Number of rows processed so far

total_rows: number

Total rows to process (samples_to_process or row_count)

error_data: object { message, code, level }

Error details if the dataset failed. Null otherwise.

message: string

Error message

code: string

Stable error code when the failure was structured (e.g. E0100)

level: "error" or "warning"

Severity when known

One of the following:

"error"

"warning"

Get the processing status of a dataset

curl https://api.prod.adaptionlabs.ai/api/v1/datasets/$DATASET_ID/status \
    -H "Authorization: Bearer $ADAPTION_API_KEY"

{
  "dataset_id": "dataset_id",
  "status": "pending",
  "row_count": 0,
  "progress": {
    "percent": 0,
    "processed_rows": 0,
    "total_rows": 0
  },
  "error_data": {
    "message": "message",
    "code": "code",
    "level": "error"
  }
}

Returns Examples

{
  "dataset_id": "dataset_id",
  "status": "pending",
  "row_count": 0,
  "progress": {
    "percent": 0,
    "processed_rows": 0,
    "total_rows": 0
  },
  "error_data": {
    "message": "message",
    "code": "code",
    "level": "error"
  }
}