Skip to main content
GET
/
canvases
/
{canvas_id}
/
export-status
Get Export Status
curl --request GET \
  --url https://api.moda.app/v1/canvases/{canvas_id}/export-status \
  --header 'Authorization: Bearer <token>'
{
  "task_id": "<string>",
  "status": "<string>",
  "is_terminal": true,
  "canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "canvas_url": "<string>",
  "format": "<string>",
  "url": "<string>",
  "error": "<string>",
  "retry_after_seconds": 123,
  "total_pages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.moda.app/llms.txt

Use this file to discover all available pages before exploring further.

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). Path parameters additionally accept a bare UUID string for back-compat; JSON body fields require the prefixed form.

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

Export format requested.

​
url
string | null

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

​
error
string | null

Failure detail when status='failed'.

​
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).