Sign in

v1

latestOpenAPI 3.1.02026-07-223261135.0 KB
tasks

Cancel Task

Request cancellation of an in-flight design task.

Returns 200 with the canceled Task envelope if the executor acknowledges within 5 seconds, or 202 with a canceling Task envelope if the signal was published but the executor hasn't acknowledged yet. Clients should poll the Task status (or subscribe to events) to observe the terminal transition.

post/tasks/{task_id}/cancel

Path parameters

task_idstring required

Prefixed task_ 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.

Example:task_01HT9WK8N3M2J4A5Z6P7Q8R9TV

Headers

Moda-Version'2026-04-12' | '2026-05-01'
Example: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.

Response

Successful Response

idstring required

Prefixed task_... identifier.

kind'design' | 'export' | 'remix' | 'brand_kit_extract' required

Discriminator for the kind-specific result payload.

status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'expired' required

Frozen public status taxonomy. DB enum values are mapped at the API boundary -- never exposed directly.

created_atstring nullable

ISO 8601 timestamp.

started_atstring nullable

ISO 8601 timestamp.

completed_atstring nullable

ISO 8601 timestamp.

attemptinteger required

Current attempt number (1-based).

max_attemptsinteger required

Maximum attempts before dead-lettering.

inputobject nullable

Sanitized echo of the original request.

errorobject nullable

Error info for failed tasks: {message, retryable}.

retry_after_msinteger nullable

Suggested milliseconds to wait before the next poll. Null for terminal tasks.

Example response

{
  "id": "task_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
}