> For the complete documentation index, see [llms.txt](https://docs.violetlabs.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.violetlabs.com/es/funciones/api.md).

# API

La API de Violet te brinda acceso programático a los datos de tu entorno de Violet, para que puedas incorporarlos a tus propios scripts, informes, paneles y herramientas internas. Son los mismos datos que ves en Violet, en todas tus apps conectadas, disponibles mediante solicitudes HTTPS estándar en `https://[YOUR-TENANT-NAME].violetlabs.com/api/` (o `violetgov.com` para clientes de VioletGov).

Para empezar, [genera una clave de API](/es/funciones/api/genere-una-clave-de-api.md) e inclúyela en el `x-api-key` encabezado de cada solicitud. Luego ve a [Puntos de conexión](/es/funciones/api/puntos-de-conexion.md) para ver los detalles de la solicitud, una guía para probar en Postman y la documentación de cada endpoint disponible:

* **Explora:** consulta tus datos usando los mismos filtros y columnas que el Explorador de datos.
* **Entidades:** recupera propiedades detalladas y metadatos de entidades específicas.
* **Relaciones:** recorre las relaciones entre entidades.
* **Actividades:** revisa la actividad y el historial de cambios.


---

# 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.violetlabs.com/es/funciones/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.