Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-confluence
[02]
Import
Initialize and use
PYTHON
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>"
)
)[03]
Tool
Add tools to your agent
python
@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 {})Supported Entities & Actions
Lorem ipsum
Lorem ipsum
| Entity | Actions |\n|--------|---------|\n| Spaces | [List](./REFERENCE.md#spaces-list), [Get](./REFERENCE.md#spaces-get), [Search](./REFERENCE.md#spaces-search) |\n| Pages | [List](./REFERENCE.md#pages-list), [Get](./REFERENCE.md#pages-get), [Search](./REFERENCE.md#pages-search) |\n| Blog Posts | [List](./REFERENCE.md#blog-posts-list), [Get](./REFERENCE.md#blog-posts-get), [Search](./REFERENCE.md#blog-posts-search) |\n| Groups | [List](./REFERENCE.md#groups-list), [Search](./REFERENCE.md#groups-search) |\n| Audit | [List](./REFERENCE.md#audit-list), [Search](./REFERENCE.md#audit-search) |
Example Prompts
Lorem ipsum
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?
Why Airbyte for AI Agents?
Built for production AI workloads with enterprise-grade reliability
Secure Authentication
Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.
Agent-Native Design
Heading
Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.
Production Ready
Battle-tested connectors with comprehensive error handling, logging, and retry logic.
Open Source
Fully open source under the MIT license. Contribute, customize, and extend freely.
Works with your favorite frameworks
LangChain
CrewAI
LlamaIndex
AutoGen
OpenAI Agents SDK
Claude Agents SDK
Frequently Asked Questions
Didn't find your answer? Please don't hesitate to reach out.
The Confluence connector supports HTTP Basic authentication using an Atlassian account email address and a Confluence API token (obtainable from https://id.atlassian.com/manage-profile/security/api-tokens). In hosted mode, credentials are stored securely in Airbyte Cloud and accessed via Airbyte client credentials.
Can I use this connector with any AI agent framework?
The connector is compatible with any Python-based AI agent framework including LangChain, LlamaIndex, CrewAI, Pydantic AI, and custom implementations.
Does this connector support write operations?
Currently, the Confluence connector focuses on read operations only. Write operations such as creating pages, updating existing pages, deleting spaces, uploading attachments, or managing space permissions are not supported at this time.
How is this different from the Airbyte data connector?
Agent connectors are specifically designed for AI agents and LLM applications. They provide natural language interfaces, optimized response formats, and seamless integration with agent frameworks, unlike traditional ETL-focused connectors.
Get started in minutes with our open-source connector.