Documentación
superleads.mx
Documentación › Referencia de la API › Conversation Ai

Conversation Ai

Referencia de la API · ☕ 9 min de lectura
Actualizado el 19 Jun 2026

Conversation AI API

Documentación de la API de AI Employees

Servidor base: https://services.leadconnectorhq.com

Endpoints

POST /conversation-ai/agents/{agentId}/actions

Attach Action to Agent Creates and attach a new action for an AI agent. Actions define specific tasks or behaviors that the agent can perform, such as booking appointments, sending follow-ups, or collecting information.

Scopes requeridos: conversation-ai.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) —

Cuerpo de la peticion (application/json): - type (requerido) — string - name (requerido) — string - details (requerido) — — Action-specific details. The structure depends on the action type. For TRIGGER_WORKFLOW use triggerWorkflowDto, for UPDATE_CONTACT_FIELD use updateContactFieldDto, for APPOINTMENT_BOOKING use appointmentBookingDto, for STOP_BOT use stopBotDto, for HUMAN_HAND_OVER use humanHandOverDto, for ADVANCED_FOLLOWUP use advancedFollowupDto, and for TRANSFER_BOT use transferBotDto.

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /conversation-ai/agents/{agentId}/actions/list

Listar Actions for an Agent List for actions for an agent

Scopes requeridos: conversation-ai.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) —

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /conversation-ai/agents/{agentId}/actions/{actionId}

Obtener Action by Id Retrieves detailed information about a specific action using its unique identifier. Returns the action configuration, associated agents, and performance metrics.

Scopes requeridos: conversation-ai.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - actionId (path, string) (requerido) — The unique identifier of the action Id Attached to the agent - agentId (path, string) (requerido) —

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /conversation-ai/agents/{agentId}/actions/{actionId}

Actualizar Action Updates an existing action's configuration. This includes modifying the action name, description, trigger conditions, and behavior settings.

Scopes requeridos: conversation-ai.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - actionId (path, string) (requerido) — The unique identifier of the action Id Attached to the agent - agentId (path, string) (requerido) —

Cuerpo de la peticion (application/json): - type (requerido) — string - name (requerido) — string - details (requerido) — — Action-specific details. The structure depends on the action type. For TRIGGER_WORKFLOW use triggerWorkflowDto, for UPDATE_CONTACT_FIELD use updateContactFieldDto, for APPOINTMENT_BOOKING use appointmentBookingDto, for STOP_BOT use stopBotDto, for HUMAN_HAND_OVER use humanHandOverDto, for ADVANCED_FOLLOWUP use advancedFollowupDto, and for TRANSFER_BOT use transferBotDto.

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /conversation-ai/agents/{agentId}/actions/{actionId}

Quitar Action from Agent Permanently deletes an action. This will remove the action from all associated agents and cannot be undone.

Scopes requeridos: conversation-ai.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - actionId (path, string) (requerido) — The unique identifier of the action Id Attached to the agent - agentId (path, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PATCH /conversation-ai/agents/{agentId}/followup-settings

Actualizar Followup Settings Update the followup settings for an action

Scopes requeridos: conversation-ai.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) —

Cuerpo de la peticion (application/json): - actionIds (requerido) — array - followupSettings (requerido) — - dynamicChannelSwitching (requerido) — boolean — Whether to dynamically switch channels for followups - followUpHours — boolean — Whether to respect working hours for followups - workingHours — array — Working hours configuration for followups - dayOfTheWeek (requerido) — number — Day of the week (0=Sunday, 1=Monday, etc.) - intervals — array — Time intervals for this day - startHour (requerido) — number — Start hour (24-hour format) - startMinute (requerido) — number — Start minute - endHour (requerido) — number — End hour (24-hour format) - endMinute (requerido) — number — End minute - timezoneToUse — string — Timezone to use for followups, contact or location

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /conversation-ai/agents

