Skip to main content
POST

Authentication

Requires x402 payment proof in the X-Payment-Proof header.

Request Body

string
required
URL of the web page to read

Response (200 OK)

Top-level envelope: success (boolean) and data (object). All fields below are nested under data.
string
Durable job ID for audit and later lookup
string
Job status: completed
string
Always web_read

Result

Also nested under data, alongside the fields above.
string
The URL that was read
string
Page content extracted as markdown (max 50KB)
string
Screenshot of the page
object
Page metadata: title, description, statusCode
boolean
Whether the markdown was truncated to 50KB
See Pricing for web read costs.

Notes

  • Content is extracted with only_main_content mode
  • Markdown is truncated to 50KB if the page is very large
  • Screenshots are generated server-side
  • Results are returned inline; the terminal job remains available at /v1/requests/{request_id}