MCP operation catalog
Every expected Zild MCP operation, analyzed from OpenAPI, with methods, routes, tool names and contracts.
Publication criteria and analyzed scope
This catalog was generated from OpenAPI 3.0.4, API v1, bundled with this site: 137 operations and 79 routes. A running MCP server generates tools from its environment's Swagger v1; version differences can change the catalog.
The adapter processes GET, POST, PUT, PATCH, DELETE, HEAD and OPTIONS. This document contains only GET, POST, PUT and DELETE. There is no additional read-only publication list: every operation in the final OpenAPI document becomes a tool. Controllers and actions hidden by IgnoreApi and /api/ aliases removed by the Swagger filter are absent from that document.
Names below follow the adapter convention: method and normalized route, followed by the first 12 characters of the SHA-256 hash of “METHOD /route”. Confirm the name and inputSchema through tools/list in the connected environment.
HTTP method distribution
| Method | Operations |
|---|---|
| GET | 51 |
| POST | 42 |
| PUT | 22 |
| DELETE | 22 |
Available areas
| Area | Operations | Capabilities |
|---|---|---|
| CRM | 11 | Accounts and contacts: lists, lookup by ID, contacts by account, creation, updates and deletion. |
| Agents | 40 | Agents, knowledge, skills, tools, dynamic variables, data collection, files, links, conversations, execution and history with rollback. |
| Voice | 8 | Individual and batch phone calls, calls to users, voices, ElevenLabs models and voice tool references. |
| Insight | 12 | Checklists and items, conversation reevaluation, audio imports and Microsoft Teams imports. |
| Assist | 8 | Email processing, proactive WhatsApp conversations, templates and approval checks. |
| Conversations and messages | 9 | Paginated conversations, lookup by ID, exports, messages, updates, resending and marking as read. |
| Documents | 6 | Paginated documents, dashboard, lookup by ID, creation with a file, deletion and reprocessing. |
| Flow | 24 | Flows and dashboard; recurring tasks and occurrences; stages, tasks and task history, through the published methods. |
| Agent MCP connections | 6 | Agent connector associations, enablement, allowed tools and tool discovery from external MCP servers. |
| Departments and quotas | 7 | Department records and membership; department and tenant consumption and quota queries. |
| Consumption | 1 | Filtered consumption dashboard queries; POST does not record consumption or change quotas. |
| Webhooks | 5 | Listing, lookup, creation and updates of webhooks. The published DELETE route currently does not delete the record. |
Queries, writes and external effects
The HTTP method alone does not determine a tool’s effect. POST /AgentHistory/filter queries filtered history, while POST /AgentHistory/rollback reverts an agent. GETs are presented as queries by the contract; other methods need to be evaluated using their descriptions and API behavior.
The catalog includes deletion of accounts, contacts, agents, knowledge, skills, documents and other records. It also includes POST /Agent/run, individual and batch calls, proactive WhatsApp conversations, email processing, message resending and document reprocessing. These actions may run agents, change data, incur usage or initiate communications.
This version does not filter the catalog by individual permissions. The API checks authorization during execution. Clients should evaluate effects before calling write tools and check the outcome before repeating a call with an uncertain result.
Description quality and coverage
All 137 analyzed operations have a summary and description. Updated explanations for Flow, consumption, departments, MCP connections and webhooks are available to the tools. MCP reuses these texts in tool titles and descriptions, keeping method and route as fallback identifiers. Detailed source descriptions are available in the tables below.
Inherited Flow CRUD now has resource-specific descriptions and response schemas, including no-content success (204) and record not found (404) where defined by the contract. Text improvements preserve MCP names because they depend only on method and route.
This OpenAPI does not include the simple GET /Conversation list, PUT /Document/{id}, UserTask routes or AgentModelPolicy operations. POST /Agent/run is published with multipart/form-data.
Behavior clarified in the updated contract
- Flow: PUT /FlowTask/{id} may move a task to another stage and schedule its assigned agent. In that case, other submitted fields are not updated. Creating task history does not move the task or run agents.
- Recurrence: creating a rule does not immediately generate tasks. Occurrence queries only predict upcoming UTC dates; count defaults to 50 and is clamped to 1–200.
- Consumption: POST /ConsumptionDashboard is a filtered query, without recording usage or changing quotas. GET /SubscriptionConsumption is absent from the updated contract.
- Departments: updates replace the membership list. A null quota means unlimited and zero blocks usage. Deletion is rejected while agents remain linked.
- MCP connections: manage Zild agents’ access to external connectors. An empty AllowedTools list grants no tools; discovery queries the external server without executing tools or automatically authorizing their use. These operations differ from an external agent connecting to the Zild MCP Server.
- Webhooks: creating or updating configurations does not send a test notification. DELETE /Webhook/{id} is published but currently responds without deleting or changing the webhook; its response does not prove removal.
CRM (11)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
GET /Account | List accountsAPI description (source language)Este endpoint retorna todas as contas cadastradas. | zild_get_account_b6ca3624bad1 |
POST /Account | Create accountAPI description (source language)Este endpoint cria uma nova conta com os dados fornecidos no corpo da requisição. | zild_post_account_a73ca3c8d4fa |
GET /Account/{id} | Get accountAPI description (source language)Este endpoint retorna os detalhes de uma conta especificada pelo identificador. | zild_get_account_id_d5e47e76665c |
PUT /Account/{id} | Update accountAPI description (source language)Este endpoint atualiza os dados de uma conta existente identificada pelo id. | zild_put_account_id_80c250b0cfd5 |
DELETE /Account/{id} | Delete accountAPI description (source language)Este endpoint deleta uma conta existente identificada pelo id. | zild_delete_account_id_204d8590f9b6 |
GET /Contact | List contactsAPI description (source language)Este endpoint retorna todos os contatos cadastrados. | zild_get_contact_f2bb51fbfdc0 |
POST /Contact | Create contactAPI description (source language)Este endpoint cria um novo contato com os dados fornecidos no corpo da requisição. | zild_post_contact_2e9539ad6c8a |
GET /Contact/GetByAccountId/{accountId} | List contacts by accountAPI description (source language)Este endpoint retorna todos os contatos vinculados a uma conta específica. | zild_get_contact_getbyaccountid_accountid_202dfb40f8d2 |
GET /Contact/{id} | Get contactAPI description (source language)Este endpoint retorna os detalhes de um contato especificado pelo identificador. | zild_get_contact_id_80e630e9c3e2 |
PUT /Contact/{id} | Update contactAPI description (source language)Este endpoint atualiza os dados de um contato existente identificado pelo id. | zild_put_contact_id_3f939fb12ff8 |
DELETE /Contact/{id} | Delete contactAPI description (source language)Este endpoint exclui um contato existente identificado pelo id. | zild_delete_contact_id_a7fbdb2dcdd6 |
Agents (40)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
GET /Agent | List agentsAPI description (source language)This endpoint returns all registered agents. | zild_get_agent_e8da87db4e1e |
POST /Agent | Create agentAPI description (source language)This endpoint creates an agent. | zild_post_agent_76c52a0e94de |
POST /Agent/conversation | Create agent conversationAPI description (source language)This endpoint creates a new conversation between a user and the agent. | zild_post_agent_conversation_741a48920bd0 |
POST /Agent/file | Attach file to agentAPI description (source language)This endpoint adds a file to the specified agent. | zild_post_agent_file_a4068926a82e |
DELETE /Agent/file | Remove file from agentAPI description (source language)This endpoint removes a file previously attached to the agent. | zild_delete_agent_file_ada1d1fb917c |
POST /Agent/run | Run agentAPI description (source language)This endpoint runs the agent with the provided input message. | zild_post_agent_run_7a8bef807cdd |
POST /Agent/web-link | Add web knowledge to agentAPI description (source language)This endpoint fetches the content of a web page and adds it as knowledge to the agent. | zild_post_agent_web_link_ac9b6b9afae1 |
PUT /Agent/web-link | Update agent web knowledgeAPI description (source language)This endpoint removes the old web page content and fetches the updated content, replacing it in the agent's knowledge. | zild_put_agent_web_link_fd9708c20763 |
GET /Agent/{id} | Get agentAPI description (source language)This endpoint returns the details of an agent specified by the identifier. | zild_get_agent_id_28a7bbddfe13 |
PUT /Agent/{id} | Update agentAPI description (source language)This endpoint updates the agent. | zild_put_agent_id_c288777250f2 |
DELETE /Agent/{id} | Delete agentAPI description (source language)This endpoint deletes an existing agent identified by id, including removal of the agent from the ElevenLabs service. | zild_delete_agent_id_f3dd798ddd9d |
POST /Agent/{id}/logo-icon | Upload agent logoAPI description (source language)This endpoint uploads a logo/icon image for the specified agent. | zild_post_agent_id_logo_icon_21edf2bd8222 |
DELETE /Agent/{id}/logo-icon | Remove agent logoAPI description (source language)This endpoint removes the logo/icon image of the specified agent. | zild_delete_agent_id_logo_icon_f4bbf4622b43 |
POST /AgentDataCollection | Create agent data collection variableAPI description (source language)Este endpoint cria uma nova variável de coleta de dados de agente com os dados fornecidos. | zild_post_agentdatacollection_8442b85a42d5 |
GET /AgentDataCollection/{id} | Get agent data collection variableAPI description (source language)Este endpoint retorna os detalhes de uma variável de coleta de dados de agente especificada pelo identificador. | zild_get_agentdatacollection_id_34d426026a20 |
PUT /AgentDataCollection/{id} | Update agent data collection variableAPI description (source language)Este endpoint atualiza os dados de uma variável de coleta de dados de agente existente identificada pelo id. | zild_put_agentdatacollection_id_4ca4558e2fa2 |
DELETE /AgentDataCollection/{id} | Delete agent data collection variableAPI description (source language)Este endpoint remove uma variável de coleta de dados de agente existente identificada pelo id. | zild_delete_agentdatacollection_id_b55d01d6f756 |
POST /AgentDynamicVariable | Create agent dynamic variableAPI description (source language)Este endpoint cria uma nova variável dinâmica de agente com os dados fornecidos. | zild_post_agentdynamicvariable_0c479b53adbb |
GET /AgentDynamicVariable/{id} | Get agent dynamic variableAPI description (source language)Este endpoint retorna os detalhes de uma variável dinâmica de agente especificada pelo identificador. | zild_get_agentdynamicvariable_id_d0dc10777c11 |
PUT /AgentDynamicVariable/{id} | Update agent dynamic variableAPI description (source language)Este endpoint atualiza os dados de uma variável dinâmica de agente existente identificada pelo id. | zild_put_agentdynamicvariable_id_378fc780072e |
DELETE /AgentDynamicVariable/{id} | Delete agent dynamic variableAPI description (source language)Este endpoint remove uma variável dinâmica de agente existente identificada pelo id. | zild_delete_agentdynamicvariable_id_4736eff3dc1f |
GET /AgentHistory/agent/{agentId}/version/{version} | Get a specific agent versionAPI description (source language)Este endpoint retorna o estado do agente em uma versão específica. | zild_get_agenthistory_agent_agentid_version_version_02ff2fcb9306 |
POST /AgentHistory/filter | Filter agent historyAPI description (source language)Este endpoint permite filtrar o histórico por agente (obrigatório), usuário, tipo de ação e período. Suporta paginação. | zild_post_agenthistory_filter_79d1493ca742 |
POST /AgentHistory/rollback | Restore an agent versionAPI description (source language)Este endpoint reverte o agente para o estado de uma versão específica. | zild_post_agenthistory_rollback_a43a610e7e84 |
GET /AgentHistory/{id} | Get agent history recordAPI description (source language)Este endpoint retorna os detalhes de um registro de histórico específico. | zild_get_agenthistory_id_872a6efee8bf |
GET /AgentTool | List agent toolsAPI description (source language)Este endpoint retorna todas as ferramentas de um Agente de IA pelo identificador do Agente de IA. | zild_get_agenttool_782c31184b2e |
POST /AgentTool | Create agent toolAPI description (source language)Este endpoint cria uma nova ferramenta de agente com os dados fornecidos. | zild_post_agenttool_2999969ce386 |
GET /AgentTool/{id} | Get agent toolAPI description (source language)Este endpoint retorna os detalhes de uma ferramenta de agente especificada pelo identificador. | zild_get_agenttool_id_bf409ee13b10 |
PUT /AgentTool/{id} | Update agent toolAPI description (source language)Este endpoint atualiza os dados de uma ferramenta de agente existente identificada pelo id. | zild_put_agenttool_id_829d0f81df35 |
DELETE /AgentTool/{id} | Delete agent toolAPI description (source language)Este endpoint remove uma ferramenta de agente existente identificada pelo id. | zild_delete_agenttool_id_c77127694d7f |
GET /Knowledge | List knowledge sourcesAPI description (source language)Este endpoint retorna todos os conhecimentos de agente cadastrados. | zild_get_knowledge_edf5231cdb00 |
POST /Knowledge | Create knowledge sourceAPI description (source language)Este endpoint cria um novo conhecimento de agente com os dados fornecidos. | zild_post_knowledge_5157806c8d4b |
GET /Knowledge/{id} | Get knowledge sourceAPI description (source language)Este endpoint retorna os detalhes de um conhecimento de agente especificado pelo identificador. | zild_get_knowledge_id_38263d11e5b5 |
PUT /Knowledge/{id} | Update knowledge sourceAPI description (source language)Este endpoint atualiza os dados de um conhecimento de agente existente identificado pelo id. | zild_put_knowledge_id_0281d0a89020 |
DELETE /Knowledge/{id} | Delete knowledge sourceAPI description (source language)Este endpoint remove um conhecimento de agente existente identificado pelo id. | zild_delete_knowledge_id_89360176d8fb |
GET /Skill | List skillsAPI description (source language)Este endpoint retorna as skills do tenant e as skills globais habilitadas. | zild_get_skill_a0e49fd5d860 |
POST /Skill | Create skillAPI description (source language)Este endpoint cria uma nova skill para o tenant atual. | zild_post_skill_0713798a9d8e |
GET /Skill/{id} | Get skillAPI description (source language)Este endpoint retorna os detalhes de uma skill especificada pelo identificador. | zild_get_skill_id_dcc59e89d18c |
PUT /Skill/{id} | Update skillAPI description (source language)Este endpoint atualiza uma skill do tenant atual. | zild_put_skill_id_b44b2e0a722a |
DELETE /Skill/{id} | Delete skillAPI description (source language)Este endpoint remove uma skill do tenant atual. | zild_delete_skill_id_97756762ea5e |
Voice (8)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
POST /Agent/create-batch-call | Create batch callsAPI description (source language)This endpoint creates multiple batch phone calls for an ElevenLabs agent. | zild_post_agent_create_batch_call_47019dde720e |
POST /Agent/create-phone-call | Create phone callAPI description (source language)This endpoint creates a phone call for an ElevenLabs agent. | zild_post_agent_create_phone_call_016b07989851 |
GET /Agent/elevenlabs-llms | List ElevenLabs modelsAPI description (source language)This endpoint returns the available ElevenLabs LLM models and safe capabilities for use with agents. | zild_get_agent_elevenlabs_llms_e8a97b6a9c1a |
GET /Agent/voice | List available voicesAPI description (source language)This endpoint returns the available voices from a specific provider (ElevenLabs) for use with agents. | zild_get_agent_voice_dc6eb2b3c727 |
GET /Agent/voice-tools | List voice toolsAPI description (source language)Lists ElevenLabs tools referenced by the tenant. When agentId is greater than zero, also includes tools currently assigned to that ElevenLabs agent after checking view permission. Fetches tool details from ElevenLabs and returns them sorted by name; it does not execute tools. | zild_get_agent_voice_tools_db8d77c2d139 |
POST /Agent/voice-tools | Reference a voice toolAPI description (source language)Registers a tenant reference to an existing custom ElevenLabs tool. ToolId must match tool_ followed by letters or digits, and the tool must exist in the configured ElevenLabs account. System tools cannot be referenced. This operation does not create or execute the external tool and does not duplicate an existing reference. | zild_post_agent_voice_tools_9dfb174a1297 |
DELETE /Agent/voice-tools/{toolId} | Remove voice tool referenceAPI description (source language)Removes the tenant reference to the specified ElevenLabs tool after checking edit permission using agentId. This removes the reference stored in the connector; it does not delete the external tool or change the tools configured on the ElevenLabs agent. | zild_delete_agent_voice_tools_toolid_12ad2ce67a14 |
POST /Conversation/create-phone-call-to-user | Connect phone call to userAPI description (source language)Este endpoint cria uma ligação telefônica para um usuário interno e conecta com o cliente. | zild_post_conversation_create_phone_call_to_user_1bce95be18d5 |
Insight (12)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
GET /Checklist | List checklistsAPI description (source language)Este endpoint retorna todos os checklists cadastrados. | zild_get_checklist_3746e42fc684 |
POST /Checklist | Create checklistAPI description (source language)Este endpoint cria um novo checklist com os dados fornecidos. | zild_post_checklist_a430b4271aaa |
GET /Checklist/{id} | Get checklistAPI description (source language)Este endpoint retorna os detalhes de um checklist especificado pelo identificador. | zild_get_checklist_id_5c69f4f7ae5c |
PUT /Checklist/{id} | Update checklistAPI description (source language)Este endpoint atualiza os dados de um checklist existente identificado pelo id. | zild_put_checklist_id_66bd7e5ebc5e |
GET /ChecklistItem | List checklist itemsAPI description (source language)Este endpoint retorna os itens de um checklist específico. | zild_get_checklistitem_c37c1db2ddf1 |
POST /ChecklistItem | Create checklist itemAPI description (source language)Este endpoint cria um novo item de checklist com os dados fornecidos. | zild_post_checklistitem_8b86e2e97c31 |
GET /ChecklistItem/{id} | Get checklist itemAPI description (source language)Este endpoint retorna os detalhes de um item de checklist especificado pelo identificador. | zild_get_checklistitem_id_cc26b8f6ee14 |
PUT /ChecklistItem/{id} | Update checklist itemAPI description (source language)Este endpoint atualiza os dados de um item de checklist existente identificado pelo id. | zild_put_checklistitem_id_65b9c680cc19 |
DELETE /ChecklistItem/{id} | Delete checklist itemAPI description (source language)Este endpoint deleta um item de checklist. Só é possível deletar se o item não estiver vinculado a nenhuma conversa. | zild_delete_checklistitem_id_93f545623262 |
POST /Conversation/reevaluate | Reevaluate conversation checklistAPI description (source language)Este endpoint dispara a reavaliação do checklist de uma ou mais conversas. | zild_post_conversation_reevaluate_dda3800e6e85 |
POST /Insight/audio | Import audio for InsightAPI description (source language)Este endpoint cria uma conversa a partir de um arquivo de audio e metadados. | zild_post_insight_audio_28eeb9723766 |
POST /Insight/import-ms-teams | Import Microsoft Teams conversationsAPI description (source language)Este endpoint importa conversas originadas do Microsoft Teams. | zild_post_insight_import_ms_teams_8e5a295feb9a |
Assist (8)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
POST /Conversation/email | Process inbound emailAPI description (source language)Este endpoint recebe e e-mails e envia para o Agente de IA responder. | zild_post_conversation_email_e7e79d806db1 |
POST /Conversation/whatsapp-proactive-conversation | Create proactive WhatsApp conversationAPI description (source language)Este endpoint cria uma conversa proativa com os dados fornecidos. | zild_post_conversation_whatsapp_proactive_conversation_31db3875643e |
GET /ConversationTemplate | List conversation templatesAPI description (source language)Este endpoint retorna templates de conversa conforme os filtros informados. | zild_get_conversationtemplate_84bbce40064c |
POST /ConversationTemplate | Create conversation templateAPI description (source language)Este endpoint cria um novo template de conversa com os dados fornecidos. | zild_post_conversationtemplate_2db9c29b2e15 |
GET /ConversationTemplate/{id} | Get conversation templateAPI description (source language)Este endpoint retorna os detalhes de um template de conversa especificado pelo identificador. | zild_get_conversationtemplate_id_81a744baeb1f |
PUT /ConversationTemplate/{id} | Update conversation templateAPI description (source language)Este endpoint atualiza os dados de um template de conversa existente identificado pelo id. | zild_put_conversationtemplate_id_86000cb2a10c |
DELETE /ConversationTemplate/{id} | Delete conversation templateAPI description (source language)Este endpoint deleta template de WhatsApp. | zild_delete_conversationtemplate_id_78c6d16c4f7e |
POST /ConversationTemplate/{id}/check-approval | Check template approvalAPI description (source language)Este endpoint dispara uma verificação manual do status de aprovação do template de conversa no provedor. | zild_post_conversationtemplate_id_check_approval_6108a4e38afc |
Conversations and messages (9)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
POST /Conversation/export | Export conversationsAPI description (source language)Este endpoint retorna todas as conversas que atendem ao filtro informado, com itens de checklist opcionais. | zild_post_conversation_export_83914eb76ba2 |
GET /Conversation/paged | List paginated conversationsAPI description (source language)Este endpoint retorna as conversas paginadas conforme o filtro informado. | zild_get_conversation_paged_8777cc7449d2 |
GET /Conversation/{id} | Get conversationAPI description (source language)Este endpoint retorna os detalhes de uma conversa especificada pelo identificador. | zild_get_conversation_id_499ae9457461 |
GET /Message | List messages by conversationAPI description (source language)Este endpoint retorna as mensagens de uma conversa especificada pelo identificador da conversa. | zild_get_message_f14013758dfb |
POST /Message | Create messageAPI description (source language)Este endpoint cria uma nova mensagem, opcionalmente com arquivo, para uma conversa. | zild_post_message_dd1c2cb71f86 |
POST /Message/resend | Resend messageAPI description (source language)Este endpoint reenvia uma mensagem já existente pelo seu identificador. | zild_post_message_resend_11e4db8122c8 |
GET /Message/{id} | Get messageAPI description (source language)Este endpoint retorna os detalhes de uma mensagem especificada pelo identificador. | zild_get_message_id_e2575153d29b |
PUT /Message/{id} | Update messageAPI description (source language)Este endpoint atualiza os dados de uma mensagem existente identificada pelo id. | zild_put_message_id_19b6e597d699 |
PUT /Message/{messageId}/read | Mark message as readAPI description (source language)Este endpoint marca uma mensagem específica como lida pelo usuário. | zild_put_message_messageid_read_6b89be4f8644 |
Documents (6)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
POST /Document | Create documentAPI description (source language)Este endpoint cria um novo documento, opcionalmente com arquivo, com os dados fornecidos. | zild_post_document_550502414b9f |
GET /Document/dashboard | Get document dashboardAPI description (source language)Este endpoint retorna informações resumidas e estatísticas dos documentos para exibição em dashboard. Permite filtrar por período (createdAtStart e createdAtEnd). | zild_get_document_dashboard_947fd643a756 |
GET /Document/paged | List paginated documentsAPI description (source language)Este endpoint retorna documentos paginados conforme o filtro informado. | zild_get_document_paged_090de02b746f |
GET /Document/{id} | Get documentAPI description (source language)Este endpoint retorna os detalhes de um documento especificado pelo identificador. | zild_get_document_id_a13894680bb2 |
DELETE /Document/{id} | Delete documentAPI description (source language)Este endpoint remove um documento existente identificado pelo id. | zild_delete_document_id_5ecae91db708 |
POST /Document/{id}/reprocess | Reprocess documentAPI description (source language)Este endpoint reprocessa um documento existente identificado pelo id. | zild_post_document_id_reprocess_1470ac0c91a9 |
Flow (24)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
GET /Flow | List flowsAPI description (source language)Retorna a lista de fluxos do tenant do usuário autenticado. | zild_get_flow_96ec9435526f |
POST /Flow | Create flowAPI description (source language)Cria um registro de fluxo com os dados do corpo da requisição e retorna o registro criado. | zild_post_flow_1c87790c6811 |
GET /Flow/dashboard | Get Flow dashboardAPI description (source language)Retorna os totais dos fluxos com tarefas que atendem aos filtros, tarefas por status e tarefas com participação de usuários ou agentes registrada no histórico. Permite filtrar por fluxo, status e intervalos inclusivos de criação e conclusão. Agrupa os períodos pela data de criação das tarefas, por dia ou mês; o padrão é dia. Uma tarefa pode ser contada tanto na participação humana quanto na de IA. Não altera tarefas nem executa agentes. | zild_get_flow_dashboard_2bd2884833bd |
GET /Flow/{id} | Get flowAPI description (source language)Retorna os dados de fluxo identificado por id no tenant do usuário autenticado. Retorna 404 quando o registro não é encontrado. | zild_get_flow_id_20b7d8a0b4cb |
PUT /Flow/{id} | Update flowAPI description (source language)Atualiza os dados de fluxo identificado por id usando o corpo da requisição. Retorna 204 sem conteúdo. | zild_put_flow_id_f734ee12eaf9 |
DELETE /Flow/{id} | Delete flowAPI description (source language)Exclui o registro de fluxo identificado por id. Retorna 204 sem conteúdo. | zild_delete_flow_id_e2092f067f1d |
GET /FlowRecurringTask | List recurring tasksAPI description (source language)Retorna a lista de recorrências de tarefas do tenant do usuário autenticado. | zild_get_flowrecurringtask_697550d65a44 |
POST /FlowRecurringTask | Create recurring taskAPI description (source language)Cadastra uma regra de geração recorrente de tarefas para um fluxo e uma raia do mesmo tenant. Informe título, padrão, intervalo, data e horário locais, fuso horário e limite da recorrência. Valida a regra e calcula a primeira ocorrência em UTC; esta requisição cadastra a recorrência, sem gerar tarefas imediatamente. | zild_post_flowrecurringtask_8810293f9983 |
GET /FlowRecurringTask/{id} | Get recurring taskAPI description (source language)Retorna os dados de recorrência de tarefas identificado por id no tenant do usuário autenticado. Retorna 404 quando o registro não é encontrado. | zild_get_flowrecurringtask_id_43d0afac3c48 |
PUT /FlowRecurringTask/{id} | Update recurring taskAPI description (source language)Atualiza a regra de recorrência identificada por id e recalcula a próxima ocorrência em UTC. Preserva a quantidade de ocorrências já geradas e a última ocorrência. Informe os dados completos da regra; o fluxo e a raia devem pertencer ao mesmo tenant e a raia ao fluxo selecionado. | zild_put_flowrecurringtask_id_3ff560e8c0df |
DELETE /FlowRecurringTask/{id} | Delete recurring taskAPI description (source language)Exclui o registro de recorrência de tarefas identificado por id. Retorna 204 sem conteúdo. | zild_delete_flowrecurringtask_id_84b453427dbc |
GET /FlowRecurringTask/{id}/occurrences | List recurring task occurrencesAPI description (source language)Retorna a previsão das próximas ocorrências, considerando exceções ainda não processadas, reagendamentos e cancelamentos. Os horários original e agendado são retornados em UTC, ordenados pelo horário agendado. O parâmetro count tem padrão 50 e é ajustado ao intervalo de 1 a 200. A consulta não gera tarefas nem executa agentes. | zild_get_flowrecurringtask_id_occurrences_7b9cfd2c5eed |
POST /FlowStage | Create flow stageAPI description (source language)Cadastra uma raia vinculada a um fluxo, com nome, ordem, responsáveis, sinalizadores de início e fim, cor e limite de tarefas em andamento (WipLimit). | zild_post_flowstage_934c823962a8 |
GET /FlowStage/{id} | Get flow stageAPI description (source language)Retorna os dados de raia de fluxo identificado por id no tenant do usuário autenticado. Retorna 404 quando o registro não é encontrado. | zild_get_flowstage_id_8bfd64888c75 |
PUT /FlowStage/{id} | Update flow stageAPI description (source language)Atualiza os dados da raia identificada por id. Informe o fluxo, nome, ordem, responsáveis e demais configurações no corpo da requisição. | zild_put_flowstage_id_4082b0d7d100 |
DELETE /FlowStage/{id} | Delete flow stageAPI description (source language)Exclui o registro de raia de fluxo identificado por id. Retorna 204 sem conteúdo. | zild_delete_flowstage_id_c30ed03e7b3d |
POST /FlowTask | Create flow taskAPI description (source language)Cadastra uma tarefa vinculada a um fluxo e uma raia, com título, descrição, status, prioridade, payload e prazo informados no corpo da requisição. | zild_post_flowtask_c6a8b9e48578 |
GET /FlowTask/{id} | Get flow taskAPI description (source language)Retorna os dados de tarefa de fluxo identificado por id no tenant do usuário autenticado. Retorna 404 quando o registro não é encontrado. | zild_get_flowtask_id_0715b21cc925 |
PUT /FlowTask/{id} | Update flow taskAPI description (source language)Atualiza a tarefa identificada por id. Se CurrentFlowStageId mudar, a operação move a tarefa para a raia de destino e pode agendar a execução do agente responsável por essa raia; nesse caso, os demais campos enviados não são atualizados por esta operação. Sem mudança de raia, atualiza os dados da tarefa pelo comportamento de atualização comum. A movimentação pode produzir efeitos externos pela execução do agente. | zild_put_flowtask_id_4536d5c7b0aa |
DELETE /FlowTask/{id} | Delete flow taskAPI description (source language)Exclui o registro de tarefa de fluxo identificado por id. Retorna 204 sem conteúdo. | zild_delete_flowtask_id_8cd5dc4068f6 |
POST /FlowTaskHistory | Create task historyAPI description (source language)Cadastra um registro de histórico vinculado a uma tarefa, com tipo de evento, raias de origem e destino, usuário ou agente, descrição e payload informados. O registro documenta um evento; esta operação não movimenta a tarefa nem executa agentes. | zild_post_flowtaskhistory_81d057ceac6f |
GET /FlowTaskHistory/{id} | Get task historyAPI description (source language)Retorna os dados de registro de histórico de tarefa identificado por id no tenant do usuário autenticado. Retorna 404 quando o registro não é encontrado. | zild_get_flowtaskhistory_id_282c16297ad2 |
PUT /FlowTaskHistory/{id} | Update task historyAPI description (source language)Atualiza os dados de registro de histórico de tarefa identificado por id usando o corpo da requisição. Retorna 204 sem conteúdo. | zild_put_flowtaskhistory_id_af5da4c9308d |
DELETE /FlowTaskHistory/{id} | Delete task historyAPI description (source language)Exclui o registro de registro de histórico de tarefa identificado por id. Retorna 204 sem conteúdo. | zild_delete_flowtaskhistory_id_b73af511b1da |
Agent MCP connections (6)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
GET /AgentMcpConnection | List agent MCP connectionsAPI description (source language)Retorna as associações entre o agente informado e conectores MCP do tenant, incluindo o estado de habilitação e os nomes das ferramentas permitidas. Requer ViewAgents. | zild_get_agentmcpconnection_b356afd8674a |
POST /AgentMcpConnection | Create agent MCP connectionAPI description (source language)Cria uma associação entre agente e conector MCP do mesmo tenant. Informe Enabled e a lista AllowedTools; uma lista vazia não libera ferramentas. Não permite duplicar o mesmo conector para um agente. Requer UpdateAgent e ViewConnectors. | zild_post_agentmcpconnection_ac7fe73e787f |
GET /AgentMcpConnection/connectors/{connectorId}/tools | Discover connector MCP toolsAPI description (source language)Conecta ao servidor MCP configurado no conector do tenant e consulta os nomes, descrições e schemas das ferramentas disponíveis. Faz uma chamada ao servidor externo, mas não executa as ferramentas nem as autoriza automaticamente para um agente. Requer ViewConnectors. | zild_get_agentmcpconnection_connectors_connectorid_tools_87051518c2cc |
GET /AgentMcpConnection/{id} | Get agent MCP connectionAPI description (source language)Retorna os dados e as ferramentas permitidas da associação MCP identificada por id no tenant autenticado. Requer ViewAgents. | zild_get_agentmcpconnection_id_bb6fdcef3ddb |
PUT /AgentMcpConnection/{id} | Update agent MCP connectionAPI description (source language)Atualiza Enabled e substitui a lista AllowedTools da associação. AgentId e ConnectorId devem permanecer iguais aos da associação existente; para trocar o agente ou conector, crie outra associação. Requer UpdateAgent e ViewConnectors. | zild_put_agentmcpconnection_id_1f68ed912428 |
DELETE /AgentMcpConnection/{id} | Delete agent MCP connectionAPI description (source language)Exclui a associação MCP identificada por id, revogando seu uso pelo agente. Não exclui o agente nem o conector. Requer UpdateAgent. | zild_delete_agentmcpconnection_id_148a971c1d08 |
Departments and quotas (7)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
GET /Department | List departmentsAPI description (source language)Retorna os departamentos do tenant do usuário autenticado. | zild_get_department_a3e131e08369 |
POST /Department | Create departmentAPI description (source language)Cria um departamento com nome, cota mensal em BRL e membros informados em TenantUserIds. Os membros devem pertencer ao tenant autenticado. Cota null significa ilimitada; zero bloqueia o uso; valores negativos são inválidos. | zild_post_department_43fece942628 |
GET /Department/tenant-quota | Get tenant consumption and quotaAPI description (source language)Retorna o consumo do mês atual em UTC, o limite mensal e a indicação de bloqueio por cota do tenant autenticado. Não altera limites nem registra consumo. | zild_get_department_tenant_quota_8768089d032f |
GET /Department/{id} | Get departmentAPI description (source language)Retorna o departamento identificado por id, incluindo a cota mensal e os IDs de seus membros. | zild_get_department_id_fb41b8c5b38a |
PUT /Department/{id} | Update departmentAPI description (source language)Atualiza nome, cota mensal e a lista completa de membros do departamento. Membros omitidos da lista são removidos. TenantUserIds deve conter apenas membros do tenant autenticado. Cota null significa ilimitada; zero bloqueia o uso. | zild_put_department_id_8a8ac53153c5 |
DELETE /Department/{id} | Delete departmentAPI description (source language)Exclui o departamento identificado por id. A operação é recusada enquanto houver agentes vinculados ao departamento; remova esses vínculos antes de excluir. | zild_delete_department_id_f5a9d0784f15 |
GET /Department/{id}/quota | Get department consumption and quotasAPI description (source language)Retorna o consumo do mês atual em UTC, os limites do tenant e do departamento e a indicação de bloqueio por cota. Não altera limites nem registra consumo. | zild_get_department_id_quota_0afaea23dc2d |
Consumption (1)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
POST /ConsumptionDashboard | Query consumption dashboardAPI description (source language)Consulta o dashboard de consumo conforme os filtros do corpo da requisição. Retorna um resumo de agentes, valores contratados e consumidos, consumo por item e dia e dimensões de consumo. Apesar de usar POST, esta operação é uma consulta e não registra consumo nem altera cotas. | zild_post_consumptiondashboard_fc8837cbdfb2 |
Webhooks (5)
| Operation and contract | Purpose | Expected MCP tool |
|---|---|---|
GET /Webhook | List webhooksAPI description (source language)Retorna as configurações de webhooks do tenant autenticado, incluindo nome, URL de destino, tipo de evento e estado de habilitação. Requer ViewWebhooks. | zild_get_webhook_b54d4957d094 |
POST /Webhook | Create webhookAPI description (source language)Cadastra uma configuração de webhook com nome, URL de destino, tipo de evento e estado de habilitação. Não envia uma notificação de teste nesta requisição. Requer CreateWebhook. Retorna 200 sem o registro criado no corpo. | zild_post_webhook_6c6aed23f6f2 |
GET /Webhook/{id} | Get webhookAPI description (source language)Retorna a configuração do webhook identificado por id no tenant autenticado. Requer ViewWebhooks. | zild_get_webhook_id_50ff5d5af22d |
PUT /Webhook/{id} | Update webhookAPI description (source language)Atualiza a configuração do webhook identificado por id usando nome, URL de destino, tipo de evento e habilitação enviados no corpo. Não envia uma notificação de teste nesta requisição. Requer UpdateWebhook. Retorna 200 sem conteúdo. | zild_put_webhook_id_9b1ec566abb1 |
DELETE /Webhook/{id} | Request webhook deletion (no effect implemented)API description (source language)Esta rota atualmente retorna sucesso sem excluir ou alterar o webhook. A chamada ao serviço de exclusão não está implementada no controller; não use esta operação para confirmar que um webhook foi removido. | zild_delete_webhook_id_614ae5fb1fbf |