API reference / Copy a batch background

Copy a batch background

Copy an uploaded background to 1–100 images in your account. Use the returned per-image URLs when exporting.

POST/api/batch/background
Authenticate with X-API-Key. Keep your key on your server; never embed it in a public website.

Request parameters

source_idstringrequired

Image owning the source background.

backgroundstringrequired

Source background URL.

idsarrayrequired

Target image IDs.

Response

200 · Success
{
  "image_id": "/api/files/image_id/bg_background-id.png"
}

Errors use a structured error.code and error.message. See error handling →

Clearcut support