Add Library

Add a Confluence space

Changed on

Submit a Confluence space for documentation processing. Requires a connected Confluence account and a team project. You can optionally specify specific page IDs to index only a subset of the space.

post/v2/add/confluence

Request

  • Base URL
    https://context7.com/api
  • URL
    https://context7.com/api/v2/add/confluence
  • Auth
    HTTP bearer

Request body

cloudIdstring required

The Confluence cloud instance ID

siteUrlstring required

The Confluence site URL

spaceKeystring required

The Confluence space key

spaceNamestring required

The Confluence space name

pageIdsstring[]

Optional list of specific page IDs to index. If omitted, the entire space is indexed.

titlestring required

Title for the library

descriptionstring required

Description of the library

projectIdstring

Optional. Requests with an API key or token use its teamspace; a different value returns 403 teamspace_mismatch.

Response

Library submitted successfully for processing

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

versionstring

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

messagestring required

Human-readable success message

Changes