Skip to content
Docs

Compass

Connect your Compass data for instant access to technical documentation.

Category
Engineering
Connect with
An API key or token
Tools
1

Get a token

id.atlassian.com → Security → API tokens → Create API token (the plain one, not "with scopes"). The token has that user's rights; it only needs to see your Compass components.

Connect

  1. 01

    Integrations → Compass → Connect.

    Open Integrations, find Compass (search, or the Engineering category) and click Connect.

    Open in Oryvox
  2. 02
  3. 03

Tools

For each tool you choose when it runs. Agents only tools never reach the website chat.

ToolWhat it doesAccessWhere
Search componentsFind services, libraries and other Compass components by name: owner, description, documentation links.ReadChat and agents

Cloud ID

Find your Cloud ID at https://your-company.atlassian.net/_edge/tenant_info.

Was this page helpful?