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

# Web Search



## OpenAPI

````yaml openapi.json GET /gateway/v1/search/web
openapi: 3.1.0
info:
  title: Hermod
  version: 0.0.1
servers:
  - url: https://api.asksurf.ai
security: []
paths:
  /gateway/v1/search/web:
    get:
      tags:
        - Search
      summary: Web Search
      description: |-
        Searches web pages, articles, and content by keyword.

        **Filters:** domain via `site` (e.g. `coindesk.com`).

        **Included fields:** titles, URLs, content snippets.
      operationId: search-web
      parameters:
        - description: Search query like `bitcoin price prediction 2026`
          explode: false
          in: query
          name: q
          required: true
          schema:
            description: Search query like `bitcoin price prediction 2026`
            examples:
              - bitcoin price prediction 2026
            type: string
        - description: Results per page
          explode: false
          in: query
          name: limit
          schema:
            default: 20
            description: Results per page
            examples:
              - 20
            format: int64
            maximum: 100
            minimum: 1
            type: integer
        - description: Pagination offset
          explode: false
          in: query
          name: offset
          schema:
            default: 0
            description: Pagination offset
            examples:
              - 0
            format: int64
            minimum: 0
            type: integer
        - description: >-
            Comma-separated domain filter like `coindesk.com` or
            `cointelegraph.com`
          explode: false
          in: query
          name: site
          schema:
            description: >-
              Comma-separated domain filter like `coindesk.com` or
              `cointelegraph.com`
            examples:
              - coindesk.com,cointelegraph.com
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseWebSearchResultItem'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataAPIError'
          description: Error
      security:
        - AccessToken: []
components:
  schemas:
    DataResponseWebSearchResultItem:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/DataResponseWebSearchResultItem.json
          format: uri
          readOnly: true
          type: string
        data:
          items:
            $ref: '#/components/schemas/WebSearchResultItem'
          type:
            - array
            - 'null'
        meta:
          $ref: '#/components/schemas/OffsetMeta'
      required:
        - data
        - meta
      type: object
    DataAPIError:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/DataAPIError.json
          format: uri
          readOnly: true
          type: string
        error:
          $ref: '#/components/schemas/DataAPIErrorDetail'
      required:
        - error
      type: object
    WebSearchResultItem:
      additionalProperties: false
      properties:
        content:
          description: Relevant content snippet from the page
          type: string
        description:
          description: Short description or meta description of the page
          type: string
        title:
          description: Page title from the search result
          type: string
        url:
          description: Full URL of the search result page
          type: string
      required:
        - title
        - url
        - description
        - content
      type: object
    OffsetMeta:
      additionalProperties: false
      properties:
        cached:
          description: Whether this response was served from cache
          type: boolean
        credits_used:
          description: Credits deducted for this request
          format: int64
          type: integer
        limit:
          description: Maximum number of items returned in this response
          format: int64
          type: integer
        offset:
          description: Number of items skipped (pagination offset)
          format: int64
          type: integer
        total:
          description: >-
            Total number of matching items (before pagination). Omitted when
            total is unknown.
          format: int64
          type: integer
      required:
        - limit
        - offset
        - credits_used
        - cached
      type: object
    DataAPIErrorDetail:
      additionalProperties: false
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object

````