Skip to main content
POST
/
api
/
v1
/
web-search
Web search
curl --request POST \
  --url https://gateway.sanfoundation.com/api/v1/web-search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "search": "latest LNG export cuts in Qatar"
}
'
{
  "results": [
    {
      "url": "<string>",
      "title": "<string>",
      "publish_date": "2023-11-07T05:31:56Z",
      "excerpts": [
        "<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
​
search
string
required

Free-text search query.

Required string length: 1 - 1000

Response

OK — ranked web search results.

​
results
object[]
required