Skip to main content
Returns export status and any error. Poll until status is succeeded or failed. Successful file exports include result.downloadUrl. Exports prepared for training cost estimates validate the inputs without creating a file, so their download URL is null.

Signature

Method signature on client.datasets:

Parameters

string
required
Dataset export ID with prefix dex..

Returns

Promise<ExportJob> 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.
ExportId
required
Dataset export ID with prefix dex..
DatasetId
required
Dataset ID with prefix ds..
"running" | "succeeded" | "failed"
required
Export state: running while preparing, succeeded when complete, or failed after an error.
string
required
Time the export was requested, as an ISO 8601 timestamp.
object
required
Download details for the export.
DatasetExportReport | null
required
Training-example validation report, or null for ordinary file exports or before validation finishes.
object | null
required
Failure details, or null when the export has not failed.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: GET /exports/{exportId}.