---
title: "Combine several images into a grid"
method: POST
path: "/image-collage"
tags: ["Images"]
---

# Combine several images into a grid

`POST /image-collage`

## Request

- Base URL: `https://api.cofferdock.com`
- URL: `https://api.cofferdock.com/image-collage`
- Auth: API key in header `x-api-key`

Combines 2 to 30 images into one, in a grid, each fitted inside its cell without cropping. 1 call = 1 credit no matter how many images.

Costs 1 credit per call.

## Request body

- object
  - `images` string[], required: The images to combine: 2 to 30 base64-encoded images (about 4 MB in total), placed left to right and top to bottom in the order given.
  - `columns` integer: Number of columns in the grid, from 1 up to the number of images. Default: automatic and as square as possible (the square root of the image count, rounded up).
  - `cell_width` integer: Width of each cell in pixels (32-4000); every image is scaled to fit inside its cell, never cropped. Default 400.
  - `cell_height` integer: Height of each cell in pixels (32-4000); every image is scaled to fit inside its cell, never cropped. Default 400.
  - `gap` integer: Space between the images and around the edges, in pixels (0-200). Default 10.
  - `background` string: Background color as a hex code, "#rgb" or "#rrggbb". Default "#ffffff" (white).
  - `format` 'jpeg' | 'png' | 'webp': Output image format: "png" (default), "jpeg" or "webp".
  - `output` 'json' | 'binary' | 'url' | 'image': How to return the image: "json" (base64 in the JSON response), "binary" (the image itself, ready for n8n/Make/Zapier) or "url" (a temporary download link, valid 15 minutes). Default: json when the request is JSON, binary when the input was sent raw.

## Response `200`

The resulting image (shape depends on `output`).

- union
  - object
    - `success` boolean
    - `image` string, byte
    - `mime_type` 'image/jpeg' | 'image/png' | 'image/webp'
    - `meta` object
      - `size_bytes` integer
      - `count` integer
      - `columns` integer
      - `rows` integer
      - `width` integer
      - `height` integer
      - `used` integer: Credits used this month, after this call.
      - `remaining` integer, nullable: Credits left this month (null = unlimited).
      - `unlimited` boolean
  - object: Returned when output=url: a temporary download link (valid 15 minutes).
    - `success` boolean
    - `url` string, uri: Temporary download link. Expires in 15 minutes.
    - `expires_at` string, date-time
    - `mime_type` string
    - `size_bytes` integer
    - `meta` object
      - `used` integer: Credits used this month, after this call.
      - `remaining` integer, nullable: Credits left this month (null = unlimited).
      - `unlimited` boolean

## Other responses

- `400`: Invalid input (nothing is charged).
- `401`: Missing or invalid API key.
- `403`: Email not verified.
- `429`: Monthly credit limit reached, or too many requests per minute for this key (see Retry-After).
- `503`: Server busy (queue full). Retry after the seconds in the Retry-After header.

---

[API](https://skmtc.dev/cofferdock/apis/cofferdock-api.md) · [All operations](https://skmtc.dev/cofferdock/apis/cofferdock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cofferdock/apis/cofferdock-api/revisions/b57aa000d33a?raw)