Full-text search across all documentation pages in a project.
Headers
X-Audience-TokenPath Parameters
projectId3f2b8c1e-6a4d-4e9b-9c7a-1d2e3f4a5b6c). Anything else gets 400 validation_error before any search runs.Query Parameters
qlimit20offset0categoryguide, api, sdk, changelog or other.versionpreview--, up to 255 characters of letters, digits, ., _, / and -. When <branch>--<subdomain> fits in 63 characters this is the branch name, lower-cased with other characters turned into -; for longer branches use the shortened label from the preview URL (it ends in a short code, e.g. …-page-m-e202f7). It only ever selects a preview of the project in the path. When that preview has no index, the result is empty — it never falls back to production. Preview searches aren't counted in search analytics.Response
Not wrapped in data. Search failures return empty results rather than an error, so a site's search box degrades quietly.
queryhitsidslugtitlesectioncontentcategoryguide, api, sdk, changelog or other.methodpathnavSectionCLI or API). The site's search box
groups results by it. Absent on v1 sites and on indexes built before
the field existed._formattedtitle, section and content with matches wrapped in <mark>; content is cropped around the match.groupedcategory.processingTimeMsestimatedTotalHitsErrors
| Status | Code | When |
|---|---|---|
| 400 | validation_error | projectId isn't a UUID, or a query parameter is invalid (for example preview with other characters) |
| 403 | FORBIDDEN | The site is private (password, invite-only or SSO) and the call didn't come through the doc site — message Search from the docs site |
Search Syntax
The search query supports:
"api key" — matches exact phrase-deprecated — exclude results with this termauth finds authenticationIndex diagnostics
/v1/projects/{projectId}/search/debugReports the state of this project's search index — document count, settings, and the most recent index updates. Useful when a build reports success but search returns nothing.
This endpoint requires a session JWT and membership of the organization that
owns {projectId}. It previously required no credentials; it now reports only on your project's index. If you called it
anonymously, add an Authorization header — see
Authentication.
GET /v1/projects/{projectId}/search and GET /v1/projects/{projectId}/search/popular
remain public, because the rendered documentation site calls them from a visitor's
browser. On a private site both answer only through the doc site.
Popular queries
/v1/projects/{projectId}/search/popularWhat readers search for most, and the searches that found nothing. Public; no credential needed.
| Query parameter | Default | Range | Description |
|---|---|---|---|
days | 30 | 1–365 | How far back to look |
limit | 8 | 1–20 | How many top queries and zero-result terms to return |
Each entry's count arrives as a numeric string. A direct call on a private site gets 403 FORBIDDEN.
Search analytics
/v1/projects/{projectId}/search/analyticsThe same report for the dashboard, with up to 20 entries per list and no data wrapper. Needs a session JWT and membership of the project's organization; ?days= sets the window (default 30).