> For the complete documentation index, see [llms.txt](https://docs.tabiya.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tabiya.org/our-tech-stack/compass/technical-overview/compass-api.md). # Compass API Compass is an innovative, AI-powered chatbot designed to revolutionize the way a young person identifies, articulates, and showcases their skills. Learn more about the API that powers Compass. ## Overview and Format The [Compass](/our-tech-stack/compass.md) API provides secure access to users' preferences, conversation state, and experiences and skills, enabling seamless integration with your applications. The base URL for all API requests is . To ensure standardized communication, all requests and responses (except file uploads) utilize the JSON format, making it straightforward to integrate with any modern programming environment. ## Credentials and Authentication Before integration, developers must obtain the necessary credentials. * API Keys: An API Key, can be requested by contacting the admins via the designated email. Once issued, the API key must be included in the x-api-key header of every request. For example, the header should be formatted as: x-api-key: \. * Authorization Headers: These are compass user-specific and require first logging in via the compass app to obtain the access token. ## Direct Access to the OpenAPI Specification Two access methods are available for the API specifications. The primary method is through the interactive Swagger UI documentation page, which allows browsing and live testing of all endpoints. Crucially, for developers looking to quickly configure their clients, a direct, standalone link to the OpenAPI v3 JSON specification file is provided. This link is essential for developers who want to import the entire API definition into tools like Postman or Insomnia (using the *Import > Link option*), accelerating setup by automatically generating all endpoint, parameter, and schema definitions: * OpenAPI Specification link: * Swagger link: ## Usage Policies and Rate Limiting To ensure fair and stable access for all users, we enforce a Rate Limiting policy. Developers are limited to 120 requests per minute per unique API key. Exceeding this threshold will immediately result in an HTTP 429 "Too Many Requests" status code being returned, and subsequent requests will be blocked until the minute resets. --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.tabiya.org/our-tech-stack/compass/technical-overview/compass-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.