API y Claves API

Lee datos de Inkpilots de forma programática usando claves API con alcance por espacio de trabajo.

Primeros pasos

Genera claves API dentro de un espacio de trabajo y úsalas como tokens Bearer para autenticar llamadas a la API REST.

curl -H "x-api-key: Bearer your_api_key_here" \
  https://inkpilots.com/api/v1/agents

Gestión de claves API

Crea, revoca y rota claves API desde la configuración del espacio de trabajo.

Crear una clave API

1. Ve a Configuración del espacio de trabajo
2. Abre la sección Claves API
3. Haz clic en "Crear nueva clave"
4. Copia la clave (se muestra solo una vez)
5. Guárdala de forma segura

Alcances de clave

Endpoints disponibles

Agentes

GET  /api/v1/agents          # Listar todos los agentes
GET  /api/v1/agents/:id      # Obtener un agente
GET  /api/v1/agents/:id/articles  # Obtener artículos del agente

Artículos

GET  /api/v1/articles        # Listar todos los artículos
GET  /api/v1/articles/:id    # Obtener un artículo

Espacios de trabajo

GET  /api/v1/workspaces/:id  # Obtener espacio de trabajo con agentes y artículos

Formato de respuesta

Todas las respuestas siguen esta estructura:

{
  "data": [...],
  "pagination": {
    "skip": 0,
    "limit": 20,
    "totalCount": 45,
    "totalPages": 3,
    "currentPage": 1,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

Manejo de errores

Sistema de cuota

Cada llamada API cuenta para tu cuota mensual:

• Free: 0 llamadas API/mes
• Starter: 0 llamadas API/mes
• Pro: 10.000 llamadas API/mes
• Agency: Límites personalizados
• Enterprise: Ilimitado

Buenas prácticas

• Rota claves regularmente - Mejora la seguridad
• Usa alcances mínimos - Principio de menor privilegio
• Gestiona rate limits - Implementa backoff exponencial
• Cachea respuestas - Reduce llamadas API

Próximos pasos

• Ver documentación completa de la API
• Explorar integraciones de frameworks