Augment

/api/v1/augment/scrape

Scrape a web page and return its content as markdown. Supports most public web pages; some sites (e.g. X/Twitter, Reddit) that block automated access are rejected immediately.

Authentication: This endpoint accepts either a Bearer API key or a SIGN-IN-WITH-X header for x402 wallet-based authentication. The legacy X-Sign-In-With-X header is also accepted during migration. When using x402, a 402 Payment Required response indicates insufficient balance and includes top-up instructions.

post/api/v1/augment/scrape

Request

  • Base URL: https://api.venice.ai
  • URL: https://api.venice.ai/api/v1/augment/scrape
  • Auth: one of:
    • HTTP bearer
    • API key in header SIGN-IN-WITH-X

Request body

urlstring uri required

The URL to scrape

Example request

{
  "url": "https://example.com"
}

Response

Successfully scraped the URL

urlstring required

The URL that was scraped

contentstring required

The scraped content in markdown format

format'markdown' required

The format of the scraped content

Example response

{
  "url": "https://example.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.