Sign in
Canvas

Generate images onto a canvas

post/v1/canvases/{assetId}/images

Path parameters

assetIdstring required

ID of the canvas asset

Request body

requestIdstring uuid required

Client-minted idempotency key for this submit

promptstring required

What to draw or change in this iteration

briefstring

The original design brief to preserve across iterations

countinteger

How many variations

intent'reference' | 'concept-plan'

Omit to let the backend resolve it

sourceTreatment'text-only' | 'edit' | 'inspiration'

Omit to let the backend resolve it; only the retry path replays a stored one

aspectRatio'1:1' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '9:16' | '16:9' | '21:9'
thinking'standard' | 'high'

Omit for standard thinking

referenceAssetIdsstring[]

Images to generate from

replaceAssetIdstring uuid

The image this result takes the place of

Response

Images admitted

successboolean required

Indicates if the request was successful

messagestring required

Human readable message

timestampstring date-time required

Timestamp of the response

Changes

Changed in 2 of the 11 revisions of this API.22

  • ad71cae36f2921See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

  • 28c2b3b6b3b41See the full diff
    • ○

      endpoint added

      endpoint-added