Documentation search

Search the Next.js documentation

Returns matching documentation pages and snippets. The optional tag scopes results, for example router:app,version:stable. An omitted or unrecognized scope defaults to the stable App Router documentation. Empty queries return an empty array.

get/api/search

Request

  • Base URL
    https://nextjs.org
  • Auth
    none declared

Query parameters

querystring

Documentation topic to search for. Values longer than 10,000 characters are truncated.

tagstring

Optional comma-separated scope, such as router:app,version:stable. Supported router values are app and pages; versions are listed in the POST request schema.

Response

Matching documentation pages and snippets.

breadcrumbsstring[]
contentstring required
idstring required
type'heading' | 'page' | 'text' required
urlstring uri-reference required

Path to the matching documentation page or anchor.

Changes

No recorded changes to this operation across all 1 revision of this API.