> For the complete documentation index, see [llms.txt](https://village-labs.gitbook.io/coworker-product-and-developer-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://village-labs.gitbook.io/coworker-product-and-developer-docs/data-connections/confluence.md).

# Confluence

Prerequisites

* A Confluence account with admin access.
  * This account must not have two-step verification enabled, as 2FA also applies to API requests.
  * More information about API tokens:\
    <https://support.atlassian.com/atlassian-account/docs/manage-two-step-verification-for-your-atlassian-account/>

### Generating the credentials

1. Generate an API token associated with your Confluence account \
   <https://id.atlassian.com/manage-profile/security/api-tokens>\
   ![](/files/aBB6YE77qeG35Btz4sJR)
2. Copy the token and store it in a secure place. This is the access token that Coworker will need.![](/files/4jNq2EPm8nRRm0zyuWwH)<br>
3. Export users to connect email and Confluence ID\
   1\. Go to <https://admin.atlassian.com/>\
   2\. Click Directory\
   3\. Click the three dots on the top right and click "Export Users"\
   4\. Change the users selector to only active users, and click export.\
   4\. When you receive the email, download the users and share them with the Coworker team in our shared Slack channel.

{% @arcade/embed flowId="JLO4qgQ5LhT4zPOLKoIv" url="<https://app.arcade.software/share/JLO4qgQ5LhT4zPOLKoIv>" %}

<figure><img src="/files/OxWR6aM0Kc1QXkZbhPNg" alt=""><figcaption></figcaption></figure>

### Information required for the Coworker connection:

* `email`: The email address associated with the Confluence account which created your API token
* `api_key`: The API token created above
* `base_url`: The base URL of your Confluence account, prefixed with https, eg. [https://mycompany.atlassian.net](https://villagelabs.atlassian.net)
* Share your list of Confluence users


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://village-labs.gitbook.io/coworker-product-and-developer-docs/data-connections/confluence.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
