Dataset

Get a dataset by ID

Changed on
get/api/v1/datasets/{dataset_id}

Request

Path parameters

dataset_idstring required

Response

dataset_idstring required

Unique dataset identifier

kind'uploaded' | 'combined' | 'invented' | 'augmented' | 'translated' | 'localized' | 'extended' nullable required

How this dataset came about. uploaded was supplied by you, combined merges several datasets, invented was generated from a prompt, augmented adds rows retrieved from the curated pool to another dataset, translated / localized add translated copies of another dataset’s rows, and extended adds a next user turn to each of another dataset’s conversations.

source_dataset_idstring nullable required

The dataset this one was derived from. Set when kind is augmented, translated, localized or extended. Null for uploaded and invented, and for combined, which has several sources rather than one.

namestring nullable required

Human-readable name for the dataset

status'pending' | 'running' | 'succeeded' | 'failed' required

Lifecycle status: pending, running, succeeded, or failed

created_atstring date-time required

Timestamp when the dataset was created

created_by_user_idstring uuid nullable required

User who created the dataset

updated_atstring date-time required

Timestamp of the last update

row_countinteger nullable required

Total number of rows in the dataset

run_idstring nullable required

ID of the currently active run

image_column_formatsobject nullable required

Per-column export encoding for detected image columns (column name → format). Use with GET /datasets/{dataset_id}/download: look up the active image column (mapped image column that is also in configured_column_mapping.context) to determine how each row's original_image is encoded. Null or empty when no image columns were detected.

Example response

{
  "kind": "augmented",
  "source_dataset_id": "550e8400-e29b-41d4-a716-446655440000"
}

Changes

    • warning

      added the new extended enum value to the response property for the response status