Get documentation context

Retrieve documentation snippets for a library ranked by relevance to your query

1 min read

gethttps://your-instance.example.com/api/v2/context

Request example

curl --request GET \
  --url https://your-instance.example.com/api/v2/context?libraryId=%2Fvercel%2Fnext.js&query=How%20do%20I%20use%20the%20app%20router%3F

Response

### useRouter()

Source: https://github.com/vercel/next.js/...

The `useRouter` hook allows you to programmatically change routes inside Client Components.

--------------------------------

### app/layout.tsx

```tsx
export default function Layout({ children }) {
  return <html><body>{children}</body></html>
}
```

gethttps://your-instance.example.com/api/v2/context

Query parameters

libraryIdstringrequired#

Library ID returned by GET /v2/libs/search (e.g., /your-org/your-repo)

Length: 1–500

querystringrequired#

Natural language question or topic to retrieve context for

Length: 1–500

Responses

text/plain

Relevant documentation snippets as plain text

Search for libraries Parse a Git repository