Skip to main content
ConfluenceTools enable an Agent to retrieve, create, and update pages in Confluence. They also allow you to explore spaces and page details.

Prerequisites

The following example requires the atlassian-python-api library and Confluence credentials. You can obtain an API token by going here.
pip install atlassian-python-api
export CONFLUENCE_URL="https://your-confluence-instance"
export CONFLUENCE_USERNAME="your-username"
export CONFLUENCE_PASSWORD="your-password"
# or
export CONFLUENCE_API_KEY="your-api-key"

Example

The following agent will retrieve the number of spaces and their names.
from agno.agent import Agent
from agno.tools.confluence import ConfluenceTools

agent = Agent(
    name="Confluence agent",
    tools=[ConfluenceTools()],
    show_tool_calls=True,
    markdown=True,
)

agent.print_response("How many spaces are there and what are their names?")

Toolkit Functions

ParameterTypeDefaultDescription
usernamestr-Confluence username. Can also be set via environment variable CONFLUENCE_USERNAME.
passwordstr-Confluence password or API key. Can also be set via environment variables CONFLUENCE_API_KEY or CONFLUENCE_PASSWORD.
urlstr-Confluence instance URL. Can also be set via environment variable CONFLUENCE_URL.
api_keystr-Confluence API key (alternative to password).
ssl_verifyboolTrueIf True, verify the SSL certificate.

Toolkit Functions

FunctionDescription
get_page_contentGets the content of a specific page.
get_all_space_detailGets details about all Confluence spaces.
get_space_keyGets the Confluence key for the specified space.
get_all_page_from_spaceGets details of all pages from the specified space.
create_pageCreates a new Confluence page with the provided title and body.
update_pageUpdates an existing Confluence page.

Developer Resources