GET/v1/collections/{id}
A collection's progress and its images
PARAMETERS
- idpath · stringREQUIRED
- The collection ide.g. col_5kq2wz8xmtnb4hdc7vre
REQUEST
curl "https://api.imageapis.com/v1/collections/col_5kq2wz8xmtnb4hdc7vre" \ -H "X-API-Key: YOUR_KEY"
import requests
r = requests.get("https://api.imageapis.com/v1/collections/col_5kq2wz8xmtnb4hdc7vre", headers={"X-API-Key": "YOUR_KEY"})
print(r.status_code, r.headers.get("X-Gw-Remaining"))
print(r.json())
const r = await fetch("https://api.imageapis.com/v1/collections/col_5kq2wz8xmtnb4hdc7vre", {
headers: { "X-API-Key": "YOUR_KEY" }
});
console.log(r.status, r.headers.get("X-Gw-Remaining"));
console.log(await r.json());
RESPONSE
200OK
{
"id": "col_5kq2wz8xmtnb4hdc7vre",
"object": "collection",
"status": "completed",
"total": 2,
"completed": 2,
"failed": 0,
"template": "tpl_4nq8vzk2hdyw7bxme3rc",
"format": "png",
"scale": 1,
"units": 2,
"images": [
{
"index": 0,
"id": "img_7hk2mq9ztbw4e6nrcxpd",
"status": "completed",
"url": "https://img.imageapis.com/i/img_7hk2mq9ztbw4e6nrcxpd.png",
"bytes": 48213,
"metadata": {
"post": 101
}
},
{
"index": 1,
"id": "img_9xw4nq2kdtbz7hmc3vpe",
"status": "completed",
"url": "https://img.imageapis.com/i/img_9xw4nq2kdtbz7hmc3vpe.png",
"bytes": 51022,
"metadata": {
"post": 102
}
}
],
"created": "2026-10-10T19:02:11Z",
"completed_at": "2026-10-10T19:02:19Z",
"expires": "2026-11-09T19:02:11Z"
}
401Missing or invalid API key (from the gateway)
404No such template or record on this account
{
"error": "string",
"message": "string",
"param": "string"
}