Ir al contenido

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.

Estos endpoints solo aceptan la sesión del dashboard, no una API key — son administración de la cuenta, no integración (ver qué acepta API key).

MétodoRutaDescripción
GET/membersListar miembros del workspace
POST/membersInvitar a un miembro
PATCH/members/:userId/roleCambiar el rol de un miembro
DELETE/members/:userIdQuitar un miembro

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.

GET /workspaces/:workspaceId/search
ParámetroTipoRequeridoDescripción
qstringTexto a buscar (1–120 caracteres).
typesstringNoLista 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.

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étodoRutaDescripción
GET/company-contextsListar contextos del workspace
GET/company-contexts/defaultObtener el contexto marcado como predeterminado
GET/company-contexts/:contextIdObtener un contexto
POST/company-contextsCrear un contexto
PUT/company-contexts/:contextIdActualizar un contexto
DELETE/company-contexts/:contextIdEliminar un contexto
POST/company-contexts/analyze-siteAnalizar un sitio web (sin crear ni guardar nada)
POST/company-contexts/:contextId/rescrapeVolver a analizar el sitio de un contexto existente
POST/company-contexts/:contextId/generate-promptGenerar el prompt de un asistente a partir del contexto
POST /workspaces/:workspaceId/company-contexts
CampoTipoRequeridoDescripción
namestringNombre/etiqueta del contexto guardado (máx. 200).
companyNamestringNoNombre real de la empresa. Si se omite, se rellena con name.
websiteUrlstringNoURL del sitio web (máx. 2000).
descriptionstringNoDescripción de la empresa (máx. 5000).
industrystringNoIndustria/rubro (máx. 200).
servicesstring[]NoLista de servicios (máx. 100 items).
businessHoursstringNoHorario de atención en texto libre (máx. 1000).
contactInfoobjectNoDatos de contacto libres (teléfono, dirección, etc.).
faqsobject[]NoPreguntas frecuentes: { question, answer } (máx. 100).
isDefaultbooleanNoMarca este contexto como el predeterminado del workspace.
autoScrapebooleanNoSi es true y hay websiteUrl, analiza el sitio al crear.

Suscribe un flow del Flow Studio a eventos del CRM (contacto creado, oportunidad movida de etapa, etc.), como alternativa a configurarlo desde el editor visual.

GET /workspaces/:workspaceId/crm-events/types

Lista los tipos de evento disponibles, con su etiqueta y si admiten condiciones de filtro.

MétodoRutaDescripción
GET/crm-events/typesListar tipos de evento disponibles
POST/crm-events/flows/:flowId/subscribeSuscribir un flow a un tipo de evento
DELETE/crm-events/flows/:flowId/subscribeDesuscribir un flow (vuelve a trigger manual)
POST /workspaces/:workspaceId/crm-events/flows/:flowId/subscribe
CampoTipoRequeridoDescripción
eventTypestringUno de los tipos listados en /crm-events/types.
pipelineIdstringDependeObligatorio para opportunity.created; opcional (filtra) para el resto de eventos de oportunidad.

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étodoRutaDescripción
GET/follow-up/sequencesListar secuencias (filtro opcional ?agentId=)
POST/follow-up/sequencesCrear una secuencia (con pasos opcionales)
GET/follow-up/sequences/:idObtener una secuencia con sus pasos
PATCH/follow-up/sequences/:idActualizar una secuencia
DELETE/follow-up/sequences/:idEliminar una secuencia
POST/follow-up/default-sequenceCrear la secuencia por defecto del workspace
POST/follow-up/sequences/:id/stepsAgregar un paso a una secuencia
PATCH/follow-up/sequences/:id/steps/:stepIdActualizar un paso
DELETE/follow-up/sequences/:id/steps/:stepIdEliminar un paso
POST /workspaces/:workspaceId/follow-up/sequences
CampoTipoRequeridoDescripción
namestringNombre de la secuencia (máx. 120).
agentIdstringNoAsistente al que aplica. Sin valor, aplica a todos.
isActivebooleanNoPor defecto true.
triggerOnstringNoCondición de disparo. Por defecto NO_RESPONSE.
maxAttemptsnumberNoTope de intentos (1–20).
reactivateAgentbooleanNoSi al responder el contacto se reactiva el asistente. Por defecto true.
stepsobject[]NoPasos iniciales — ver tabla debajo.

