Skip to main content
POST

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).

Body

application/json

The library source. File uploads (PDF, DOCX, files, OpenAPI files) are not available here; upload them in the dashboard.

source
enum<string>
required

git is any other Git host (self-hosted).

Available options:
github,
gitlab,
bitbucket,
git
docsRepoUrl
string<uri>
required

Repository URL.

Example:

"https://github.com/acme/docs"

private
boolean

Add as a private source of this teamspace. Needs the owner or admin role and a paid plan. The token comes from gitToken, or from the GitHub, GitLab or Bitbucket account connected in the dashboard. git needs gitToken.

gitToken
string

Personal access token for a private repository.

skipVersionFiltering
boolean

Keep pages that look version-specific (private repositories).

generateDocs
boolean

Generate documentation from the source code (private repositories).

Response

Library submitted successfully for processing

Response after successfully submitting a library

libraryName
string
required

The library identifier assigned — the URL path of the library on context7.com. /owner/repo for GitHub repositories, or /<source>/<id> for other sources (e.g., /vercel/next.js, /websites/uploadcare_com). See Library ID format.

message
string
required

Human-readable success message

version
string

Only for websites: the version the URL was added as, when it is a version of an existing library. Request it as <libraryName>/<version>.