> 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/api-de-compass.md).

# API de Compass

## Resumen y formato

El [Compass](/tabiya-documentation/es/nuestra-pila-tecnologica/compass.md) API proporciona acceso seguro a las preferencias de los usuarios, al estado de la conversación y a las experiencias y habilidades, permitiendo 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 asegurar 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.&#x20;

* Claves de API: Una clave de API puede solicitarse contactando a los administradores vía el 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 formatearse como: x-api-key: \<tu-token-de-acceso>.
* Encabezados de autorización: Estos son específicos del usuario de Compass y requieren primero iniciar sesión a través de la aplicación Compass para obtener el token de acceso.

## Acceso directo a la especificación OpenAPI

Hay dos métodos de acceso disponibles para las especificaciones de la API. El método principal es a través de la página de documentación interactiva Swagger UI, que permite navegar y probar en vivo todos los endpoints. De forma crucial, para los desarrolladores que buscan configurar rápidamente sus clientes, se proporciona un enlace directo y autónomo al archivo de especificación JSON OpenAPI v3. Este enlace es esencial para los desarrolladores que desean importar toda la definición de la API en herramientas como Postman o Insomnia (usando el *Opción Importar > Enlace*), acelerando la configuración al generar automáticamente 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 tasa

Para garantizar un acceso justo y estable para todos los usuarios, aplicamos una política de limitación de tasa. Los desarrolladores están limitados a 120 solicitudes por minuto por cada clave de API única. Superar este umbral resultará inmediatamente en la devolución de un código de estado HTTP 429 "Demasiadas solicitudes", y las solicitudes posteriores serán bloqueadas hasta que se restablezca 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 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/es/nuestra-pila-tecnologica/compass/technical-overview/api-de-compass.md?ask=<question>&goal=<endgoal>
```

`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.
