> 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-technologie-stack/compass/technical-overview/compass-api.md). # Kompass-API Kompass ist ein innovativer, KI-gestützter Chatbot, der darauf ausgelegt ist, die Art und Weise zu revolutionieren, wie junge Menschen ihre Fähigkeiten erkennen, formulieren und präsentieren. Erfahren Sie mehr über die API, die Kompass antreibt. ## Überblick und Format Die [Kompass](/tabiya-documentation/deutsch/unser-technologie-stack/compass.md) Die API bietet sicheren Zugriff auf die Präferenzen, den Gesprächsstatus sowie die Erfahrungen und Fähigkeiten der Nutzer und ermöglicht so eine nahtlose Integration in Ihre Anwendungen. Die Basis-URL für alle API-Anfragen ist . Um eine standardisierte Kommunikation zu gewährleisten, verwenden alle Anfragen und Antworten (außer Datei-Uploads) das JSON-Format, wodurch sich die Integration in jede moderne Programmierumgebung unkompliziert gestaltet. ## Anmeldedaten und Authentifizierung Vor der Integration müssen Entwickler die erforderlichen Zugangsdaten erwerben. * API-Schlüssel: Ein API-Schlüssel kann angefordert werden, indem die Administratoren über die angegebene E-Mail-Adresse kontaktiert werden. Nach der Ausgabe muss der API-Schlüssel in den x-api-key-Header jeder Anfrage aufgenommen werden. Zum Beispiel sollte der Header wie folgt formatiert sein: x-api-key: \. * Autorisierungs-Header: Diese sind kompass-benutzerspezifisch und erfordern zunächst eine Anmeldung über die Kompass-App, um das Zugriffstoken zu erhalten. ## Direkter Zugriff auf die OpenAPI-Spezifikation Für die API-Spezifikationen stehen zwei Zugriffsmethoden zur Verfügung. Die primäre Methode ist über die interaktive Swagger-UI-Dokumentationsseite, die das Durchsuchen und Live-Testen aller Endpunkte ermöglicht. Entscheidend ist, dass Entwicklern, die ihre Clients schnell konfigurieren möchten, ein direkter, eigenständiger Link zur OpenAPI-v3-JSON-Spezifikationsdatei bereitgestellt wird. Dieser Link ist für Entwickler unerlässlich, die die gesamte API-Definition in Tools wie Postman oder Insomnia importieren möchten (unter Verwendung des *Import > Link-Option*), wodurch die Einrichtung beschleunigt wird, indem automatisch alle Endpunkt-, Parameter- und Schema-Definitionen generiert werden: * Link zur OpenAPI-Spezifikation: * Swagger-Link: ## Nutzungsrichtlinien und Ratenbegrenzung Um einen fairen und stabilen Zugriff für alle Nutzer zu gewährleisten, setzen wir eine Richtlinie zur Ratenbegrenzung durch. Entwickler sind auf 120 Anfragen pro Minute und eindeutigen API-Schlüssel begrenzt. Eine Überschreitung dieses Schwellenwerts führt sofort dazu, dass ein HTTP-Statuscode 429 "Too Many Requests" zurückgegeben wird, 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 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/tabiya-documentation/deutsch/unser-technologie-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.