Skip to main content
PATCH
Update library settings

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.

Body

application/json

Owner settings. Send only the fields to change. A changed title or description of a public library is reviewed before it is saved. Rules are checked for unsafe content.

projectTitle
string
Maximum string length: 100
description
string
Maximum string length: 500
baseUrl
string

Website base URL (http or https).

Maximum string length: 100
webUrl
string

Link shown on the library page (http or https).

Maximum string length: 500
branch
string

Branch to parse (repositories).

Maximum string length: 100
folders
string[]

Only parse these folders.

Maximum array length: 50
Maximum string length: 255
excludeFolders
string[]
Maximum array length: 50
Maximum string length: 255
excludeFiles
string[]
Maximum array length: 100
Maximum string length: 255
includeExtensions
string[]

Extra file extensions parsed as documentation (repositories), such as ".fizz". Source code extensions are ignored.

Maximum array length: 10
Pattern: ^\.[a-z0-9]{1,16}$
rules
string[]

Rules shown to agents with the documentation.

Maximum array length: 50
Maximum string length: 255
disallow
boolean

Stop indexing the library.

useQueryParams
boolean

Keep query parameters when crawling (websites).

excludeUrls
string[]

URLs not to crawl (websites).

Maximum array length: 100
Maximum string length: 500
skipClaudeVersionExclusion
boolean

Keep pages that look version-specific.

generateDocs
boolean

Generate docs from the source code on each refresh with new commits (private repositories). Each run is billed as parsing.

configSource
enum<string>

Where the parser reads settings from: these settings, or the repository's context7.json (claimed repositories).

Available options:
dashboard,
context7json

Response

The saved settings

config
object
required

The saved owner settings. Unset fields are null.