Skip to main content
POST
/
v1
/
document
/
url-screenshot
{
  "input": "https://example.com/document.pdf",
  "url": "https://example.com",
  "width": 1280,
  "format": "png"
}

{
  "id": "job_abc123",
  "status": "pending"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ringbee.dev/llms.txt

Use this file to discover all available pages before exploring further.

{
  "input": "https://example.com/document.pdf",
  "url": "https://example.com",
  "width": 1280,
  "format": "png"
}
ParamTypeDescription
urlstringWeb page URL to capture
widthintegerViewport width in pixels
formatstringOutput image format (e.g., “png”, “jpg”)

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
input
string
required

Input file URL

​
url
string

Web page URL to capture

​
width
integer

Viewport width in pixels

​
format
string

Output image format (e.g., "png", "jpg")

​
webhook_url
string

URL to receive job completion notification

Response

Job accepted

​
id
string
Example:

"job_abc123"

​
status
enum<string>
Available options:
pending,
processing,
completed,
failed,
cancelled
Example:

"pending"