Referencia de la API

Lo que aprenderás

• Dónde encontrar la documentación completa de la API de AutoTalk
• Cómo autenticar solicitudes con tu clave de API
• Principales endpoints de la API y qué hacen

AutoTalk expone una API REST pública que permite a aplicaciones externas crear y gestionar clientes, enviar mensajes, consultar conversaciones, trabajar con datos dinámicos (Dynadata) y más. La API sigue la especificación OpenAPI 3.0 y utiliza autenticación por clave de API.

Documentación interactiva de la API

La documentación completa e interactiva de la API está disponible en:

https://api.autotalk.io

Desde allí puedes navegar por todos los endpoints, ver esquemas de solicitud y respuesta, y probar llamadas directamente en el navegador.

Autenticación

Todas las solicitudes de API requieren una clave de API pasada en el encabezado x-api-key:

x-api-key: YOUR_API_KEY

Para generar una clave de API, ve a Integraciones > Tokens de API en el panel de AutoTalk y haz clic en el botón +. Consulta Tokens de API para instrucciones paso a paso.

tip

Mantén tu clave de API en secreto. Nunca la incluyas en control de versiones ni la compartas en canales públicos. Si una clave es comprometida, revócala inmediatamente y crea una nueva.

URL Base

Todas las solicitudes de API usan la siguiente URL base:

https://api.autotalk.io/v1

Principales endpoints

A continuación se muestra una descripción general de las principales áreas de la API. Para detalles completos de solicitud/respuesta, visita la documentación interactiva.

Empresa

Método	Ruta	Descripción
GET	/v1/self	Recuperar el perfil de la empresa autenticada

Clientes

Método	Ruta	Descripción
POST	/v1/contacts/{contactId}/send_message	Enviar un mensaje a un contacto específico

Conversaciones

Método	Ruta	Descripción
GET	/v1/conversations	Listar conversaciones
POST	/v1/conversations	Crear una nueva conversación
POST	/v1/conversations/{id}/messages	Procesar mensajes en una conversación
GET	/v1/conversations/{id}/messages	Listar mensajes en una conversación

Dynadata (datos dinámicos)

Los endpoints de Dynadata te permiten gestionar entidades de datos personalizadas (clientes, pedidos, tickets o cualquier tipo que tu empresa defina).

Método	Ruta	Descripción
GET	/v1/dynadata/types	Listar todos los tipos de Dynadata disponibles
GET	/v1/dynadata/type/{type}/list	Listar elementos de un tipo específico
GET	/v1/dynadata/type/{type}/item/{_id}	Recuperar un único elemento por ID
POST	/v1/dynadata/type/{type}/create	Crear un nuevo elemento
PUT	/v1/dynadata/type/{type}/update	Actualizar un elemento existente
POST	/v1/dynadata/type/{type}/validate	Validar un elemento sin guardar
GET	/v1/dynadata/type/{type}/schema	Obtener el esquema JSON de un tipo
GET	/v1/dynadata/type/{type}/schema/zod	Obtener el esquema Zod de un tipo
POST	/v1/dynadata/type/{type}/executeFunction/{functionName}	Ejecutar una función en un tipo
POST	/v1/dynadata/type/{type}/item/{_id}/executeFunction/{functionName}	Ejecutar una función en un elemento específico

Integraciones y canales

Método	Ruta	Descripción
GET	/v1/integrations/channels	Listar canales de integración conectados

Asistentes de IA

Método	Ruta	Descripción
GET	/v1/assistants	Listar asistentes de IA configurados

Ejemplo de solicitud

Aquí hay un ejemplo de envío de un mensaje de texto a un cliente usando curl:

curl -X POST https://api.autotalk.io/v1/contacts/CONTACT_ID/send_message \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Hello! How can we help you today?"
  }'

Próximos pasos

• Tokens de API -- Genera y gestiona tus claves de API
• Webhooks -- Recibe notificaciones de eventos de AutoTalk
• Workflows -- Automatiza tareas dentro de AutoTalk