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

# Inicio rápido de la API

> Crea una clave de API y haz tu primera solicitud a la API de Ciarem.

La API de Ciarem te permite conectar Ciarem con tus propios sistemas: sincronizar contactos, gestionar tus propiedades de CRM y etapas del embudo, y leer conversaciones de forma programática. Está disponible en el plan **Scale**, y durante la **prueba gratuita** para que la pruebes antes de pagar.

<Info>
  La API es un complemento, no un requisito: todo en Ciarem funciona sin escribir código. Recurre a la API cuando quieras integrar Ciarem con herramientas que no conectamos de forma nativa.
</Info>

## 1. Crea una clave de API

Necesitas ser administrador, en un plan Scale o en la prueba gratuita.

<Steps>
  <Step title="Abre Claves de API">
    En el panel, ve a **Configuración** y luego a **Claves de API**.
  </Step>

  <Step title="Haz clic en Crear clave">
    Ponle un nombre que indique para qué integración es.
  </Step>

  <Step title="Copia el secreto">
    El secreto — empieza con `oak_` — se muestra **solo una vez**: cópialo de inmediato y guárdalo como una contraseña. Si lo pierdes, revoca la clave y crea una nueva.
  </Step>
</Steps>

## 2. Haz tu primera solicitud

Cada solicitud se autentica con la clave como token bearer:

```bash theme={null}
curl https://api.ciarem.ai/v1/me \
  -H "Authorization: Bearer oak_TU_SECRETO"
```

Una respuesta exitosa identifica la organización a la que pertenece la clave:

```json theme={null}
{
  "org_id": "org_…",
  "name": "Tu empresa",
  "timezone": "America/Bogota",
  "language": "es",
  "plan": "scale",
  "trial": false
}
```

## 3. Explora

* Crea y actualiza **contactos**, incluidas tus propiedades personalizadas: consulta la [referencia de la API](/api-reference/openapi).
* Lee **conversaciones y mensajes** — cada mensaje te dice quién habló: el campo `sender` es `contact`, `agent`, `ai` o `system`.
* Gestiona los **metadatos del CRM**: propiedades personalizadas y etapas del embudo, las mismas que tu equipo usa en el panel.

Continúa con [Autenticación](/es/api-reference/authentication) y [Errores, límites y paginación](/es/api-reference/errors-limits-pagination).