Crear an Agent Creates a new AI agent for the location. The agent will be created with the specified configuration including name, role, actions, and behavior settings.

Scopes requeridos: conversation-ai.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - name (requerido) — string — Name of the agent. - businessName — string — Name of the business the agent represents. - mode — string — Mode of operation - OFF, SUGGESTIVE, or AUTO_PILOT - channels — array — Communication channels the agent can operate on - isPrimary — boolean — Indicates if this agent is a primary agent. - waitTime — number — Wait time before agent responds (max 5 for minutes, 300 for seconds) - waitTimeUnit — string — Unit for wait time - SECONDS or MINUTES - sleepEnabled — boolean — Indicates if sleep functionality is enabled. - sleepTime — number — Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours) - sleepTimeUnit — string — Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set to null for indefinite sleep. - personality (requerido) — string — Personality traits of the agent. - goal (requerido) — string — The goal of the agent. - instructions (requerido) — string — Instructions for the agent. - autoPilotMaxMessages — number — Maximum number of messages in auto-pilot mode before requiring human intervention. (max: 100, min: 1) - knowledgeBaseIds — array — Array of knowledge base IDs associated with this agent. - respondToImages — boolean — Allow agent to respond to images - respondToAudio — boolean — Allow agent to respond to audio - sleepOnManualMessage — boolean — Enable sleep when a manual outbound message is sent. - sleepOnWorkflowMessage — boolean — Enable sleep when a workflow outbound message is sent.

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /conversation-ai/agents/search

Buscar agentes Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities.

Scopes requeridos: conversation-ai.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - startAfter (query, string) — Start after is the agent id to start after, Serving as skip, send empty when first page - limit (query, number) — Records per page - query (query, string) — query to search on agent name, must be provided in lowercase

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /conversation-ai/agents/{agentId}

Actualizar agente Updates an existing AI agent's configuration. All fields in the agent configuration can be updated including name, status, actions, and behavior settings.

Scopes requeridos: conversation-ai.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) — Id de Conversations AI agent

Cuerpo de la peticion (application/json): - name — string — Name of the agent. - businessName — string — Name of the business the agent represents. - mode — string — Mode of operation for the agent, required if primary is enabled. - channels — array — Channels the agent can use. - isPrimary — boolean — Indicates if this agent is a primary agent. - waitTime — number — Wait time before agent responds (max 5 for minutes, 300 for seconds). - waitTimeUnit — string — Unit for wait time - SECONDS or MINUTES - sleepEnabled — boolean — Indicates if sleep functionality is enabled. - sleepTime — number — Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours) - sleepTimeUnit — string — Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set to null for indefinite sleep. - personality — string — Personality traits of the agent. - goal — string — The goal of the agent. - instructions — string — Instructions for the agent. - autoPilotMaxMessages (requerido) — number — Maximum number of messages in auto-pilot mode before requiring human intervention. (max: 100, min: 1) - knowledgeBaseIds — array — Array of knowledge base IDs associated with this agent. - respondToImages — boolean — Allow agent to respond to images - respondToAudio — boolean — Allow agent to respond to audio - sleepOnManualMessage — boolean — Enable sleep when a manual outbound message is sent. - sleepOnWorkflowMessage — boolean — Enable sleep when a workflow outbound message is sent.

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /conversation-ai/agents/{agentId}

Obtener agente Retrieves a specific AI agent by its Id. Returns the complete agent configuration including name, status, actions, and settings.

Scopes requeridos: conversation-ai.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) — Id de Conversations AI agent

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /conversation-ai/agents/{agentId}

Eliminar agente Deletes an AI agent permanently. This action cannot be undone. All associated configurations and conversation history will be removed.

Scopes requeridos: conversation-ai.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) — Id de Conversations AI agent

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /conversation-ai/generations

Obtener the generation details Retrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks, and Rich Text chunks.

Scopes requeridos: conversation-ai.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - messageId (query, string) (requerido) — Id de mensaje - source (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar