Skip to main content
POST
Download SQL query results

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

query
string
required

A read-only SELECT statement. Tables must be referenced as [datasetSlug].[modelSlug] and are rewritten to the underlying warehouse table under the hood. Example: "SELECT * FROM my_dataset.my_model"

Maximum string length: 10000
format
enum<string>

Download format. Defaults to csv.

Available options:
csv,
parquet

Response

Download SQL query results

isRefreshing
boolean
required

Whether a model refresh was still running, so very recent writes may be missing. Fetch again shortly for fresher data.

urls
string[]
required

Signed download URLs.