Refresh a library

Trigger a refresh of an existing library to fetch the latest documentation. Library owners have dedicated refresh limits.

1 min read

post/v1/refresh

Request example

curl --request POST \
  --url https://context7.com/api/v1/refresh \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "libraryName": "<string>",
  "branch": "<string>",
  "gitToken": "<string>"
}'

Response

{
  "message": "Refresh started successfully"
}

post/v1/refresh

Authorization

Authorizationstringheaderrequired#

Get your API key at context7.com/dashboard. Treat your API key like a password and store it securely.

Body

application/json

libraryNamestringrequired#

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

branchstring#

Optional branch name to refresh

gitTokenstring#

Optional Git access token for refreshing private repositories. If not provided, the stored OAuth token will be used.

Responses

application/json

Refresh started successfully

messagestringrequired#

Get documentation context Get teamspace policies