Sign in

v1

latestOpenAPI 3.1.02026-07-1730321418.0 KB
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. When status=true and a dataset is in Error, the response also includes:

  • error: structured code object with category, type, and stable code
  • error_message: user-visible details
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 status and error metadata (error, error_message) when applicable.

acceleration_enabledboolean required

Whether acceleration is enabled for the dataset

error_messagestring nullable

An optional error message describing why the dataset entered an error state. Only populated when status=true, the dataset status is Error, and an error message was recorded. This value is intended for user-visible display.

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