Skip to content
rowlab Docs

Download Dataset

GET
/v1/datasets/{dataset_id}/export
curl --request GET \
  --url 'https://example.com/v1/datasets/example/export?format=csv&include_row_id=false' \
  --header 'Authorization: Bearer <token>'

Download the dataset as a CSV, JSONL or Parquet file, named after it. Nested values are JSON text in CSV. A dataset still being made can’t be exported until its run is done.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
dataset_id
required
Dataset Id
string

Query Parameters

Section titled “Query Parameters”
format
required
Format
string
Allowed values: csv jsonl parquet
include_row_id
Include Row Id
boolean
sql
Any of:
string

Only the rows this query picks; it must return __row_id.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/octet-stream

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}