Skip to main content
GET
Get Export Status

Authorizations

Authorization
string
header
required

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

Headers

Authorization
string
required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

exportId
string<uuid>
required

Export ID returned from POST /v1/projects/{projectId}/export

Response

Current export status

Async PDF export status. exportUrl is null while the export is processing or failed, and is populated with a presigned download URL only once state === "completed"; that URL then expires 10 minutes after each poll.

exportId
string<uuid>
required
state
enum<string>
required
Available options:
processing,
completed,
failed
progressPercent
number
required
Required range: 0 <= x <= 100
exportUrl
string<uri> | null
required

Presigned S3 URL, or null while the export is still processing or has failed. Populated only once state === "completed", after which it expires 10 minutes after this response.