Referencia de API
Otros recursos
Referencia rápida de recursos adicionales de la API. Salvo que se indique lo contrario, todos cuelgan de /workspaces/:workspaceId/ y aceptan JWT o API key (se abre en una pestaña nueva).
Búsqueda global
Sección titulada «Búsqueda global»Busca en paralelo dentro de varios tipos de entidad a la vez. Cada tipo solo se consulta si el usuario (o la API key) tiene la capability de lectura correspondiente — si no la tiene, ese tipo ni siquiera llega a hacer la query, y la clave aparece en la respuesta con un arreglo vacío.
/workspaces/:workspaceId/searchParámetros de query
Sección titulada «Parámetros de query»| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
q | string | Sí | Texto a buscar (1–120 caracteres). |
types | string | No | Lista de tipos separados por coma. Por defecto busca en todos. |
Tipos soportados: contacts, flows, pipelines, agents, voiceAgents, campaigns, emailTemplates, whatsappTemplates, conversations, calendarEvents, knowledgeDocs, callCampaigns, callerIds.
Contexto de la empresa
Sección titulada «Contexto de la empresa»Perfil de la empresa (nombre, descripción, horarios, FAQs) que alimenta el prompt de los asistentes. Un workspace puede tener varios contextos; uno de ellos puede marcarse isDefault.
| Método | Ruta | Descripción |
|---|---|---|
GET | /company-contexts | Listar contextos del workspace |
GET | /company-contexts/default | Obtener el contexto marcado como predeterminado |
GET | /company-contexts/:contextId | Obtener un contexto |
POST | /company-contexts | Crear un contexto |
PUT | /company-contexts/:contextId | Actualizar un contexto |
DELETE | /company-contexts/:contextId | Eliminar un contexto |
POST | /company-contexts/analyze-site | Analizar un sitio web (sin crear ni guardar nada) |
POST | /company-contexts/:contextId/rescrape | Volver a analizar el sitio de un contexto existente |
POST | /company-contexts/:contextId/generate-prompt | Generar el prompt de un asistente a partir del contexto |
Ejemplo — crear un contexto
Sección titulada «Ejemplo — crear un contexto»/workspaces/:workspaceId/company-contextsCuerpo de la petición
Sección titulada «Cuerpo de la petición»| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
name | string | Sí | Nombre/etiqueta del contexto guardado (máx. 200). |
companyName | string | No | Nombre real de la empresa. Si se omite, se rellena con name. |
websiteUrl | string | No | URL del sitio web (máx. 2000). |
description | string | No | Descripción de la empresa (máx. 5000). |
industry | string | No | Industria/rubro (máx. 200). |
services | string[] | No | Lista de servicios (máx. 100 items). |
businessHours | string | No | Horario de atención en texto libre (máx. 1000). |
contactInfo | object | No | Datos de contacto libres (teléfono, dirección, etc.). |
faqs | object[] | No | Preguntas frecuentes: { question, answer } (máx. 100). |
isDefault | boolean | No | Marca este contexto como el predeterminado del workspace. |
autoScrape | boolean | No | Si es true y hay websiteUrl, analiza el sitio al crear. |
Eventos CRM
Sección titulada «Eventos CRM»Suscribe un flow del Flow Studio (se abre en una pestaña nueva) a eventos del CRM (contacto creado, oportunidad movida de etapa, etc.), como alternativa a configurarlo desde el editor visual.
/workspaces/:workspaceId/crm-events/typesLista los tipos de evento disponibles, con su etiqueta y si admiten condiciones de filtro.
| Método | Ruta | Descripción |
|---|---|---|
GET | /crm-events/types | Listar tipos de evento disponibles |
POST | /crm-events/flows/:flowId/subscribe | Suscribir un flow a un tipo de evento |
DELETE | /crm-events/flows/:flowId/subscribe | Desuscribir un flow (vuelve a trigger manual) |
Ejemplo — suscribir un flow
Sección titulada «Ejemplo — suscribir un flow»/workspaces/:workspaceId/crm-events/flows/:flowId/subscribeCuerpo de la petición
Sección titulada «Cuerpo de la petición»| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
eventType | string | Sí | Uno de los tipos listados en /crm-events/types. |
pipelineId | string | Depende | Obligatorio para opportunity.created; opcional (filtra) para el resto de eventos de oportunidad. |
Relacionado
Sección titulada «Relacionado»Secuencias de seguimiento
Sección titulada «Secuencias de seguimiento»Secuencias de mensajes automáticos que se disparan cuando un contacto no responde a un asistente. Cada secuencia tiene una lista ordenada de pasos, con su propio retraso y tipo de contenido.
| Método | Ruta | Descripción |
|---|---|---|
GET | /follow-up/sequences | Listar secuencias (filtro opcional ?agentId=) |
POST | /follow-up/sequences | Crear una secuencia (con pasos opcionales) |
GET | /follow-up/sequences/:id | Obtener una secuencia con sus pasos |
PATCH | /follow-up/sequences/:id | Actualizar una secuencia |
DELETE | /follow-up/sequences/:id | Eliminar una secuencia |
POST | /follow-up/default-sequence | Crear la secuencia por defecto del workspace |
POST | /follow-up/sequences/:id/steps | Agregar un paso a una secuencia |
PATCH | /follow-up/sequences/:id/steps/:stepId | Actualizar un paso |
DELETE | /follow-up/sequences/:id/steps/:stepId | Eliminar un paso |
Ejemplo — crear una secuencia
Sección titulada «Ejemplo — crear una secuencia»/workspaces/:workspaceId/follow-up/sequencesCuerpo de la petición
Sección titulada «Cuerpo de la petición»| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
name | string | Sí | Nombre de la secuencia (máx. 120). |
agentId | string | No | Asistente al que aplica. Sin valor, aplica a todos. |
isActive | boolean | No | Por defecto true. |
triggerOn | string | No | Condición de disparo. Por defecto NO_RESPONSE. |
maxAttempts | number | No | Tope de intentos (1–20). |
reactivateAgent | boolean | No | Si al responder el contacto se reactiva el asistente. Por defecto true. |
steps | object[] | No | Pasos iniciales — ver tabla debajo. |
Cada paso (steps[] al crear, o el cuerpo de POST .../steps):
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
delayMinutes | number | Sí | Minutos de espera desde el paso anterior (mínimo 1). |
stepType | string | No | TEXT | AI_GENERATED | PROMPT_TEMPLATE | WHATSAPP_TEMPLATE | FLOW. Por defecto TEXT. |
message | string | Depende | Requerido si stepType es TEXT (máx. 4096). |
promptTemplate | string | Depende | Requerido si stepType es PROMPT_TEMPLATE (máx. 4096). |
templateId | string | Depende | Requerido si stepType es WHATSAPP_TEMPLATE; debe pertenecer al workspace. |
flowId | string | Depende | Requerido si stepType es FLOW; debe pertenecer al workspace. |
stepNumber | number | No | Orden del paso. Si se omite, se calcula automáticamente. |
Agentes de voz
Sección titulada «Agentes de voz»| Método | Ruta | Descripción |
|---|---|---|
GET | /voice-agents | Listar agentes de voz |
POST | /voice-agents | Crear agente de voz |
GET | /voice-agents/:id | Obtener |
PATCH | /voice-agents/:id | Actualizar |
Ver Agentes de voz (se abre en una pestaña nueva).
Uso y créditos
Sección titulada «Uso y créditos»Consumo de créditos (se abre en una pestaña nueva) del workspace. El saldo (wallet) es siempre el del pool de la cuenta, compartido entre todos sus workspaces — por eso el resumen y el historial de eventos también se agregan a nivel de cuenta cuando aplica, no solo del workspace consultado.
| Método | Ruta | Descripción |
|---|---|---|
GET | /usage/summary | Resumen de consumo del período + estado del wallet |
GET | /usage/wallet | Estado actual del saldo (lectura rápida) |
GET | /usage/events | Historial paginado de eventos de consumo |
Ejemplo — resumen de consumo
Sección titulada «Ejemplo — resumen de consumo»/workspaces/:workspaceId/usage/summaryParámetros de query
Sección titulada «Parámetros de query»| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
from | string (ISO date) | No | Inicio del período. Por defecto, el 1º del mes calendario actual. |
to | string (ISO date) | No | Fin del período. Por defecto, el último día del mes calendario actual. |
Ejemplo — historial de eventos
Sección titulada «Ejemplo — historial de eventos»/workspaces/:workspaceId/usage/eventsParámetros de query
Sección titulada «Parámetros de query»| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
page | number | No | Página (por defecto 1). |
limit | number | No | Tamaño de página, máx. 100 (por defecto 20). |
eventType | string | No | Filtra por tipo (ai_call, voice_minute, whatsapp_message, sms_sent, email_sent, etc.). |
source | string | No | waiify o byok. |
from | string (ISO date) | No | Fecha inicial (createdAt >=). |
to | string (ISO date) | No | Fecha final (createdAt <=). |
Precios públicos
Sección titulada «Precios públicos»Las tarifas de créditos, los modelos de IA, los paquetes de créditos y los planes, tal como se publican en Créditos (se abre en una pestaña nueva) y Planes (se abre en una pestaña nueva). Son las únicas rutas públicas sin autenticación de esta página — ni JWT ni API key — y aceptan peticiones desde cualquier origen (CORS abierto). Nunca exponen tarifas negociadas por cuenta, costos internos ni proveedores.
/pricingSin parámetros ni autenticación. Solo lectura, con rate limit de 30 solicitudes por minuto. La respuesta se puede cachear 60 segundos.
| Campo | Qué trae |
|---|---|
creditUsd | Valor de un crédito en dólares |
rates | Tarifa por acción: eventType, label, description, category, unit, country, variant, rate (créditos) y free |
aiModels | Modelos de IA por módulo (chat_assistant, flow_studio) con creditsPerUse y totalCreditsPerUse (lo que paga el cliente por un uso) |
packages y volumeTiers | Paquetes de créditos y precio por crédito según la cantidad, en dólares |
rules | Acumulación de la cuota, caducidad de lo comprado, umbrales de alerta y planes con pruebas sin costo |
plans | Planes con su precio en dólares, créditos y límites |
/credit-ratesSolo la lista rates de la ruta anterior, como arreglo en data. Se mantiene por compatibilidad; para algo nuevo usa /pricing.
Analítica
Sección titulada «Analítica»Métricas agregadas del workspace para dashboards. Todos los endpoints aceptan ?period= con 7d, 30d o 90d (por defecto 30d; cualquier otro valor cae también a 30d).
| Método | Ruta | Descripción |
|---|---|---|
GET | /analytics/overview | KPIs principales: contactos, conversaciones, mensajes, flows, agentes, citas |
GET | /analytics/conversations | Conversaciones por estado/canal, timeline y tiempo de resolución |
GET | /analytics/leads | Funnel de contactos por estado, fuentes y timeline |
GET | /analytics/flows | Ejecuciones de flows, tasa de éxito, top flows y duración |
GET | /analytics/agents | Sesiones de asistentes, tool calls y top agentes |
GET | /analytics/sms | Campañas de SMS: entregas, tasa de error, motivos de fallo |
GET | /analytics/dashboard | overview + conversations + leads + flows + agents en una sola llamada (no incluye sms) |
Ejemplo — overview
Sección titulada «Ejemplo — overview»/workspaces/:workspaceId/analytics/overviewParámetros de query
Sección titulada «Parámetros de query»| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
period | string | No | 7d | 30d | 90d. Por defecto 30d. |
Relacionado
Sección titulada «Relacionado»Databases (Waiify DB)
Sección titulada «Databases (Waiify DB)»Bases de datos propias, con tablas, columnas tipadas y filas — CRUD completo. Ver la referencia dedicada en Bases de datos (se abre en una pestaña nueva).
Widget de chat (público, sin API key)
Sección titulada «Widget de chat (público, sin API key)»El chat embebible tiene su propia autenticación por widgetToken — no cuelga de /workspaces/:workspaceId/ ni acepta tu API key. Ver Chat público (widget) (se abre en una pestaña nueva) para la referencia completa.
