Skip to main content
GET
Get a library

Authorizations

Authorization
string
header
required

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.

Path Parameters

teamspaceId
string<uuid>
required

Teamspace id (uuid).

owner
string
required

First segment of the library id /owner/repo (for example vercel in /vercel/next.js, websites in /websites/docs_example_com). Case-insensitive.

repo
string
required

Second segment of the library id /owner/repo. Case-insensitive.

Response

The library

A library of the teamspace: one of its private sources or a library it has claimed.

id
string
required

Library id, /owner/repo.

Example:

"/acme/internal-docs"

private
boolean
required

One of the teamspace's private sources.

owned
boolean
required

Claimed by the teamspace. Owner operations (config, versions delete, analytics) need it.

state
enum<string>
required

Parse state. processing: a parse runs. finalizing: the new data is ready and cleanup still runs. complete: done. error: the last parse failed, or a first parse ended without a library.

Available options:
processing,
finalizing,
complete,
error
versions
object[]
required
task
object | null
required

The active parse task, or null when none runs.

title
string
description
string
type
enum<string>

Source type.

Available options:
repo,
llmstxt,
website,
openapi,
pdf,
docx,
file,
confluence,
notion
sourceUrl
string

Where the library is read from (repository, website, llms.txt or OpenAPI URL).

branch
string

Default branch (repositories).

lastUpdateDate
string<date-time>

Last successful update.

totalTokens
integer
totalSnippets
integer
totalPages
integer
benchmarkScore
number

Context7's benchmark score of the library's docs, 0 to 100.

lastRunDate
string<date-time>

When the last parse ran, successful or not.

issues
object

Problems the last parse found.

config
object

The owner settings (what the PATCH changes), for a library the teamspace owns.