Confluence

Connect Confluence to your preprocessing pipeline, and use the Unstructured CLI or Python to batch process all your spaces and pages and store structured outputs locally on your filesystem.

The requirements are as follows.

• A Confluence account.
• The URL for the target Confluence instance.
• A Confluence user with the correct permissions to access the target spaces and pages in the Confluence instance.
• A Confluence API token for the target Confluence user.
• Optionally, the names of the specific spaces in the Confluence instance to access.

The Confluence connector dependencies:

pip install "unstructured-ingest[confluence]"

You might also need to install additional dependencies, depending on your needs. Learn more.

The following environment variables:

• CONFLUENCE_URL - The URL of the Confluence instance, represented by --url (CLI) or url (Python).
• CONFLUENCE_API_TOKEN - The value of the Confluence API token for authenticating with the Confluence instance, represented by --api-token (CLI) or api_token (Python).
• CONFLUENCE_USER_EMAIL - The user’s email address for authenticating with the Confluence instance, represented by --user-email (CLI) or user_email (Python).

Additional settings include:

• --spaces (CLI) or spaces (Python): Optionally, the list of the names of the specific spaces to access, expressed as a comma-separated list of strings (CLI) or an array of strings (Python), with each string representing a space’s name. The default is no specific spaces, if not otherwise specified.
• --max-num-of-spaces (CLI) or max_num_of_spaces (Python): Optionally, the maximum number of spaces to access, expressed as an integer. The default value is 500 if not otherwise specified.
• --max-num-of-docs-from-each-space (CLI) or max_num_of_docs_from_each_space (Python): Optionally, the maximum number of documents to access from each space, expressed as an integer. The default value is 100 if not otherwise specified.

These environment variables:

• UNSTRUCTURED_API_KEY - Your Unstructured API key value.
• UNSTRUCTURED_API_URL - Your Unstructured API URL.

Now call the Unstructured CLI or Python SDK. The destination connector can be any of the ones supported. This example uses the local destination connector: