---
title: "Get a collage"
method: GET
path: "/collages/{id}"
tags: ["collages"]
---

# Get a collage

`GET /collages/{id}`

## Request

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

## Path parameters

- `id` string, required

## Headers

- `Prefer` string

## Response `200`

The collage.

- Collage
  - `id` string, required
  - `object` 'collage', required
  - `status` 'queued' | 'processing' | 'preview_ready' | 'unlocked' | 'failed', required
  - `shape` string, nullable
  - `cells` integer, nullable
  - `photos_used` integer, nullable
  - `width` integer, nullable
  - `height` integer, nullable
  - `preview_url` string, uri, nullable: Watermarked preview (<= 1200 px). Link valid 24 h - every GET gives a fresh one.
  - `hd_url` string, uri, nullable: Clean full-resolution JPEG, after unlock. Link valid 24 h.
  - `credits_left` integer: Returned by unlock.
  - `credits_charged` integer: Returned by unlock - 1 the first time, 0 on repeats.
  - `error` JobError
    - `code` string, required
    - `message` string, required
  - `metadata` object
  - `created_at` string, date-time, required
  - `expires_at` string, date-time, required

## Other responses

- `404`: Error.

---

[API](https://skmtc.dev/collager/apis/collager-ai-photo-mosaic-photo-collage-api.md) · [All operations](https://skmtc.dev/collager/apis/collager-ai-photo-mosaic-photo-collage-api/llms.txt) · [OpenAPI document](https://skmtc.dev/collager/apis/collager-ai-photo-mosaic-photo-collage-api/revisions/719c6e7aaf09?raw)