Skip to main content
POST
/
v1
/
tools
/
web-read
curl -X POST https://win.oneshotagent.com/v1/tools/web-read \
  -H "Content-Type: application/json" \
  -H "X-Payment-Proof: <your_x402_signature>" \
  -d '{
    "url": "https://example.com"
  }'

{
  "request_id": "uuid",
  "status": "processing",
  "tool": "web_read",
  "message": "Web page read initiated. Results available at /v1/requests/{id}."
}

​
Authentication

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

​
Request Body

​
url
string
required
URL of the web page to read

​
Response (202 Accepted)

​
request_id
string
Job ID for tracking progress
​
status
string
Job status: processing
​
tool
string
Always web_read

​
Job Result (poll /v1/requests/:id)

​
url
string
The URL that was read
​
markdown
string
Page content extracted as markdown (max 50KB)
​
screenshot_url
string
Screenshot of the page
​
metadata
object
Page metadata: title, description, statusCode
​
truncated
boolean
Whether the markdown was truncated to 50KB
curl -X POST https://win.oneshotagent.com/v1/tools/web-read \
  -H "Content-Type: application/json" \
  -H "X-Payment-Proof: <your_x402_signature>" \
  -d '{
    "url": "https://example.com"
  }'

{
  "request_id": "uuid",
  "status": "processing",
  "tool": "web_read",
  "message": "Web page read initiated. Results available at /v1/requests/{id}."
}
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
  • Job results are available via polling at /v1/requests/{request_id}