GET
Get asynchronous capture status

Authorizations

Authorization
string
header
required

Authenticate with a Snapsnip API key using Authorization: Bearer <api-key>.

Path Parameters

capture_id
string
required

The unique identifier returned when the asynchronous capture request was accepted.

Required string length: 36

Response

Current asynchronous capture status.

Current state and available result details for an asynchronous capture.

capture_id
string
required

Opaque identifier returned when the capture was accepted.

Required string length: 36
completed_at
string<date-time> | null
required

Time at which processing reached a terminal state, or null while processing is incomplete.

requested_at
string<date-time>
required

Time at which the server accepted the request.

started_at
string<date-time> | null
required

Time at which processing began, or null while the capture is queued.

status
enum<string>
required

Current lifecycle state of the capture.

Available options:
queued,
running,
completed,
failed,
expired
content_type
string | null

Media type of the completed result, such as image/png or application/pdf.

delivery
null | object

State of the requested external delivery.

Present only when the request included a delivery configuration.

download_url
string<uri> | null

API path from which the completed result can be downloaded.

Present only while a successfully completed result remains available.

error
null | object

Failure details. Present only when status is failed.

expires_at
string<date-time> | null

Time after which the completed result can no longer be downloaded.

size_bytes
integer<int64> | null

Size of the completed result in bytes.

Required range: x >= 0