ModaDocs
Remix

Remix a canvas

Duplicates an existing canvas and optionally starts an AI design task on the copy. The original canvas is never modified.

POST
/remix

Authorization

bearerAuth
AuthorizationBearer <token>

API key from Settings > Developer > REST API. Format: moda_live_...

In: header

Request Body

application/json

canvas_id*string

UUID 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.

Formatuuid
prompt?string

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

new_name?string

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

brand_kit_id?string

UUID of a brand kit to apply. The agent uses these colors, fonts, and guidelines. If omitted, the team's default brand kit is used automatically. To run without any brand kit, set skip_brand_kit to true.

Formatuuid
skip_brand_kit?boolean

If true, no brand kit is applied — even if the team has a default. Overrides brand_kit_id when both are provided.

Defaultfalse

Response Body

application/json

curl -X POST "https://api.moda.app/v1/remix" \  -H "Content-Type: application/json" \  -d '{    "canvas_id": "b62c6beb-2de8-4ee5-ac63-068ebe40140b"  }'
{
  "canvas_id": "b62c6beb-2de8-4ee5-ac63-068ebe40140b",
  "canvas_url": "http://example.com",
  "canvas_name": "string",
  "source_canvas_id": "cb6151c0-e416-4f19-9380-4a351c161ab9",
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "job_status": "string",
  "retry_after_seconds": 0,
  "message": "string",
  "credits": {
    "credits_used": 0,
    "credits_remaining": 0
  }
}