# Confluence API

## Using Confluence in EbbotGPT Knowledge

The Confluence API scraper retrieves data using Confluence's [Basic auth](https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/).

### Settings in Ebbot <a href="#marked-the-settings" id="marked-the-settings"></a>

<figure><img src="https://2117387010-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3rWESGvwA3vHJ3zNiAG1%2Fuploads%2FOcgvVpvGnMRdIXiWVx5d%2Fimage.png?alt=media&#x26;token=a2280142-362f-42f6-98dd-3442a10d58f8" alt=""><figcaption></figcaption></figure>

#### Prefix

At the beginning of the URL within your Confluence environment, you'll find your company’s unique domain. It typically follows the format: `yourCompanyName.atlassian.net`. In this example, you should enter `yourCompanyName` into the field.

#### **Email**

Add the email address of the user that the scraper will authenticate as. This can be your personal email or a dedicated "API user" account created for automation purposes.

#### Personal token

Here, you should enter an API token that you generate in Confluence.

To create an API token in Confluence, go to [this page](https://id.atlassian.com/manage-profile/security/api-tokens) and log in to the Confluence account associated with the email entered in the "Email" field. Then, navigate to the API token management page and click **"Create API Token"** to generate a new one. Note that the token will only be displayed once—be sure to save it securely for future use.

#### Space keys

Enter the space keys for the Confluence spaces you want to include in the scrape. You can find a space key in the space settings. It will look something like in the image below:

<div align="left"><figure><img src="https://2117387010-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3rWESGvwA3vHJ3zNiAG1%2Fuploads%2FLRsxq1C2q1vHhEHUoMbh%2Fimage%20(13).png?alt=media&#x26;token=75c3cdf3-535c-4c0c-8d4b-5f320a4398fe" alt=""><figcaption></figcaption></figure></div>

If no space keys are entered, the scraper will automatically retrieve content from all available "Global" and "Knowledge Base" spaces.


---

# Agent Instructions: 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:

```
GET https://docs.ebbot.ai/ebbot-docs/core-capabilities/ebbotgpt/ebbotgpt-knowledge/source-types/api-sources/confluence-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.