Get Docs

Retrieve library documentation in various formats

Get Docs

Retrieve documentation for a specific library. You can get code examples or informational documentation in either JSON or text format.

Arguments

libraryId · string · required

The library identifier in the format /owner/repo (e.g., /facebook/react)

options · GetDocsOptions

Show properties

mode · 'code' | 'info'

Type of documentation to retrieve

• code: Code examples and API documentation
• info: Informational documentation and guides

Default: "code"

format · 'json' | 'txt'

Format of the response

• json: Structured JSON with metadata
• txt: Plain text format

Default: "json"

limit · number

Maximum number of snippets to return (1-100)

page · number

Page number for pagination (starts at 1)

topic · string

Filter documentation by topic (e.g., “hooks”, “components”, “api”)

version · string

Specific version to retrieve documentation for (e.g., “18.0.0”)

Response

The response type is automatically inferred based on the format and mode parameters. All response types extend a common base with pagination and token information.

Text Format (format: "txt")

TextDocsResponse · object

Show properties

content · string · required

Plain text documentation content

totalTokens · number · required

Total number of tokens in the content

pagination · Pagination · required

Show properties

page · number · required

Current page number

limit · number · required

Number of items per page

totalPages · number · required

Total number of pages available

hasNext · boolean · required

Whether there is a next page

hasPrev · boolean · required

Whether there is a previous page

JSON Format with Code Type (format: "json", mode: "code")

CodeDocsResponse · object

Show properties

snippets · CodeSnippet[] · required

Array of code snippets

Show CodeSnippet properties

codeTitle · string · required

Title of the code snippet

codeDescription · string · required

Description of what the code does

codeLanguage · string · required

Programming language (e.g., “typescript”, “javascript”)

codeTokens · number · required

Number of tokens in the code

codeId · string · required

Unique identifier for the code snippet

pageTitle · string · required

Title of the source page

codeList · CodeExample[] · required

List of code examples

Show CodeExample properties

language · string · required

Programming language

code · string · required

The actual code

totalTokens · number · required

Total number of tokens across all snippets

pagination · Pagination · required

Show properties

page · number · required

Current page number

limit · number · required

Number of items per page

totalPages · number · required

Total number of pages available

hasNext · boolean · required

Whether there is a next page

hasPrev · boolean · required

Whether there is a previous page

metadata · APIResponseMetadata · required

Show properties

authentication · 'none' | 'personal' | 'team' · required

Authentication level used

JSON Format with Info Type (format: "json", mode: "info")

InfoDocsResponse · object

Show properties

snippets · InfoSnippet[] · required

Array of informational snippets

Show InfoSnippet properties

pageId · string

Page identifier

breadcrumb · string

Breadcrumb path to the content

content · string · required

The documentation content

contentTokens · number · required

Number of tokens in the content

totalTokens · number · required

Total number of tokens

pagination · Pagination · required

Pagination information (same structure as code response)

metadata · APIResponseMetadata · required

Response metadata (same structure as code response)

Examples

Code Docs (JSON - Default)

import { Context7 } from "@upstash/context7-sdk";

const client = new Context7();

// JSON is the default format, no need to specify
const docs = await client.getDocs("/facebook/react", {
  mode: "code",
  limit: 5,
});

console.log(`Retrieved ${docs.snippets.length} code snippets`);

Use Cases

Building a Documentation Chat Bot

import { Context7 } from "@upstash/context7-sdk";

const client = new Context7({
  apiKey: process.env.CONTEXT7_API_KEY!,
});

async function getRelevantDocs(library: string, topic: string) {
  const docs = await client.getDocs(library, {
    mode: "code",
    format: "json",
    topic,
    limit: 5,
  });

  return docs.snippets.map((snippet) => ({
    title: snippet.codeTitle,
    description: snippet.codeDescription,
    code: snippet.codeList[0]?.code,
    language: snippet.codeLanguage,
  }));
}

const reactHooksDocs = await getRelevantDocs("/facebook/react", "hooks");

Fetching All Documentation Pages

import { Context7 } from "@upstash/context7-sdk";

const client = new Context7({
  apiKey: process.env.CONTEXT7_API_KEY!,
});

async function getAllDocs(library: string) {
  const allSnippets = [];
  let page = 1;
  let hasMore = true;

  while (hasMore) {
    const response = await client.getDocs(library, {
      mode: "code",
      format: "json",
      page,
      limit: 100,
    });

    allSnippets.push(...response.snippets);
    hasMore = response.pagination.hasNext;
    page++;
  }

  return allSnippets;
}

const allReactDocs = await getAllDocs("/facebook/react");
console.log(`Total snippets: ${allReactDocs.length}`);

Extracting Code Examples

import { Context7 } from "@upstash/context7-sdk";

const client = new Context7({
  apiKey: process.env.CONTEXT7_API_KEY!,
});

const docs = await client.getDocs("/facebook/react", {
  mode: "code",
  format: "json",
  limit: 20,
});

const tsExamples = docs.snippets
  .filter((snippet) => snippet.codeLanguage === "typescript")
  .map((snippet) => snippet.codeList)
  .flat();

console.log(`Found ${tsExamples.length} TypeScript examples`);