> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yampi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introducción

> Descripción general de la API de Yampi.ai y sus grupos de endpoints

<Info>
  La API de Yampi.ai está organizada en cuatro grupos principales: **Platform**, **Application**, **Client** y **Others**. La URL base es `https://app.yampi.ai`.
</Info>

## Estructura de la API

<CardGroup cols={2}>
  <Card title="Platform API" icon="server" href="/api-reference/platform">
    Endpoints para provisionar cuentas, usuarios y bots a nivel de plataforma (`/platform/api/v1/`).
  </Card>

  <Card title="Application API" icon="cube" href="/api-reference/application">
    Operación diaria: contactos, conversaciones, inboxes, treasury, propiedades, compañías, oportunidades, contratos, Captain, SLA, etc. (`/api/v1/`).
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Client API (pública)" icon="globe" href="/api-reference/client">
    Endpoints públicos para frontends: Contacts, Conversations y Messages API (`/public/api/v1/`).
  </Card>

  <Card title="Others" icon="face-smile" href="/api-reference/others">
    Encuestas CSAT y otros endpoints (`/survey/`).
  </Card>
</CardGroup>

## Base URL

Todas las rutas documentadas se construyen sobre:

```
https://app.yampi.ai
```

## Autenticación

Los endpoints usan el header `api_access_token` con uno de estos esquemas:

* **userApiKey**: token de usuario (perfil)
* **agentBotApiKey**: token para bots (acceso limitado)
* **platformAppApiKey**: token de aplicación de plataforma (provisioning)

<Card title="Autenticación" icon="key" href="/api-reference/authentication">
  Ver ejemplos, tipos de token y mejores prácticas.
</Card>

<Card title="Completitud de la documentación" icon="chart-pie" href="/api-reference/completion">
  Estado actual: **100%** de las operaciones del OpenAPI tienen página dedicada (167/167).
</Card>