Skip to main content
POST
/
v1
/
datasets
Create Dataset
curl --request POST \
  --url https://api.example.com/v1/datasets \
  --header 'Content-Type: application/json' \
  --data '
{
  "columns": [
    {
      "name": "<string>"
    }
  ],
  "connection_config": {
    "uri": "<string>",
    "connector_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connector_credential_name": "<string>",
    "connector_type": "s3",
    "region": "<string>",
    "file_format": "<string>"
  },
  "filter": {
    "col": "<string>",
    "kind": "cmp",
    "value": "<string>"
  }
}
'
{
  "columns": [
    {
      "name": "<string>"
    }
  ],
  "connection_config": {
    "uri": "<string>",
    "connector_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connector_credential_name": "<string>",
    "connector_type": "s3",
    "region": "<string>",
    "file_format": "<string>"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "filter": {
    "col": "<string>",
    "kind": "cmp",
    "value": "<string>"
  }
}

Headers

​
authorization
string | null
​
refresh-token
string | null

Body

application/json

POST /v1/datasets body — an inline dataset spec to register.

​
columns
DatasetColumn · object[]
required
​
connection_config
S3ConnectionConfig · object
required

Read from a user-owned S3 object.

The full s3://bucket[/prefix]/key URI addresses a single object; no source_table / prefix-then-key split. The credential reference resolves server-side to the IAM role to assume. A user may register several S3 credentials, so the URI alone can't say which to use.

​
filter
Comparison · object

A single column comparison, e.g. col("ts") >= "2024-01-01".

value is unused for is_null / is_not_null and is a list for in / not_in. Timestamps travel as ISO-8601 strings and are coerced to the column dtype trainer-side.

Response

Successful Response

​
columns
DatasetColumn · object[]
required
​
connection_config
S3ConnectionConfig · object
required

Read from a user-owned S3 object.

The full s3://bucket[/prefix]/key URI addresses a single object; no source_table / prefix-then-key split. The credential reference resolves server-side to the IAM role to assume. A user may register several S3 credentials, so the URI alone can't say which to use.

​
id
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
filter
Comparison · object

A single column comparison, e.g. col("ts") >= "2024-01-01".

value is unused for is_null / is_not_null and is a list for in / not_in. Timestamps travel as ISO-8601 strings and are coerced to the column dtype trainer-side.