> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sanfoundation.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Web search

> Searches the open web for a topic and returns up to 10 ranked results with source `url`, page `title`, `publish_date` (when known), and the most relevant excerpts.



## OpenAPI

````yaml https://playground.sanfoundation.com/openapi.yaml post /api/v1/web-search
openapi: 3.1.0
info:
  title: SAN Foundation Gateway API
  version: 1.0.0
  description: |
    Public API for the SAN Foundation gateway. The same data is exposed
    through two interchangeable surfaces: `/api/v1/*` is authenticated
    with an `x-api-key` (`sk_…`) and billed in credits (per-call cost
    in `x-credits`); `/x402/v1/*` is paid per call in USDC over the
    [x402 protocol](https://x402.org) and requires no API key (per-call
    cost in `x-price-usd`).
servers:
  - url: https://gateway.sanfoundation.com
    description: Production
security: []
tags:
  - name: API Key
    description: |
      Operations under `/api/v1/*`. Authenticate with a SAN API key
      (`x-api-key` header) and pay with prepaid credits — see each
      operation's `x-credits` for the per-call cost.
  - name: x402
    description: |
      Operations under `/x402/v1/*`. Pay per call in USDC over the
      [x402 protocol](https://x402.org) — see each operation's
      `x-price-usd` for the per-call cost. No API key required.
  - name: Registration
    description: |
      Public, unauthenticated self-onboarding for agents. One call mints an
      API key and grants the signup credit so an agent can immediately use
      `/api/v1/*`. Rate limited per client IP.
paths:
  /api/v1/web-search:
    post:
      tags:
        - API Key
      summary: Web search
      description: >-
        Searches the open web for a topic and returns up to 10 ranked results
        with source `url`, page `title`, `publish_date` (when known), and the
        most relevant excerpts.
      operationId: webSearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebSearchRequest'
            examples:
              basic:
                value:
                  search: latest LNG export cuts in Qatar
      responses:
        '200':
          $ref: '#/components/responses/WebSearchOk'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '503':
          $ref: '#/components/responses/WebResearchUnavailable'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    WebSearchRequest:
      type: object
      required:
        - search
      properties:
        search:
          type: string
          minLength: 1
          maxLength: 1000
          description: Free-text search query.
    WebSearchResponse:
      type: object
      required:
        - results
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/WebSearchResult'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        ref:
          type: string
          description: Echoed back when an agent ref could not be resolved.
        eventId:
          type: string
          description: Echoed back when an event id could not be resolved.
        min:
          type: integer
          description: Echoed back on a `limit out of range` error.
        max:
          type: integer
          description: Echoed back on a `limit out of range` error.
    WebSearchResult:
      type: object
      required:
        - url
        - title
        - publish_date
        - excerpts
      properties:
        url:
          type: string
          format: uri
        title:
          type: string
        publish_date:
          type:
            - string
            - 'null'
          format: date-time
          description: Publication date when the source exposes one, otherwise null.
        excerpts:
          type: array
          items:
            type: string
          description: Excerpts the ranker scored as most relevant for the query.
  responses:
    WebSearchOk:
      description: OK — ranked web search results.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WebSearchResponse'
    BadRequest:
      description: |
        Malformed input — typically a `limit` outside the documented
        bounds for the route, an unknown agent `ref`, or a malformed
        `evt_…` id. On `/x402/v1/*`, these guards run **before** payment,
        so the client is not charged.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            limitOutOfRange:
              value:
                error: limit out of range
                min: 1
                max: 30
            agentNotFound:
              value:
                error: agent not found
                ref: unknown-handle
            badEventId:
              value:
                error: invalid event id shape
                eventId: not-an-evt
    Unauthorized:
      description: >-
        Missing, invalid, or revoked API key (emitted by key-authenticated
        `/api/*` endpoints).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              value:
                error: Missing or invalid x-api-key header
            invalid:
              value:
                error: Invalid API key
    Forbidden:
      description: |
        The API key is valid but its owning account has no active Stripe
        subscription (status is not `active` or `trialing`). Only
        emitted by `/api/v1/*`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              Active subscription required. Please set up billing at your
              dashboard.
    WebResearchUnavailable:
      description: |
        The web research provider is not configured for this server.
        Operationally this means the server is missing the credentials
        needed to call the underlying research backend; it is not a
        client error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Web research provider is not configured
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: |
        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.

````