Skip to main content
GET
Get Export Status

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Path Parameters

canvas_id
string
required

Prefixed cvs_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

Query Parameters

task_id
string
required

Export task ID returned by /export when status='in_progress'.

Response

Successful Response

Response for GET /canvases/{id}/export-status.

task_id
string
required

The export task ID.

status
string
required

queued, running, completed, or failed.

is_terminal
boolean
required

True when status is completed or failed.

canvas_id
string
required

Prefixed canvas identifier the export targets.

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

canvas_url
string
required

Full URL to open the source canvas in the Moda editor.

format
string
required

Delivered format — png, jpeg, pdf, pptx, or zip. Multi-page PNG/JPEG exports surface as zip (per-page files inside).

url
string | null

Signed download URL once the export completes. null while running.

error
string | null

Failure detail when status='failed'.

error_code
string | null

Typed failure code when status='failed' and the export lane reported one — e.g. no_renderable_content (terminal: the canvas rendered 0 pages, so a retry without changing the canvas cannot succeed) or native_export_declined (terminal: the render lane has no path for this content). null when no typed code is available.

retryable
boolean | null

Set when status='failed': false for terminal render failures (retrying the same canvas cannot succeed — fix the content first), true for transient faults where a fresh export attempt can succeed. A failed status is itself terminal for THIS task; retryable says whether starting a new export is worthwhile.

retry_after_seconds
integer | null

Set while is_terminal is False — suggested poll interval.

total_pages
integer | null

Total page count for the source canvas (set on completion).

warnings
ExportWarning · object[]

Quality caveats about the delivered file, set once status='completed' — the same list the synchronous export response would have returned. Empty while running, on failure, and whenever nothing was degraded.