API reference

Endpoint reference

A resource-oriented HTTP contract for bounded asynchronous screenshot work.

HTTPS API api-screenshot.com/v1 Bearer auth · JSON requests · private artifacts

Private development preview The contract is documented for integration planning. Production API routes currently return HTTP 503 and no live keys are being issued. OpenAPI 3.1 →

Base URL

HTTPS and bearer authentication

All authenticated endpoints require Authorization: Bearer <API key>. API keys in query strings are not supported because URLs can leak into logs, analytics, browser history, and referrer headers.

Production preview base text

https://api-screenshot.com/v1

Resources

Endpoints

Method	Path	Purpose	Success
POST	/v1/screenshots	Create a bounded screenshot job	202 or replayed 200
GET	/v1/screenshots/{screenshot_id}	Read job state and artifact metadata	200
DELETE	/v1/screenshots/{screenshot_id}	Cancel work or request artifact deletion	202
GET	/v1/usage	Read credit and concurrency usage	200
GET	/v1/health	Inspect control-plane schema readiness	200 or 503

Create

POST /v1/screenshots

Accepts application/json and requires Idempotency-Key. Unknown fields are rejected so a misspelled option cannot silently produce the wrong screenshot.

Header	Required	Meaning
Authorization	Yes	Bearer Screenshot API key
Content-Type	Yes	application/json
Idempotency-Key	Yes	8–128 visible ASCII characters

Resource

GET and DELETE /v1/screenshots/{id}

GET returns only jobs owned by the authenticated account. DELETE requests cancellation for active jobs or durable artifact deletion for terminal jobs.

Non-terminal: queued, claimed, rendering, uploading, cancel_requested.
Successful terminal: succeeded.
Other terminal: failed, canceled, deleted.
Cleanup transition: deleting.

Metering

GET /v1/usage

Returns credits reserved, consumed, released, and remaining together with the current active-job count, concurrency limit, and billing-period boundaries.