Skip to main content
GET
/
api
/
v1
/
datasets
/
{dataset_id}
/
download
Download dataset in specified format
curl --request GET \
  --url https://api.example.com/api/v1/datasets/{dataset_id}/download \
  --header 'Authorization: Bearer <token>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
dataset_id
string
required

Query Parameters

​
format
string
required

Download format: csv, excel, or json

Pattern: ^(csv|excel|json)$
​
limit
integer | null

Optional row cap for preview/picker callers. When set, applies LIMIT at the database layer so we don't serialize/transfer the full dataset just to slice it client-side. Omit to download the full dataset (existing behavior).

Required range: 1 <= x <= 10000

Response

Successful Response