Confluence

Confluence Skill

Interact with Confluence Cloud to search pages, read documentation, create or update content, and browse spaces.

Auth Approach

Do NOT check authentication upfront. Just run the command. If it fails with an auth error, see the Self-Healing section for diagnostics.

NEVER print, echo, or log the values of ATLASSIAN_API_TOKEN, ATLASSIAN_EMAIL, or any credentials. Only check whether they are set (e.g., test -n), never display their contents.

Tool Preference

Prefer raw curl for all operations. acli has limited Confluence coverage (page view by ID, space list/view only) — fall back to it only for those read operations if curl fails. All write operations require curl.

Curl base URLs

Two API versions are in use. Use the correct one for each operation:

Curl auth pattern

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/..."

Operations — Read

Search pages (CQL)

curl (v1 API) — acli does not support CQL search.

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/rest/api/search?cql=type%3Dpage+AND+title+~+%22search+term%22"

See cql-recipes.md for common CQL patterns.

Get page by ID

curl (v2 API):

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/pages/{id}?body-format=storage"

acli (fallback):

acli confluence page view --id {id} --body-format storage --json

List pages in space

curl only (v2 API):

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/spaces/{space-id}/pages"

List spaces

curl (v2 API):

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/spaces"

acli (fallback):

acli confluence space list --json

View space

curl (v2 API):

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/spaces/{id}"

acli (fallback):

acli confluence space view --key KEY --json

Get page comments

curl only (v2 API):

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/pages/{id}/footer-comments"

Operations — Write

All write operations require curl. acli does not support Confluence page create, update, or comments.

Create page

curl:

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X POST \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/pages" \
  -d '{
    "spaceId": "123456",
    "status": "current",
    "title": "Page Title",
    "body": {
      "representation": "storage",
      "value": "<p>Page content in storage format.</p>"
    }
  }'

See storage-format.md for how to construct the body value.

Update page

curl — You MUST GET the page first to obtain the current version number, then PUT with version.number + 1.

# Step 1: GET current page (note the version number in the response)
curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/pages/{id}?body-format=storage"

# Step 2: PUT with incremented version
curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X PUT \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/pages/{id}" \
  -d '{
    "id": "{id}",
    "status": "current",
    "title": "Page Title",
    "body": {
      "representation": "storage",
      "value": "<p>Updated content in storage format.</p>"
    },
    "version": {
      "number": CURRENT_VERSION_PLUS_ONE
    }
  }'

Never guess the version number. Always GET first.

Add comment

curl -s -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X POST \
  "https://$ATLASSIAN_DOMAIN.atlassian.net/wiki/api/v2/pages/{id}/footer-comments" \
  -d '{
    "body": {
      "representation": "storage",
      "value": "<p>Comment text here.</p>"
    }
  }'

Key Gotchas

• v2 API does not return page body by default. You must add ?body-format=storage to get the body content.
• Updating requires version.number + 1. Always GET the page first to read the current version, then PUT with the next number. Skipping this will cause a 409 conflict error.
• CQL search is v1 only. Use /wiki/rest/api/search?cql=... for search. All other operations use v2 at /wiki/api/v2/.
• acli Confluence support is limited. Only use acli for page view (by ID) and space operations (list, view). Everything else requires curl.

Common CQL Recipes

See cql-recipes.md for a full reference of CQL search patterns, including:

• Search by title, space, creator, and modification date
• Combining conditions with AND/OR
• Label-based and ancestor-based queries

Storage Format Reference

See storage-format.md for the Confluence XHTML storage format reference, needed for creating and updating pages. Covers:

• Basic elements (paragraphs, headings, lists, tables, links)
• Confluence-specific macros (code blocks, TOC, info panels)
• Converting user intent into storage format XHTML

Self-Healing

If an API call or acli command fails:

Auth Errors (401, 403, or "not authenticated")

Check which auth paths are available — never print token or credential values:

# Check if env vars are set (NOT their values)
test -n "${ATLASSIAN_DOMAIN:-}" && echo "ATLASSIAN_DOMAIN is set" || echo "ATLASSIAN_DOMAIN is NOT set"
test -n "${ATLASSIAN_EMAIL:-}" && echo "ATLASSIAN_EMAIL is set" || echo "ATLASSIAN_EMAIL is NOT set"
test -n "${ATLASSIAN_API_TOKEN:-}" && echo "ATLASSIAN_API_TOKEN is set" || echo "ATLASSIAN_API_TOKEN is NOT set"

# Check acli (optional)
command -v acli && acli auth status

If neither auth path is available, tell the user:

To use Confluence, set these environment variables:

export ATLASSIAN_DOMAIN="yourcompany"        # yourcompany.atlassian.net
export ATLASSIAN_EMAIL="you@company.com"
export ATLASSIAN_API_TOKEN="your-token"

Generate an API token at: https://id.atlassian.com/manage/api-tokens

Other Errors

1. Check the error message for clues (permissions, bad request body, version conflict).
2. For acli errors, run acli confluence [command] --help for current flags and syntax.
3. If the API may have changed, check live docs via web search. Canonical URLs:
   • Confluence v2 REST API: https://developer.atlassian.com/cloud/confluence/rest/v2/
   • acli reference: https://developer.atlassian.com/cloud/acli/reference/commands/
4. Retry with corrected parameters.

Behavioral Guidelines

• Infer intent from natural language. "Find the onboarding doc" becomes a CQL search: type = page AND title ~ "onboarding".
• Construct all CQL and storage format from user intent. Never ask the user to write CQL or XHTML manually.
• For page updates: ALWAYS GET first, then PUT. "Update the design page with our new architecture" means: search or get the page, read the current version number, construct updated content in storage format, PUT with incremented version.
• Use acli for quick page views by ID and space operations when acli is available. Fall back to curl for everything else.
• Use --json flag with acli when you need to parse structured output.