collages

Spend one credit and get the clean full-resolution file

A repeated call returns the same result and charges nothing (credits_charged 0). Test keys get 403.

post/collages/{id}/unlock

Request

  • Base URL: https://api.collager.ai/v1
  • URL: https://api.collager.ai/v1/collages/{id}/unlock
  • Auth: HTTP bearer

Path parameters

idstring required
Example:clg_4Rt8sP1qZx0M

Response

Unlocked. hd_url is set.

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.