Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

datasetId
string
required

Dataset ID with prefix ds..

Pattern: ^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json

Select dataset fields to export as a JSON array.

fields
string[]
required

Fields to include in the export, identified by field name or id.

Minimum array length: 1
format
enum<string>
default:json-array

Emit the selected fields as one JSON array. The default when format is omitted.

Available options:
json-array

Response

Export started

An asynchronous dataset export job. Failed jobs include an error. Successful file exports include a download URL; exports prepared for training cost estimates include a validation report and a null download URL.

createdAt
string<date-time>
required

Time the export was requested, as an ISO 8601 timestamp.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
datasetId
string
required

Dataset ID with prefix ds..

Pattern: ^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
error
object | null
required

Failure details, or null when the export has not failed.

id
string
required

Dataset export ID with prefix dex..

Pattern: ^dex\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
report
object | null
required

Training-example validation report, or null for ordinary file exports or before validation finishes.

result
object
required

Download details for the export.

status
enum<string>
required

Export state: running while preparing, succeeded when complete, or failed after an error.

Available options:
running,
succeeded,
failed