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

# Web search

> Search the web through the Dench gateway.



## OpenAPI

````yaml /api-reference/openapi.json post /search
openapi: 3.1.0
info:
  title: Dench API
  version: 1.0.0
  description: >-
    Versioned Dench workspace API. The operation registry is shared with the
    Dench CLI parity layer, so every CLI command maps to an endpoint here.
servers:
  - url: https://www.dench.com/api/v1
security: []
tags:
  - name: agent-config
    description: Agent Config operations.
  - name: approvals
    description: Approvals operations.
  - name: apps
    description: Apps operations.
  - name: auth
    description: Auth operations.
  - name: billing
    description: Billing operations.
  - name: browser
    description: Browser operations.
  - name: chat
    description: Chat operations.
  - name: crm
    description: Crm operations.
  - name: email
    description: Email operations.
  - name: files
    description: Files operations.
  - name: gateway
    description: Gateway operations.
  - name: local
    description: Local operations.
  - name: memory
    description: Memory operations.
  - name: meta
    description: Meta operations.
  - name: routines
    description: Routines operations.
  - name: workspace
    description: Workspace operations.
paths:
  /search:
    post:
      tags:
        - gateway
      summary: Web search
      description: Search the web through the Dench gateway.
      operationId: search_web
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: Search query.
                type:
                  type: string
                  enum:
                    - auto
                    - neural
                    - fast
                    - deep
                    - deep-reasoning
                    - instant
                numResults:
                  type: integer
                  minimum: 1
                  maximum: 100
                category:
                  type: string
                  enum:
                    - company
                    - research paper
                    - news
                    - personal site
                    - financial report
                    - people
                includeDomains:
                  type: array
                  items:
                    type: string
                excludeDomains:
                  type: array
                  items:
                    type: string
                startPublishedDate:
                  type: string
                endPublishedDate:
                  type: string
                includeText:
                  type: array
                  items:
                    type: string
                excludeText:
                  type: array
                  items:
                    type: string
                userLocation:
                  type: string
                moderation:
                  type: boolean
              required:
                - query
            example:
              query: latest AI CRM workflows
              numResults: 5
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        title:
                          type: string
                        publishedDate:
                          type: string
                        author:
                          type: string
                        score:
                          type: number
                        text:
                          type: string
                        summary:
                          type: string
                        highlights:
                          type: array
                          items:
                            type: string
                        image:
                          type: string
                        favicon:
                          type: string
                        id:
                          type: string
                      required:
                        - url
                      additionalProperties: {}
                      description: An Exa search/contents result (provider passthrough).
                  resolvedSearchType:
                    type: string
                  autopromptString:
                    type: string
                  requestId:
                    type: string
                  costDollars:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                required:
                  - results
                additionalProperties: {}
                description: Exa response passed through unchanged.
              example:
                results:
                  - url: https://example.com/ai-crm
                    title: AI CRM workflows in 2026
                    publishedDate: '2026-05-01T00:00:00.000Z'
                    author: Jane Doe
                    id: https://example.com/ai-crm
                resolvedSearchType: neural
                requestId: req_abc123
                costDollars:
                  total: 0.005
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - DenchApiKey: []
        - AgentSession: []
components:
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Operation or resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
            details: {}
  securitySchemes:
    DenchApiKey:
      type: http
      scheme: bearer
      bearerFormat: DENCH_API_KEY
      description: >-
        Workspace-scoped Dench API key from workspace settings. This is the same
        key used by DENCH_API_KEY in sandboxes.
    AgentSession:
      type: http
      scheme: bearer
      bearerFormat: dch_agent_*
      description: >-
        Agent session token created by `dench signin`. Gateway-backed routes
        exchange this token for the workspace gateway key.

````