> 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/es/nuestra-pila-tecnologica/compass/technical-overview/compass-api.md).

# API de Compass

Compass es un chatbot innovador, impulsado por IA, diseñado para revolucionar la forma en que una persona joven identifica, articula y muestra sus habilidades. Conoce más sobre la API que impulsa Compass.

## Descripción general y formato

La [Compass](/tabiya-documentation/es/nuestra-pila-tecnologica/compass.md) La API proporciona acceso seguro a las preferencias, el estado de la conversación y las experiencias y habilidades de los usuarios, lo que permite una integración fluida con sus aplicaciones. La URL base para todas las solicitudes de la API es <https://demo.compass.tabiya.tech/api/docs>. Para garantizar una comunicación estandarizada, todas las solicitudes y respuestas (excepto las cargas de archivos) utilizan el formato JSON, lo que facilita la integración con cualquier entorno de programación moderno.

## Credenciales y autenticación

Antes de la integración, los desarrolladores deben obtener las credenciales necesarias.

* Claves de API: se puede solicitar una clave de API contactando a los administradores a través del correo electrónico designado. Una vez emitida, la clave de API debe incluirse en el encabezado x-api-key de cada solicitud. Por ejemplo, el encabezado debe tener el formato: x-api-key: \<your-access-token>.
* Encabezados de autorización: son específicos del usuario de Compass y requieren iniciar sesión primero en la aplicación Compass para obtener el token de acceso.

## Acceso directo a la especificación OpenAPI

Existen dos métodos de acceso para las especificaciones de la API. El método principal es a través de la página interactiva de documentación de Swagger UI, que permite explorar y probar en vivo todos los endpoints. Es importante destacar que, para los desarrolladores que desean configurar rápidamente sus clientes, se proporciona un enlace directo e independiente al archivo de especificación JSON de OpenAPI v3. Este enlace es esencial para los desarrolladores que quieren importar toda la definición de la API en herramientas como Postman o Insomnia (usando el *opción Importar > Enlace*), acelerando la configuración mediante la generación automática de todas las definiciones de endpoints, parámetros y esquemas:

* Enlace de la especificación OpenAPI: <https://demo.compass.tabiya.tech/openapi.json>
* Enlace de Swagger: <https://demo.compass.tabiya.tech/api/docs>

## Políticas de uso y limitación de velocidad

Para garantizar un acceso justo y estable para todos los usuarios, aplicamos una política de limitación de velocidad. Los desarrolladores están limitados a 120 solicitudes por minuto por cada clave de API única. Superar este umbral provocará inmediatamente la devolución de un código de estado HTTP 429 "Demasiadas solicitudes", y las solicitudes posteriores se bloquearán hasta que se reinicie el minuto.


---

# 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/es/nuestra-pila-tecnologica/compass/technical-overview/compass-api.md?ask=<question>&goal=<user_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.