> 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/tabiya-documentation/deutsch/unser-tech-stack/compass/technical-overview/compass-api.md). # Compass API ## Übersicht und Format Das [Kompass](/tabiya-documentation/deutsch/unser-tech-stack/compass.md) API bietet sicheren Zugriff auf die Präferenzen der Nutzer, den Gesprächszustand sowie Erfahrungen und Fähigkeiten und ermöglicht eine nahtlose Integration in Ihre Anwendungen. Die Basis-URL für alle API-Anfragen ist . Um eine standardisierte Kommunikation sicherzustellen, verwenden alle Anfragen und Antworten (außer Datei-Uploads) das JSON-Format, was die Integration in jede moderne Programmierumgebung vereinfacht. ## Zugangsdaten und Authentifizierung Vor der Integration müssen Entwickler die erforderlichen Zugangsdaten erhalten. * API-Schlüssel: Ein API-Schlüssel kann angefordert werden, indem die Administratoren über die dafür vorgesehene E-Mail kontaktiert werden. Nach Ausstellung muss der API-Schlüssel in der x-api-key Kopfzeile jeder Anfrage enthalten sein. Beispielsweise sollte die Kopfzeile wie folgt formatiert sein: x-api-key: \. * Autorisierungs-Header: Diese sind compass-benutzerspezifisch und erfordern zunächst eine Anmeldung über die compass-App, um das Zugriffstoken zu erhalten. ## Direkter Zugriff auf die OpenAPI-Spezifikation Für die API-Spezifikationen stehen zwei Zugriffsverfahren zur Verfügung. Die primäre Methode ist die interaktive Swagger-UI-Dokumentationsseite, die das Durchsuchen und Live-Testen aller Endpunkte ermöglicht. Wichtig für Entwickler, die ihre Clients schnell konfigurieren möchten: Es wird ein direkter, eigenständiger Link zur OpenAPI v3 JSON-Spezifikationsdatei bereitgestellt. Dieser Link ist unerlässlich für Entwickler, die die gesamte API-Definition in Tools wie Postman oder Insomnia importieren möchten (mithilfe der *Import > Link option*), wodurch die Einrichtung beschleunigt wird, da automatisch alle Endpunkt-, Parameter- und Schema-Definitionen generiert werden: * OpenAPI-Spezifikationslink: * Swagger-Link: ## Nutzungsrichtlinien und Ratenbegrenzung Um einen fairen und stabilen Zugang für alle Nutzer sicherzustellen, wenden wir eine Ratenbegrenzung an. Entwicklern sind maximal 120 Anfragen pro Minute pro einzigartigem API-Schlüssel gestattet. Ein Überschreiten dieser Grenze führt sofort zur Rückgabe des HTTP-Statuscodes 429 "Too Many Requests" und nachfolgende Anfragen werden blockiert, bis die Minute zurückgesetzt wird. --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.tabiya.org/tabiya-documentation/deutsch/unser-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 optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.