Docs
Get Snapshot
Get Snapshot
Poll a snapshot until it finishes or times out.
Endpoint
GET /api/v1/snapshots/{id}
| Parameter | Type | Description |
|---|---|---|
id | string (CUID) | Snapshot identifier returned by Create Snapshot. |
Query Parameters
| Name | Type | Default | Description |
|---|---|---|---|
timeout | integer (ms) | 30000 | Optional. Maximum time the server waits for jobs to finish before responding. |
Example Request
curl -s \
-H "Authorization: Bearer YOUR_API_KEY" \
"https://api.watchero.io/api/v1/snapshots/cmhdgfak60002mdtxnen6g2qi?timeout=120000"Response
The endpoint returns HTTP 202 while any job remains queued and HTTP 200 once processing completes.
Example (202 Accepted)
{
"id": "cmhdgfak60002mdtxnen6g2qi",
"status": "QUEUED",
"results": []
}Example (200 OK)
{
"id": "cmhi3ofyr002f4cpffjcc8mwx",
"status": "COMPLETE",
"results": [
{
"url": "https://site.com/",
"viewport": {
"width": 360,
"height": 640,
"deviceScaleFactor": 1
},
"screenshot": "https://watchero.io/storage/XXXXXXX/360x640@1/https___site.com_.png"
}
]
}When any job fails, the API returns HTTP 200 with status: "ERROR" and a jobs array that includes the failing payload and error message. Validation issues return HTTP 400, missing snapshots return HTTP 404, and server errors return HTTP 500.