Skip to main content
POST
/
api
/
v1
/
web-extract
Web extract
curl --request POST \
  --url https://gateway.sanfoundation.com/api/v1/web-extract \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com/article",
  "objective": "summarize the key findings"
}
'
{
  "url": "<string>",
  "title": "<string>",
  "publish_date": "2023-11-07T05:31:56Z",
  "excerpts": [
    "<string>"
  ],
  "full_content": "<string>"
}

Authorizations

​
x-api-key
string
header
required

SAN-issued API key (sk_…) issued from the SAN Agents Dashboard (Settings → API Keys). Used by every /api/v1/* endpoint; usage is billed in credits against the owning account's active Stripe subscription.

Body

application/json
​
url
string<uri>
required

Absolute http(s) URL to fetch and extract.

​
objective
string

Optional natural-language objective used to bias the excerpt selection toward the caller's interest.

Maximum string length: 1000

Response

OK — readable content extracted from the URL.

​
url
string<uri>
required
​
title
string
required
​
publish_date
string<date-time> | null
required
​
excerpts
string[]
required
​
full_content
string

Full readable text of the page.