Skip to main content
get/v3/search
Request example
Response
get/v3/search

Authorization

Authorizationstringheaderrequired#
Get your API key at context7.com/dashboard. Treat your API key like a password and store it securely. Every key can read the management API (/v2/teamspaces/*), except personal data: member and invitation emails, library requesters, visitor questions, Docs7 reader searches, conversations, feedback and feature requests, and the GitHub account behind a build. To read those or make changes there, the key must be created with Write access ticked; other keys get 403 write_access_required.

Query parameters

querystringrequired#
The question or task to search documentation for. Long questions and pasted error output are accepted.

Length: 1–2000

typeenum<string>#
Response format type

Default: "txt"

Options:jsontxt
librarystring[]#
Optional library hints. Repeat for up to four values; each may be a fuzzy product name such as next.js or an exact Context7 ID such as /vercel/next.js. An exact ID that is not indexed, or has no documentation to serve, is searched by its product name instead. A version-like tag (/vercel/next.js@15) is resolved like the version parameter for that library, including when the ID is searched by its product name.

Items: max 4

versionstring#
Optional version preference. latest (any case) is the same as no version. Without a library value, the version applies when the question names one product; when it names several, the version is ignored. With one library, verified matching documentation is preferred; if unavailable, the smallest indexed stable release above the request in its major (v2.3.1 for 2.0.0; all of 0.x is one major), for an old major newer than all its indexed releases that major's newest one, or else current documentation is returned, and the response says so (X-Context7-Search-Status: partial with reason versionUnverified, X-Context7-Search-Version, and the version field of JSON responses). A prerelease tag serves only a request for that prerelease. With multiple libraries, the version is a preference and each returned library reports what it served. A version-like tag on a library value (/vercel/next.js@15) is the same request scoped to that library. A version that is not indexed for a public GitHub library is queued for indexing in the background, so a later request for it can be answered.

Pattern: ^([Ll][Aa][Tt][Ee][Ss][Tt]|[Vv]?[0-9]+([._][0-9]+){0,2}([-+][a-zA-Z0-9.-]+)?)$

languagestring#
Optional programming-language preference used for library selection, retrieval, and reranking. This is a soft preference and does not exclude language-neutral documentation.

Length: 1–40

contextenum<string>#
Optional. broad appends more sections of the best-matching documentation pages, up to about 3,500 extra tokens, after the ranked results. How-to, migration, troubleshooting, and overview questions get these sections without it; use it when a question needs several facts but reads as a single-fact question.
Options:broad

Responses

Bounded documentation evidence from the selected libraries
codeSnippetsobject[]required#
Relevant code snippets
infoSnippetsobject[]required#
Relevant documentation snippets
rulesobject#
Optional library-specific rules and guidelines
versionobject#
Present only when the library ID names a version that is not indexed. Says what was served instead, with the fields of each entry of the Search API's version.libraries. The text response states the same in a leading version note when the status is unverified.
Example: