Skip to main content
POST
Add a Confluence space

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.

Body

application/json
cloudId
string
required

The Confluence cloud instance ID

siteUrl
string
required

The Confluence site URL

spaceKey
string
required

The Confluence space key

spaceName
string
required

The Confluence space name

title
string
required

Title for the library

description
string
required

Description of the library

pageIds
string[]

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

projectId
string

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

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