Screenshot API
FAQ Join preview
Documentation Documentation preview

Screenshot API documentation

Create a bounded screenshot job, observe its lifecycle, and retrieve a private artifact without operating a browser fleet.

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 →
Job-first contract

A small API with durable resources

Screenshot API uses asynchronous job resources. A create request returns quickly with a screenshot ID; clients can poll the resource until the artifact succeeds, fails, or is canceled.

The public documentation is available now so integrations can be designed early. Production API access, account keys, browser rendering, and artifact delivery are not active during the private development preview.

Create POST /v1/screenshots

Validate a public URL and reserve a bounded screenshot job.

Read documentation → Inspect GET /v1/screenshots/{id}

Read job state, render metadata, errors, and artifact delivery details.

Read documentation → Control DELETE /v1/screenshots/{id}

Cancel active work or request deletion of a completed artifact.

Read documentation →
First request

Create a desktop screenshot

Send JSON over HTTPS. Keep the API key in the Authorization header and give every create request an Idempotency-Key so a network retry cannot create duplicate work.

cURL bash 
curl https://api-screenshot.com/v1/screenshots \
  -H "Authorization: Bearer $SCREENSHOT_API_KEY" \
  -H "Idempotency-Key: product-page-2026-07-30" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "preset": "desktop",
    "format": "png"
  }'
Preview availability

The production hostname currently returns HTTP 503 for API routes. The examples describe the feature-gated contract; they are not an availability claim.

Lifecycle

From URL to evidence

  1. 1
    Create Submit a public HTTP or HTTPS URL and bounded render options.
  2. 2
    Observe Poll the screenshot resource while it moves through queued, rendering, and uploading states.
  3. 3
    Consume Use the short-lived private download URL and retain the artifact hash with your agent trace.