---
title: "Search the web"
method: POST
path: "/api/web/search"
---

# Search the web

`POST /api/web/search`

Performs a web search and returns search results with titles, URLs, and descriptions

## Request body

- WebSearchParams
  - `query` string, required
  - `page` integer
  - `maxAgeSeconds` integer
  - `location` WebSearchLocation
    - `country` string, required
    - `state` string
    - `city` string
  - `filters` WebSearchFilters
    - `exactPhrase` boolean
    - `semanticPhrase` boolean
    - `excludeTerms` string[]
    - `boostTerms` string[]
    - `filetype` 'pdf' | 'doc' | 'docx' | 'xls' | 'xlsx' | 'ppt' | 'pptx' | 'html'
    - `site` string
    - `excludeSite` string
    - `intitle` string
    - `inurl` string

## Response `200`

Search completed successfully

- WebSearchResponse
  - `jobId` string, required
  - `status` 'completed' | 'failed' | 'pending' | 'running' | 'stopped', required
  - `error` string, nullable
  - `data` WebSearchResponseData
    - `query` string, required
    - `results` WebSearchResultItem[], required
      - `title` string, required
      - `url` string, required
      - `description` string, required

## Other responses

- `400` — Invalid search parameters
- `500` — Server error

---

[API](https://skmtc.dev/hyperbrowser/apis/hyperbrowser-api.md) · [All operations](https://skmtc.dev/hyperbrowser/apis/hyperbrowser-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperbrowser/hyperbrowser-api/revisions/9d8b355ebbf2/schema)