datasets
Get Dataset Status
Get the processing status of datasets.
This endpoint retrieves the current processing status of one or more datasets,
indicating whether they are being processed, have completed processing, or
encountered errors during pipeline execution.
## Query Parameters
- **dataset** (List[UUID]): List of dataset UUIDs to check status for.
If omitted, returns status for all datasets the user has read permission on
- **pipeline** (List[str], optional): One or more pipeline names to check.
- If omitted, defaults to **cognify_pipeline** (backward-compatible behavior)
- If one pipeline is provided, response is a flat map
- If multiple pipelines are provided, response is nested per dataset and pipeline
- **Available options: add_pipeline, cognify_pipeline**
## Response
Returns status information in one of two shapes:
- Single pipeline (default): {dataset_id: status}
- Multiple pipelines: {dataset_id: {pipeline_name: status}}
Status values:
- **pending**: Dataset is queued for processing
- **running**: Dataset is currently being processed
- **completed**: Dataset processing completed successfully
- **failed**: Dataset processing encountered an error
## Error Codes
- **409 Conflict**: Error retrieving status (e.g. requesting a dataset you don't have
read permission for)
GET
Get Dataset Status
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Dataset UUIDs to check (from GET /api/v1/datasets). Omit to get status for all datasets you can read.
Example:
["b8a7c3de-4f5a-4b6c-8d9e-0f1a2b3c4d5e"]Pipeline names to check: 'add_pipeline' or 'cognify_pipeline'. Omit to default to cognify_pipeline.
Example:
["cognify_pipeline"]Response
Successful Response
- Response Get Dataset Status Api V1 Datasets Status Get
- Response Get Dataset Status Api V1 Datasets Status Get
Available options:
DATASET_PROCESSING_INITIATED, DATASET_PROCESSING_STARTED, DATASET_PROCESSING_COMPLETED, DATASET_PROCESSING_ERRORED Previous
Get Raw DataDownload the raw data file for a specific data item.
This endpoint allows users to download the original, unprocessed data file
for a specific data item within a dataset. The file is returned as a direct
download with appropriate headers.
## Path Parameters
- **dataset_id** (UUID): The unique identifier of the dataset containing the data
- **data_id** (UUID): The unique identifier of the data item to download
## Response
Returns the raw data file as a downloadable response.
## Error Codes
- **404 Not Found**: Data item doesn't exist in the dataset, or its raw file is missing
- **500 Internal Server Error**: Error accessing the raw data file
- **501 Not Implemented**: Raw data is stored on an unsupported storage scheme
Next
Get Dataset Status