Add a Confluence space

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.

1 min read

post/v2/add/confluence

Request example

curl --request POST \
  --url https://context7.com/api/v2/add/confluence \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cloudId": "<string>",
  "siteUrl": "<string>",
  "spaceKey": "<string>",
  "spaceName": "<string>",
  "pageIds": [
    "<string>"
  ],
  "title": "<string>",
  "description": "<string>",
  "projectId": "<string>"
}'

Response

{
  "libraryName": "/owner/repo",
  "message": "Repository submitted successfully"
}

post/v2/add/confluence

Authorization

Authorizationstringheaderrequired#

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

Body

application/json

cloudIdstringrequired#

The Confluence cloud instance ID

siteUrlstringrequired#

The Confluence site URL

spaceKeystringrequired#

The Confluence space key

spaceNamestringrequired#

The Confluence space name

pageIdsstring[]#

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

titlestringrequired#

Title for the library

descriptionstringrequired#

Description of the library

projectIdstring#

The team project ID to associate this Confluence space with

Responses

application/json

Library submitted successfully for processing

libraryNamestringrequired#

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). See Library ID format.

messagestringrequired#

Human-readable success message

Add a website Add Notion pages