Sign in
Datasets

List Datasets

This endpoint returns a list of configured datasets. The response can be formatted as JSON or CSV, and additional filters can be applied using query parameters.

Use status=true query parameter to include the current status of each dataset in the response. Possible status values: initializing, ready, disabled, error, refreshing, shuttingdown.

get/v1/datasets

Query parameters

statusboolean

Whether to include the status field in the response. When true, the response includes the current status of each dataset (e.g., ready, initializing, refreshing, error). Defaults to false.

format'json' | 'csv'

The format of the response. Possible values are 'json' (default) or 'csv'.

sourcestring nullable

Filters datasets by source (e.g., postgres:aidemo_messages).

Response

List of datasets. When status=true is specified, each dataset includes a status field.

acceleration_enabledboolean required

Whether acceleration is enabled for the dataset

fromstring required

The source where the dataset is located (e.g., postgres:syncs)

namestring required

The name of the dataset

propertiesobject

Custom properties for the dataset

replication_enabledboolean required

Whether replication is enabled for the dataset

status'Initializing' | 'Ready' | 'Disabled' | 'Error' | 'Refreshing' | 'ShuttingDown'

Represents the status of a component (e.g. dataset, model, etc).

Changes