Skip to main content
POST
Create Export Job

Authorizations

Authorization
string
header
required

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

Query Parameters

dataset_id
integer | null

From POST /datasets. Pass this or table_id.

table_id
string | null

The Rippit table id, e.g. from MCP. Pass this or dataset_id.

Body

application/json
select
WorkspaceField · object[] | null

Columns, each optionally with agg (count, count_distinct, sum, avg, min, max) and alias. Leave out for every column.

where
string | null

RipQL subset: col op literal with AND / OR, e.g. n > 1 AND tier IN ('a', 'b').

group_by
string[]
order_by
tuple[]

[column or alias, ascending] pairs.

limit
integer | null

Leave out for every row.

Required range: x >= 1
format
enum<string>
default:parquet

csv is gzipped.

Available options:
parquet,
csv

Response

Successful Response

job_id
string
required
kind
enum<string>
required
Available options:
conversation_blocks,
dataset_rows,
export
status
enum<string>
required
Available options:
awaiting_upload,
queued,
running,
done,
failed
created_at
string<date-time>
required
result
DatasetResult · object

Uploads: set once done.

files
ExportFile · object[]

Exports: set once done.

expires_at
string<date-time> | null

Exports: when files urls stop working.

error
string | null

Set once failed.