Skip to main contentDocumentation index
Fetch the complete documentation index at: /docs/llms.txt
Ask it with GET /docs/ask?q=<keywords or question>. Short keywords rank best.
Use these to discover all available pages before exploring further.
Feature requests: /docs/resources/feature-requests.md lists what users asked for and how to vote for a request or add one.
Page rating: `GET /docs/feedback?path=<this page's path>&helpful=true` (or `false`) records whether this page helped. An optional `comment` (URL-encoded, at most 500 characters) says what was missing or wrong. It is anonymous and needs no key. Comments hold no code, secrets or personal data.
Search across available libraries. Returns an array of matching libraries with metadata useful for selection.
The user’s question or task (used for relevance ranking)
The library name to search for
Returns Library[] - an array of library objects.
Unique identifier for the library (e.g., /facebook/react)
Display name of the library
Brief description of the library
Total number of documentation snippets available
Trust score of the library
Benchmark score indicating documentation quality
Available versions
const libraries = await client.searchLibrary("state management", "redux");const trusted = libraries.sort((a, b) => b.trustScore - a.trustScore);console.log("Most trusted:", trusted[0].name);const libraries = await client.searchLibrary("I want to use lodash", "lodash");const library = libraries[0];if (library.versions) { console.log(`Available versions: ${library.versions.join(", ")}`);}import { Context7 } from "@upstash/context7-sdk";const client = new Context7();const libraries = await client.searchLibrary( "I want to build a React app", "react");const library = libraries[0];console.log(`Using: ${library.name} (${library.id})`);const context = await client.getContext( "How do I create a component?", library.id);console.log(context);Was this page helpful?
import { Context7 } from "@upstash/context7-sdk";const client = new Context7();const libraries = await client.searchLibrary( "I need to build a UI", "react");console.log(`Found ${libraries.length} libraries`);libraries.forEach((library) => { console.log(`${library.name}: ${library.description}`);});import { Context7 } from "@upstash/context7-sdk";const client = new Context7();const libraries = await client.searchLibrary( "I want to build a web app", "next");const sorted = libraries.sort((a, b) => b.benchmarkScore - a.benchmarkScore);const best = sorted[0];console.log(`Best match: ${best.name} (score: ${best.benchmarkScore})`);console.log(`Available snippets: ${best.totalSnippets}`);import { Context7, Context7Error } from "@upstash/context7-sdk";const client = new Context7();try { const libraries = await client.searchLibrary("query", "express"); if (libraries.length === 0) { console.log("No libraries found"); } else { console.log(`Found ${libraries.length} libraries`); }} catch (error) { if (error instanceof Context7Error) { console.error("API Error:", error.message); } else { throw error; }}