Documentation search

Search a selected documentation version and router

Searches the public documentation index with an explicit version and router scope. This is a read-only search operation; the request body selects the search scope and does not create or change data.

post/api/search

Request

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

Request body

querystring required

Documentation topic to search for; whitespace-only values are rejected, and values longer than 10,000 characters are truncated.

version'13' | '14' | '15' | 'stable' required

Documentation version identifier. Use one of the currently served versions in this list.

routerType'app' | 'pages' | 'both' required

Which Next.js router to include in the results.

Response

Matching documentation passages.

nbHitsinteger required
querystring required
provider'upstash' required

Changes

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