Sign in

v1

latestOpenAPI 3.1.02026-07-223261135.0 KB
remix

Remix Canvas

Duplicate a canvas and optionally apply edits with AI.

Always returns a Task(kind="remix") envelope — uniform across the prompted and promptless paths. The promptless path completes synchronously and returns status="succeeded" inline, so the returned id is a synthetic (non-queryable) UUID and retry_after_ms is None. The prompted path returns the in-flight task envelope; callers poll GET /v1/tasks/{id} to observe completion.

post/remix

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.

Request body

canvas_idstring required

Prefixed cvs_ ID of the source canvas to duplicate. The source canvas may belong to a different team. The copy is created in the team specified by team_id.

promptstring nullable

Optional natural-language edit prompt to apply to the copy. If omitted, the canvas is duplicated without modifications.

new_namestring nullable

Name for the new canvas. Defaults to the source canvas name.

brand_kit_idstring nullable

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

skip_brand_kitboolean

If true, no brand kit is applied — every brand-kit source is suppressed, including the canvas's own kit, the team default, and any explicit brand_kit_id override. Use only when the design must be unbranded; to merely leave the source canvas's kit alone, omit brand_kit_id instead.

Example request

{
  "canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
}

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"
}