New Evolution APIInstall

Summary

Execute management operations on EvoAI bots within a specific Evolution API instance, including creating, listing, fetching, updating, deleting bots, changing their status, and listing sessions.

Inputs

• Instance Name or ID (required) — Select or specify the Evolution API instance where the bot operations will be executed.
• Ação (Action) (required) — Select the EvoAI operation to perform: createBot, findBots, fetchBot, updateBot, deleteBot, changeStatus, or fetchSessions.
• ID Do Bot — Specify the bot's ID for operations that require identifying a specific bot (fetchBot, updateBot, deleteBot, changeStatus, fetchSessions).
• Ativado (Enabled) — Flag indicating whether the bot is enabled; applicable when creating or updating a bot.
• URL Do Agente (Agent URL) — The EvoAI agent URL for the bot; required when creating or updating a bot.
• API Key EvoAI — Optional API key for EvoAI authentication; used during bot creation or update.
• Tipo De Gatilho (Trigger Type) — Trigger type to start the bot, with options keyword, all, or none; used when creating or updating a bot.
• Operador Do Gatilho (Trigger Operator) — Operator to compare the trigger, applicable when creating or updating a bot; choices include contains, equals, startsWith, endsWith, regex.
• Valor Do Gatilho (Trigger Value) — Value to compare with the trigger; used during bot creation or update.
• Status Do Bot (Bot Status) — Set the bot's status to active or paused; applicable when changing the bot status.

Output shape

a JSON array containing the response data related to the selected action, such as bot details, lists of bots or sessions, success/failure confirmation for deletions or status changes.

The output varies with the operation selected; responses are JSON objects or arrays reflecting data from the Evolution API. For example, 'findBots' returns a list of bots, while 'createBot' or 'updateBot' returns the created or updated bot details. Required parameters depend on the action chosen.

Examples

Example 1: Create a new EvoAI bot

Set 'Instance Name or ID', select action '🤖 Criar Bot', provide 'URL Do Agente', optionally 'API Key EvoAI', set bot enabling and trigger settings.

Example 2: List all bots in an instance

Set 'Instance Name or ID', select action '📋 Listar Bots'; no bot ID needed.

Example 3: Fetch details of a specific bot

Set 'Instance Name or ID', select action '🔎 Buscar Bot', provide the relevant 'ID Do Bot'.