Skip to main content

Airbyte Confluence Connector for AI platforms

Project description

Confluence

The Confluence agent connector is a Python package that equips AI agents to interact with Confluence through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the Confluence Cloud REST API. Provides read access to Confluence spaces, pages, blog posts, groups, and audit logs. Uses the Confluence Cloud REST API v2 for spaces, pages, and blog posts, and the v1 API for groups and audit records. Authenticates via HTTP Basic using an Atlassian account email and API token.

Example questions

The Confluence connector is optimized to handle prompts like these.

  • List all spaces in my Confluence instance
  • Show me the most recently created pages
  • List all blog posts
  • Show me details for a specific page
  • List all groups in Confluence
  • Show me recent audit log entries
  • Get details about a specific space
  • Show me blog post details
  • Find pages created in the last 7 days
  • What spaces have the most pages?
  • Show me all pages in a specific space
  • Find blog posts by a specific author
  • What audit events happened this week?

Unsupported questions

The Confluence connector isn't currently able to handle prompts like these.

  • Create a new page in Confluence
  • Update an existing page
  • Delete a space
  • Upload an attachment to a page
  • Manage space permissions

Installation

uv pip install airbyte-agent-confluence

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_confluence import ConfluenceConnector
from airbyte_agent_confluence.models import ConfluenceAuthConfig

connector = ConfluenceConnector(
    auth_config=ConfluenceAuthConfig(
        username="<Your Atlassian account email address>",
        password="<Your Confluence API token from https://id.atlassian.com/manage-profile/security/api-tokens>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@ConfluenceConnector.tool_utils
async def confluence_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. If your Airbyte client can access multiple organizations, also set organization_id.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_confluence import ConfluenceConnector, AirbyteAuthConfig

connector = ConfluenceConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@ConfluenceConnector.tool_utils
async def confluence_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity Actions
Spaces List, Get, Context Store Search
Pages List, Get, Context Store Search
Blog Posts List, Get, Context Store Search
Groups List, Context Store Search
Audit List, Context Store Search

Authentication

For all authentication options, see the connector's authentication documentation.

Confluence API docs

See the official Confluence API reference.

Version information

  • Package version: 0.1.14
  • Connector version: 1.0.1
  • Generated with Connector SDK commit SHA: 6bf360a546d577c9f76e8a6b8abf9ffc4dbfcf3a
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_confluence-0.1.14.tar.gz (161.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_confluence-0.1.14-py3-none-any.whl (188.3 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_confluence-0.1.14.tar.gz.

File metadata

File hashes

Hashes for airbyte_agent_confluence-0.1.14.tar.gz
Algorithm Hash digest
SHA256 806d3eccc47c48fa7125c1287082632d7b6a6c106d98d71063fe57cf35662456
MD5 546247c8e0291af8228f80c1d6f126c8
BLAKE2b-256 ad7dff5a955639f78c60acb618fb426eb63a67caf6597834421b94aaa7b932c7

See more details on using hashes here.

File details

Details for the file airbyte_agent_confluence-0.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_confluence-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 4d113e1a1715e80e73dcf7a253ed4ad14c488d703ff9d106e0e07f2b819f38cf
MD5 4267770421a2450cf2031c96b1f1942b
BLAKE2b-256 f49f79717479ea0f0044344170b61cdc0ce0f0110d2bb5a34e52bca776dd2639

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page