Capture API

POST/v1/capture

Create a capture

Render and return the result immediately.

Request body

Provide exactly one of url, html, or markdown.

{
  "url": "https://example.com",
  "format": "png",
  "full_page": true
}

See Options reference for all fields.

Response types

JSON (default)

{
  "request_id": "...",
  "result": {
    "format": "png",
    "meta": { "width": 1440, "height": 3200 },
    "storage": { "stored": true, "url": "https://..." },
    "cache": { "hit": false }
  }
}

Binary

Returns raw bytes with the correct Content-Type.

Empty

Returns HTTP 204 with no body.

Status codes

200 success (json or binary)
204 success (empty)
400 invalid request
401 invalid access key
429 rate limit
500 internal error

Errors

Common errors: invalid_request, invalid_url, ssrf_blocked, timeout_error.