Skip to main content
Use the endpoint pages in this tab for request fields, query parameters, response schemas, and required permissions. They are generated from the same contract used by the API.
The OpenAPI specification contains complete paths, including /api/v1; do not append the prefix twice.

​
Authentication

Use an API key in x-api-key or Authorization: Bearer. OAuth access tokens use bearer authentication and currently grant MCP and search permissions only. See Authentication and scopes.

​
Generated endpoint groups

  • Search the live web at /api/v1/search, optionally starting a crawl of result pages.
  • Manage and search indexed content under /api/v1/index.
  • Create crawl, deep-crawl, and extraction runs.
  • List, inspect, cancel, retry, and delete runs.
  • List results and retrieve content or screenshots.
Source and collection HTTP operations are described in the Sources, GitHub sources, and Collections guides. The corresponding SDK operations are included in this generated specification.

​
Response handling

Search returns results synchronously. Run creation returns a run to poll. Run deletion returns 202 and completes asynchronously. Content endpoints return text or image bytes rather than a JSON envelope. Failures use a JSON object with error and optional details. Treat 403 as an authorization or plan-limit problem, not a transient failure to retry indefinitely.