Atlassian Compass

Bring your API docs into Atlassian Compass, where teams manage microservices and components.

Installation

1. Access Compass — log into your Compass account.
2. Install the Theneo app — go to Apps in the top menu, find the Theneo tile, and select Install.
3. Configure — after installation, admins can select Configure to set up the integration.

Set up the integration

1. Connect your account — in the Theneo app configuration, paste your Theneo API key to link your account.
2. Create or link a project — start a new API documentation project in Theneo, or link an existing one.

Add a project to a Compass component

Upload a file

• Open the component where you want the spec and select Theneo.
• Under the Upload File tab, drag and drop your spec file (or browse). The file size limit is 10 MB.

Use a webhook

curl -F file=@<FILE_NAME_TO_IMPORT> \
  -F project_name=<PROJECT_NAME_TO_CREATE> \
  -F ai_option=<none|full|enhance> \
  -H "x-theneo-api-key:<YOUR_API_KEY>" \
  https://api.theneo.io/project/import/specfile

Replace the placeholders with your file name, project name, AI option, and API key. AI options are none, full, and enhance.

Link to an existing project

Use the dropdown menu to choose from your published Theneo projects.

AI assistance

• Full AI Assistance — generates new content for your documentation.
• Enhance Existing Content — fills in missing descriptions while preserving your content.

Managing the integration

• Remove the project from a component — in the project view, open the dropdown at the top right and select Generate new project.
• Replace the API key — go to Theneo under Apps, click Configure, and choose Replace API Key. (Admin-only.)