Cada paso (steps[] al crear, o el cuerpo de POST .../steps):

CampoTipoRequeridoDescripción
delayMinutesnumberMinutos de espera desde el paso anterior (mínimo 1).
stepTypestringNoTEXT | AI_GENERATED | PROMPT_TEMPLATE | WHATSAPP_TEMPLATE | FLOW. Por defecto TEXT.
messagestringDependeRequerido si stepType es TEXT (máx. 4096).
promptTemplatestringDependeRequerido si stepType es PROMPT_TEMPLATE (máx. 4096).
templateIdstringDependeRequerido si stepType es WHATSAPP_TEMPLATE; debe pertenecer al workspace.
flowIdstringDependeRequerido si stepType es FLOW; debe pertenecer al workspace.
stepNumbernumberNoOrden del paso. Si se omite, se calcula automáticamente.
MétodoRutaDescripción
GET/voice-agentsListar agentes de voz
POST/voice-agentsCrear agente de voz
GET/voice-agents/:idObtener
PATCH/voice-agents/:idActualizar
GET/voice-callsHistorial de llamadas
GET/voice-calls/:idDetalle de una llamada

Ver Agentes de voz.

Consumo de créditos 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étodoRutaDescripción
GET/usage/summaryResumen de consumo del período + estado del wallet
GET/usage/walletEstado actual del saldo (lectura rápida)
GET/usage/eventsHistorial paginado de eventos de consumo
GET /workspaces/:workspaceId/usage/summary
ParámetroTipoRequeridoDescripción
fromstring (ISO date)NoInicio del período. Por defecto, el 1º del mes calendario actual.
tostring (ISO date)NoFin del período. Por defecto, el último día del mes calendario actual.
GET /workspaces/:workspaceId/usage/events
ParámetroTipoRequeridoDescripción
pagenumberNoPágina (por defecto 1).
limitnumberNoTamaño de página, máx. 100 (por defecto 20).
eventTypestringNoFiltra por tipo (ai_call, voice_minute, whatsapp_message, sms_sent, email_sent, etc.).
sourcestringNowaiify o byok.
fromstring (ISO date)NoFecha inicial (createdAt >=).
tostring (ISO date)NoFecha final (createdAt <=).

Tarifas vigentes de consumo de créditos por tipo de evento, app y país. Es la única ruta pública sin autenticación de esta página — ni JWT ni API key: la consume el propio sitio de documentación en tiempo de build para que la tabla de precios nunca quede desactualizada. Nunca expone tarifas negociadas por cuenta, solo las tarifas base activas.

GET /credit-rates

Sin parámetros ni autenticación. Solo lectura, con rate limit de 30 solicitudes por minuto.

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étodoRutaDescripción
GET/analytics/overviewKPIs principales: contactos, conversaciones, mensajes, flows, agentes, citas
GET/analytics/conversationsConversaciones por estado/canal, timeline y tiempo de resolución
GET/analytics/leadsFunnel de contactos por estado, fuentes y timeline
GET/analytics/flowsEjecuciones de flows, tasa de éxito, top flows y duración
GET/analytics/agentsSesiones de asistentes, tool calls y top agentes
GET/analytics/smsCampañas de SMS: entregas, tasa de error, motivos de fallo
GET/analytics/dashboardoverview + conversations + leads + flows + agents en una sola llamada (no incluye sms)
GET /workspaces/:workspaceId/analytics/overview
ParámetroTipoRequeridoDescripción
periodstringNo7d | 30d | 90d. Por defecto 30d.

Bases de datos propias, con tablas, columnas tipadas y filas — CRUD completo. Ver la referencia dedicada en Bases de datos.

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) para la referencia completa.