collages

Create a shape collage (heart, number, word ...) from photos

post/collages

Request

  • Base URL: https://api.collager.ai/v1
  • URL: https://api.collager.ai/v1/collages
  • Auth: HTTP bearer

Headers

Preferstring
Example:wait=25

"wait=N" (N up to 25) - wait up to N seconds for the collage to finish before answering.

Idempotency-Keystring

Repeating a POST with the same key returns the first job instead of creating a second one.

Request body

photo_urlsstring[] required

Photos (JPEG/PNG/WEBP). Fewer photos than cells - photos repeat.

gap_pctnumber
size_pxinteger

Long side of the full-resolution file (the figure keeps a 9 % white margin).

backgroundstring

white, cream, pink, gray, black or

webhook_urlstring uri
metadataobject

Example request

{
  "background": "white"
}

Response

Finished within the Prefer wait time.

idstring required
object'collage' required
status'queued' | 'processing' | 'preview_ready' | 'unlocked' | 'failed' required
shapestring nullable
cellsinteger nullable
photos_usedinteger nullable
widthinteger nullable
heightinteger nullable
preview_urlstring uri nullable

Watermarked preview (<= 1200 px). Link valid 24 h - every GET gives a fresh one.

hd_urlstring uri nullable

Clean full-resolution JPEG, after unlock. Link valid 24 h.

credits_leftinteger

Returned by unlock.

credits_chargedinteger

Returned by unlock - 1 the first time, 0 on repeats.

metadataobject
created_atstring date-time required
expires_atstring date-time required

Example response

{
  "id": "clg_4Rt8sP1qZx0M",
  "shape": "heart of 70",
  "error": {
    "code": "too_few_tiles"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.