Skip to main content
POST
Refresh 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.

Body

application/json
branch
string

A branch version to refresh in place of the default branch.

gitToken
string

Token for a private repository. Default: the account connected in the dashboard.

pageIds
string[]

Confluence and Notion: the pages to index.

Maximum array length: 5000

Response

The refresh started

message
string
required