Catálogo de operações MCP

Todas as operações previstas no MCP da Zild, analisadas a partir do OpenAPI, com métodos, rotas, nomes de ferramentas e contratos.

Critério de publicação e escopo analisado

Este catálogo foi gerado do OpenAPI 3.0.4, API v1, incluído no site: 137 operações, 79 rotas. O MCP em execução gera suas ferramentas a partir do Swagger v1 do próprio ambiente; diferenças entre versões podem mudar o catálogo.

O adaptador percorre GET, POST, PUT, PATCH, DELETE, HEAD e OPTIONS. Este documento contém apenas GET, POST, PUT e DELETE. Não existe uma lista adicional que restrinja a publicação a consultas: cada operação do OpenAPI final gera uma ferramenta. Controllers e ações ocultos por IgnoreApi e aliases /api/ removidos pelo filtro do Swagger ficam fora desse documento.

Os nomes abaixo reproduzem a convenção do adaptador: método e rota normalizada, seguidos dos 12 primeiros caracteres do hash SHA-256 de “MÉTODO /rota”. Confirme o nome e o inputSchema com tools/list no ambiente conectado.

Distribuição por método HTTP

MétodoOperações
GET51
POST42
PUT22
DELETE22

Áreas disponíveis

ÁreaOperaçõesCapacidades
CRM11Contas e contatos: listagem, consulta por ID, contatos por conta, criação, atualização e exclusão.
Agentes40Agentes, conhecimentos, skills, ferramentas, variáveis dinâmicas, coleta de dados, arquivos, links, conversas, execução e histórico com rollback.
Voz8Chamadas individuais e em lote, ligação para usuário, vozes, modelos ElevenLabs e referências de ferramentas de voz.
Insight12Checklists e itens, reavaliação de conversas, importação de áudio e importação do Microsoft Teams.
Assist8Processamento de e-mail, conversa proativa no WhatsApp, templates e verificação de aprovação.
Conversas e mensagens9Conversas paginadas, consulta por ID, exportação, mensagens, atualização, reenvio e marcação como lida.
Documentos6Documentos paginados, dashboard, consulta por ID, criação com arquivo, exclusão e reprocessamento.
Flow24Fluxos e dashboard; tarefas recorrentes e ocorrências; etapas, tarefas e histórico de tarefas, conforme os métodos publicados.
Conexões MCP de agentes6Associação de conectores a agentes, habilitação, ferramentas permitidas e descoberta de ferramentas de servidores MCP externos.
Departamentos e cotas7Cadastro e membros de departamentos; consulta de consumo e cotas do departamento e do tenant.
Consumo1Consulta do dashboard de consumo por filtros; o POST não registra consumo nem altera cotas.
Webhooks5Listagem, consulta, criação e atualização de webhooks. A rota DELETE publicada atualmente não exclui o registro.

Consultas, escrita e efeitos externos

O método HTTP não determina sozinho o efeito da ferramenta. POST /AgentHistory/filter consulta o histórico com filtros; POST /AgentHistory/rollback reverte o agente. GETs são apresentados como operações de consulta no contrato; os demais métodos devem ser avaliados pela descrição e pelo comportamento da API.

O catálogo inclui exclusões de contas, contatos, agentes, conhecimentos, skills, documentos e outros registros. Também inclui POST /Agent/run, chamadas individuais e em lote, conversa proativa no WhatsApp, processamento de e-mail, reenvio de mensagens e reprocessamento de documentos. Essas ações podem executar agentes, alterar dados, gerar consumo ou iniciar comunicações.

Não há filtragem individual do catálogo por permissão nesta versão. A API verifica a autorização durante a execução. O cliente deve avaliar os efeitos antes de chamar ferramentas de escrita e verificar o resultado antes de repetir uma chamada cujo desfecho seja incerto.

Qualidade das descrições e cobertura

Todas as 137 operações analisadas possuem resumo e descrição. As explicações atualizadas de Flow, consumo, departamentos, conexões MCP e webhooks são aproveitadas nas ferramentas. O MCP reutiliza esses textos no título e na descrição das ferramentas; método e rota permanecem como identificação de fallback. As descrições detalhadas de cada operação estão disponíveis nas tabelas abaixo.

O CRUD herdado de Flow agora recebe descrições específicas por recurso e schemas de resposta, incluindo sucesso sem conteúdo (204) e registro não encontrado (404), quando definidos no contrato. Melhorias de texto preservam os nomes MCP porque eles dependem apenas de método e rota.

Não aparecem neste OpenAPI a listagem simples GET /Conversation, PUT /Document/{id}, rotas de UserTask ou operações de AgentModelPolicy. A execução POST /Agent/run aparece com multipart/form-data.

Comportamentos esclarecidos no contrato atualizado

  • Flow: PUT /FlowTask/{id} pode mover a tarefa de raia e agendar o agente responsável. Nesse caso, os demais campos enviados não são atualizados. Registrar histórico não movimenta a tarefa nem executa agentes.
  • Recorrências: criar uma regra não gera tarefas imediatamente. A consulta de ocorrências apenas prevê as próximas datas em UTC; count tem padrão 50 e é ajustado ao intervalo de 1 a 200.
  • Consumo: POST /ConsumptionDashboard é uma consulta com filtros, sem registrar consumo ou alterar cotas. GET /SubscriptionConsumption não está no contrato atualizado.
  • Departamentos: a atualização substitui a lista de membros. Cota null significa ilimitada e zero bloqueia o uso. A exclusão é recusada enquanto houver agentes vinculados.
  • Conexões MCP: gerenciam o acesso dos agentes da Zild a conectores externos. AllowedTools vazia não libera ferramentas; a descoberta consulta o servidor externo, sem executar ferramentas nem autorizar seu uso automaticamente. Estas operações são diferentes da conexão de um agente externo ao MCP Server da Zild.
  • Webhooks: criar e atualizar configurações não envia notificação de teste. DELETE /Webhook/{id} está publicado, mas atualmente responde sem excluir ou alterar o webhook; a resposta não comprova remoção.

CRM (11)

Operação e contratoFinalidadeFerramenta MCP prevista
GET /AccountRetorna todas as contas
Descrição da API

Este endpoint retorna todas as contas cadastradas.

zild_get_account_b6ca3624bad1
POST /AccountCria uma nova conta
Descrição da API

Este endpoint cria uma nova conta com os dados fornecidos no corpo da requisição.

zild_post_account_a73ca3c8d4fa
GET /Account/{id}Retorna uma conta por id
Descrição da API

Este endpoint retorna os detalhes de uma conta especificada pelo identificador.

zild_get_account_id_d5e47e76665c
PUT /Account/{id}Atualiza uma conta
Descrição da API

Este endpoint atualiza os dados de uma conta existente identificada pelo id.

zild_put_account_id_80c250b0cfd5
DELETE /Account/{id}Deleta uma conta
Descrição da API

Este endpoint deleta uma conta existente identificada pelo id.

zild_delete_account_id_204d8590f9b6
GET /ContactRetorna todos os contatos
Descrição da API

Este endpoint retorna todos os contatos cadastrados.

zild_get_contact_f2bb51fbfdc0
POST /ContactCria um novo contato
Descrição da API

Este endpoint cria um novo contato com os dados fornecidos no corpo da requisição.

zild_post_contact_2e9539ad6c8a
GET /Contact/GetByAccountId/{accountId}Retorna contatos por conta
Descrição da API

Este endpoint retorna todos os contatos vinculados a uma conta específica.

zild_get_contact_getbyaccountid_accountid_202dfb40f8d2
GET /Contact/{id}Retorna um contato por id
Descrição da API

Este endpoint retorna os detalhes de um contato especificado pelo identificador.

zild_get_contact_id_80e630e9c3e2
PUT /Contact/{id}Atualiza um contato
Descrição da API

Este endpoint atualiza os dados de um contato existente identificado pelo id.

zild_put_contact_id_3f939fb12ff8
DELETE /Contact/{id}Exclui um contato
Descrição da API

Este endpoint exclui um contato existente identificado pelo id.

zild_delete_contact_id_a7fbdb2dcdd6

Agentes (40)

Operação e contratoFinalidadeFerramenta MCP prevista
GET /AgentReturns all agents
Descrição da API

This endpoint returns all registered agents.

zild_get_agent_e8da87db4e1e
POST /AgentCreates an agent
Descrição da API

This endpoint creates an agent.

zild_post_agent_76c52a0e94de
POST /Agent/conversationCreates a new Chat conversation with the agent
Descrição da API

This endpoint creates a new conversation between a user and the agent.

zild_post_agent_conversation_741a48920bd0
POST /Agent/fileAttaches a file to the agent
Descrição da API

This endpoint adds a file to the specified agent.

zild_post_agent_file_a4068926a82e
DELETE /Agent/fileRemoves a file from the agent
Descrição da API

This endpoint removes a file previously attached to the agent.

zild_delete_agent_file_ada1d1fb917c
POST /Agent/runSend an user message and runs the agent
Descrição da API

This endpoint runs the agent with the provided input message.

zild_post_agent_run_7a8bef807cdd
POST /Agent/web-linkAdds web page knowledge to the agent
Descrição da API

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-linkUpdates web page knowledge of the agent
Descrição da API

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}Returns an agent by id
Descrição da API

This endpoint returns the details of an agent specified by the identifier.

zild_get_agent_id_28a7bbddfe13
PUT /Agent/{id}Updates the agent
Descrição da API

This endpoint updates the agent.

zild_put_agent_id_c288777250f2
DELETE /Agent/{id}Deletes an agent
Descrição da API

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-iconUploads the agent logo/icon
Descrição da API

This endpoint uploads a logo/icon image for the specified agent.

zild_post_agent_id_logo_icon_21edf2bd8222
DELETE /Agent/{id}/logo-iconRemoves the agent logo/icon
Descrição da API

This endpoint removes the logo/icon image of the specified agent.

zild_delete_agent_id_logo_icon_f4bbf4622b43
POST /AgentDataCollectionCria uma nova variável de coleta de dados de agente
Descrição da API

Este endpoint cria uma nova variável de coleta de dados de agente com os dados fornecidos.

zild_post_agentdatacollection_8442b85a42d5
GET /AgentDataCollection/{id}Retorna uma variável de coleta de dados de agente por id
Descrição da API

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}Atualiza uma variável de coleta de dados de agente
Descrição da API

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}Remove uma variável de coleta de dados de agente
Descrição da API

Este endpoint remove uma variável de coleta de dados de agente existente identificada pelo id.

zild_delete_agentdatacollection_id_b55d01d6f756
POST /AgentDynamicVariableCria uma nova variável dinâmica de agente
Descrição da API

Este endpoint cria uma nova variável dinâmica de agente com os dados fornecidos.

zild_post_agentdynamicvariable_0c479b53adbb
GET /AgentDynamicVariable/{id}Retorna uma variável dinâmica de agente por id
Descrição da API

Este endpoint retorna os detalhes de uma variável dinâmica de agente especificada pelo identificador.

zild_get_agentdynamicvariable_id_d0dc10777c11
PUT /AgentDynamicVariable/{id}Atualiza uma variável dinâmica de agente
Descrição da API

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}Remove uma variável dinâmica de agente
Descrição da API

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}Retorna uma versão específica do agente
Descrição da API

Este endpoint retorna o estado do agente em uma versão específica.

zild_get_agenthistory_agent_agentid_version_version_02ff2fcb9306
POST /AgentHistory/filterFiltra o histórico de alterações com paginação
Descrição da API

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/rollbackReverte o agente para uma versão anterior
Descrição da API

Este endpoint reverte o agente para o estado de uma versão específica.

zild_post_agenthistory_rollback_a43a610e7e84
GET /AgentHistory/{id}Retorna um registro de histórico por ID
Descrição da API

Este endpoint retorna os detalhes de um registro de histórico específico.

zild_get_agenthistory_id_872a6efee8bf
GET /AgentToolRetorna todas as ferramentas de um Agente de IA
Descrição da API

Este endpoint retorna todas as ferramentas de um Agente de IA pelo identificador do Agente de IA.

zild_get_agenttool_782c31184b2e
POST /AgentToolCria uma nova ferramenta de agente
Descrição da API

Este endpoint cria uma nova ferramenta de agente com os dados fornecidos.

zild_post_agenttool_2999969ce386
GET /AgentTool/{id}Retorna uma ferramenta de agente por id
Descrição da API

Este endpoint retorna os detalhes de uma ferramenta de agente especificada pelo identificador.

zild_get_agenttool_id_bf409ee13b10
PUT /AgentTool/{id}Atualiza uma ferramenta de agente
Descrição da API

Este endpoint atualiza os dados de uma ferramenta de agente existente identificada pelo id.

zild_put_agenttool_id_829d0f81df35
DELETE /AgentTool/{id}Remove uma ferramenta de agente
Descrição da API

Este endpoint remove uma ferramenta de agente existente identificada pelo id.

zild_delete_agenttool_id_c77127694d7f
GET /KnowledgeRetorna todos os conhecimentos de agente
Descrição da API

Este endpoint retorna todos os conhecimentos de agente cadastrados.

zild_get_knowledge_edf5231cdb00
POST /KnowledgeCria um novo conhecimento de agente
Descrição da API

Este endpoint cria um novo conhecimento de agente com os dados fornecidos.

zild_post_knowledge_5157806c8d4b
GET /Knowledge/{id}Retorna um conhecimento de agente por id
Descrição da API

Este endpoint retorna os detalhes de um conhecimento de agente especificado pelo identificador.

zild_get_knowledge_id_38263d11e5b5
PUT /Knowledge/{id}Atualiza um conhecimento de agente
Descrição da API

Este endpoint atualiza os dados de um conhecimento de agente existente identificado pelo id.

zild_put_knowledge_id_0281d0a89020
DELETE /Knowledge/{id}Remove um conhecimento de agente
Descrição da API

Este endpoint remove um conhecimento de agente existente identificado pelo id.

zild_delete_knowledge_id_89360176d8fb
GET /SkillRetorna todas as skills visiveis
Descrição da API

Este endpoint retorna as skills do tenant e as skills globais habilitadas.

zild_get_skill_a0e49fd5d860
POST /SkillCria uma nova skill
Descrição da API

Este endpoint cria uma nova skill para o tenant atual.

zild_post_skill_0713798a9d8e
GET /Skill/{id}Retorna uma skill por id
Descrição da API

Este endpoint retorna os detalhes de uma skill especificada pelo identificador.

zild_get_skill_id_dcc59e89d18c
PUT /Skill/{id}Atualiza uma skill
Descrição da API

Este endpoint atualiza uma skill do tenant atual.

zild_put_skill_id_b44b2e0a722a
DELETE /Skill/{id}Remove uma skill
Descrição da API

Este endpoint remove uma skill do tenant atual.

zild_delete_skill_id_97756762ea5e

Voz (8)

Operação e contratoFinalidadeFerramenta MCP prevista
POST /Agent/create-batch-callCreates batch calls
Descrição da API

This endpoint creates multiple batch phone calls for an ElevenLabs agent.

zild_post_agent_create_batch_call_47019dde720e
POST /Agent/create-phone-callCreates a phone call
Descrição da API

This endpoint creates a phone call for an ElevenLabs agent.

zild_post_agent_create_phone_call_016b07989851
GET /Agent/elevenlabs-llmsReturns available ElevenLabs LLMs
Descrição da API

This endpoint returns the available ElevenLabs LLM models and safe capabilities for use with agents.

zild_get_agent_elevenlabs_llms_e8a97b6a9c1a
GET /Agent/voiceReturns available voices by provider
Descrição da API

This endpoint returns the available voices from a specific provider (ElevenLabs) for use with agents.

zild_get_agent_voice_dc6eb2b3c727
GET /Agent/voice-toolsReturns available voice tools for the current tenant
Descrição da API

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-toolsReferences a voice tool for the current tenant
Descrição da API

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}Removes a voice tool reference from the current tenant
Descrição da API

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-userCria ligação telefônica para usuário
Descrição da API

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)

Operação e contratoFinalidadeFerramenta MCP prevista
GET /ChecklistRetorna todos os checklists
Descrição da API

Este endpoint retorna todos os checklists cadastrados.

zild_get_checklist_3746e42fc684
POST /ChecklistCria um novo checklist
Descrição da API

Este endpoint cria um novo checklist com os dados fornecidos.

zild_post_checklist_a430b4271aaa
GET /Checklist/{id}Retorna um checklist por id
Descrição da API

Este endpoint retorna os detalhes de um checklist especificado pelo identificador.

zild_get_checklist_id_5c69f4f7ae5c
PUT /Checklist/{id}Atualiza um checklist
Descrição da API

Este endpoint atualiza os dados de um checklist existente identificado pelo id.

zild_put_checklist_id_66bd7e5ebc5e
GET /ChecklistItemRetorna itens de checklist por checklist
Descrição da API

Este endpoint retorna os itens de um checklist específico.

zild_get_checklistitem_c37c1db2ddf1
POST /ChecklistItemCria um novo item de checklist
Descrição da API

Este endpoint cria um novo item de checklist com os dados fornecidos.

zild_post_checklistitem_8b86e2e97c31
GET /ChecklistItem/{id}Retorna um item de checklist por id
Descrição da API

Este endpoint retorna os detalhes de um item de checklist especificado pelo identificador.

zild_get_checklistitem_id_cc26b8f6ee14
PUT /ChecklistItem/{id}Atualiza um item de checklist
Descrição da API

Este endpoint atualiza os dados de um item de checklist existente identificado pelo id.

zild_put_checklistitem_id_65b9c680cc19
DELETE /ChecklistItem/{id}Deleta um item de checklist
Descrição da API

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/reevaluateReavalia checklist da conversa
Descrição da API

Este endpoint dispara a reavaliação do checklist de uma ou mais conversas.

zild_post_conversation_reevaluate_dda3800e6e85
POST /Insight/audioImporta conversa de áudio para processamento do Zild Insight
Descrição da API

Este endpoint cria uma conversa a partir de um arquivo de audio e metadados.

zild_post_insight_audio_28eeb9723766
POST /Insight/import-ms-teamsImporta conversas do Microsoft Teams para processamento do Zild Insight
Descrição da API

Este endpoint importa conversas originadas do Microsoft Teams.

zild_post_insight_import_ms_teams_8e5a295feb9a

Assist (8)

Operação e contratoFinalidadeFerramenta MCP prevista
POST /Conversation/emailRecebe e responde e-mails
Descrição da API

Este endpoint recebe e e-mails e envia para o Agente de IA responder.

zild_post_conversation_email_e7e79d806db1
POST /Conversation/whatsapp-proactive-conversationCria conversa proativa no WhatsApp
Descrição da API

Este endpoint cria uma conversa proativa com os dados fornecidos.

zild_post_conversation_whatsapp_proactive_conversation_31db3875643e
GET /ConversationTemplateRetorna templates de WhatsApp por filtro
Descrição da API

Este endpoint retorna templates de conversa conforme os filtros informados.

zild_get_conversationtemplate_84bbce40064c
POST /ConversationTemplateCria um novo template de WhatsApp
Descrição da API

Este endpoint cria um novo template de conversa com os dados fornecidos.

zild_post_conversationtemplate_2db9c29b2e15
GET /ConversationTemplate/{id}Retorna um template de WhatsApp por id
Descrição da API

Este endpoint retorna os detalhes de um template de conversa especificado pelo identificador.

zild_get_conversationtemplate_id_81a744baeb1f
PUT /ConversationTemplate/{id}Atualiza um template de WhatsApp
Descrição da API

Este endpoint atualiza os dados de um template de conversa existente identificado pelo id.

zild_put_conversationtemplate_id_86000cb2a10c
DELETE /ConversationTemplate/{id}Deleta um template de WhatsApp
Descrição da API

Este endpoint deleta template de WhatsApp.

zild_delete_conversationtemplate_id_78c6d16c4f7e
POST /ConversationTemplate/{id}/check-approvalVerifica manualmente o status de aprovação
Descrição da API

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

Conversas e mensagens (9)

Operação e contratoFinalidadeFerramenta MCP prevista
POST /Conversation/exportExporta conversas por filtro
Descrição da API

Este endpoint retorna todas as conversas que atendem ao filtro informado, com itens de checklist opcionais.

zild_post_conversation_export_83914eb76ba2
GET /Conversation/pagedRetorna conversas paginadas
Descrição da API

Este endpoint retorna as conversas paginadas conforme o filtro informado.

zild_get_conversation_paged_8777cc7449d2
GET /Conversation/{id}Retorna uma conversa por id
Descrição da API

Este endpoint retorna os detalhes de uma conversa especificada pelo identificador.

zild_get_conversation_id_499ae9457461
GET /MessageRetorna mensagens por conversa
Descrição da API

Este endpoint retorna as mensagens de uma conversa especificada pelo identificador da conversa.

zild_get_message_f14013758dfb
POST /MessageCria uma nova mensagem
Descrição da API

Este endpoint cria uma nova mensagem, opcionalmente com arquivo, para uma conversa.

zild_post_message_dd1c2cb71f86
POST /Message/resendReenvia uma mensagem
Descrição da API

Este endpoint reenvia uma mensagem já existente pelo seu identificador.

zild_post_message_resend_11e4db8122c8
GET /Message/{id}Retorna uma mensagem por id
Descrição da API

Este endpoint retorna os detalhes de uma mensagem especificada pelo identificador.

zild_get_message_id_e2575153d29b
PUT /Message/{id}Atualiza uma mensagem
Descrição da API

Este endpoint atualiza os dados de uma mensagem existente identificada pelo id.

zild_put_message_id_19b6e597d699
PUT /Message/{messageId}/readMarca uma mensagem como lida pelo usuário
Descrição da API

Este endpoint marca uma mensagem específica como lida pelo usuário.

zild_put_message_messageid_read_6b89be4f8644

Documentos (6)

Operação e contratoFinalidadeFerramenta MCP prevista
POST /DocumentCria um novo documento
Descrição da API

Este endpoint cria um novo documento, opcionalmente com arquivo, com os dados fornecidos.

zild_post_document_550502414b9f
GET /Document/dashboardRetorna dashboard de documentos
Descrição da API

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/pagedRetorna documentos paginados
Descrição da API

Este endpoint retorna documentos paginados conforme o filtro informado.

zild_get_document_paged_090de02b746f
GET /Document/{id}Retorna um documento por id
Descrição da API

Este endpoint retorna os detalhes de um documento especificado pelo identificador.

zild_get_document_id_a13894680bb2
DELETE /Document/{id}Remove um documento
Descrição da API

Este endpoint remove um documento existente identificado pelo id.

zild_delete_document_id_5ecae91db708
POST /Document/{id}/reprocessReprocessa um documento
Descrição da API

Este endpoint reprocessa um documento existente identificado pelo id.

zild_post_document_id_reprocess_1470ac0c91a9

Flow (24)

Operação e contratoFinalidadeFerramenta MCP prevista
GET /FlowLista fluxos
Descrição da API

Retorna a lista de fluxos do tenant do usuário autenticado.

zild_get_flow_96ec9435526f
POST /FlowCria fluxo
Descrição da API

Cria um registro de fluxo com os dados do corpo da requisição e retorna o registro criado.

zild_post_flow_1c87790c6811
GET /Flow/dashboardConsulta indicadores de fluxos e tarefas
Descrição da API

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}Consulta fluxo por ID
Descrição da API

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}Atualiza fluxo
Descrição da API

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}Exclui fluxo
Descrição da API

Exclui o registro de fluxo identificado por id. Retorna 204 sem conteúdo.

zild_delete_flow_id_e2092f067f1d
GET /FlowRecurringTaskLista recorrências de tarefas
Descrição da API

Retorna a lista de recorrências de tarefas do tenant do usuário autenticado.

zild_get_flowrecurringtask_697550d65a44
POST /FlowRecurringTaskCria recorrência de tarefas
Descrição da API

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}Consulta recorrência de tarefas por ID
Descrição da API

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}Atualiza recorrência de tarefas
Descrição da API

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}Exclui recorrência de tarefas
Descrição da API

Exclui o registro de recorrência de tarefas identificado por id. Retorna 204 sem conteúdo.

zild_delete_flowrecurringtask_id_84b453427dbc
GET /FlowRecurringTask/{id}/occurrencesConsulta próximas ocorrências de uma recorrência
Descrição da API

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 /FlowStageCria raia de fluxo
Descrição da API

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}Consulta raia de fluxo por ID
Descrição da API

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}Atualiza raia de fluxo
Descrição da API

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}Exclui raia de fluxo
Descrição da API

Exclui o registro de raia de fluxo identificado por id. Retorna 204 sem conteúdo.

zild_delete_flowstage_id_c30ed03e7b3d
POST /FlowTaskCria tarefa de fluxo
Descrição da API

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}Consulta tarefa de fluxo por ID
Descrição da API

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}Atualiza tarefa de fluxo
Descrição da API

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}Exclui tarefa de fluxo
Descrição da API

Exclui o registro de tarefa de fluxo identificado por id. Retorna 204 sem conteúdo.

zild_delete_flowtask_id_8cd5dc4068f6
POST /FlowTaskHistoryCria registro de histórico de tarefa
Descrição da API

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}Consulta registro de histórico de tarefa por ID
Descrição da API

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}Atualiza registro de histórico de tarefa
Descrição da API

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}Exclui registro de histórico de tarefa
Descrição da API

Exclui o registro de registro de histórico de tarefa identificado por id. Retorna 204 sem conteúdo.

zild_delete_flowtaskhistory_id_b73af511b1da

Conexões MCP de agentes (6)

Operação e contratoFinalidadeFerramenta MCP prevista
GET /AgentMcpConnectionLista conexões MCP de um agente
Descrição da API

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 /AgentMcpConnectionAssocia conector MCP a um agente
Descrição da API

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}/toolsDescobre ferramentas de um conector MCP
Descrição da API

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}Consulta conexão MCP por ID
Descrição da API

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}Atualiza habilitação e ferramentas de uma conexão MCP
Descrição da API

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}Remove associação MCP de um agente
Descrição da API

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

Departamentos e cotas (7)

Operação e contratoFinalidadeFerramenta MCP prevista
GET /DepartmentLista departamentos
Descrição da API

Retorna os departamentos do tenant do usuário autenticado.

zild_get_department_a3e131e08369
POST /DepartmentCria departamento
Descrição da API

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-quotaConsulta consumo e cota do tenant
Descrição da API

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}Consulta departamento por ID
Descrição da API

Retorna o departamento identificado por id, incluindo a cota mensal e os IDs de seus membros.

zild_get_department_id_fb41b8c5b38a
PUT /Department/{id}Atualiza departamento e seus membros
Descrição da API

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}Exclui departamento
Descrição da API

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}/quotaConsulta consumo e cotas de um departamento
Descrição da API

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

Consumo (1)

Operação e contratoFinalidadeFerramenta MCP prevista
POST /ConsumptionDashboardConsulta indicadores de consumo
Descrição da API

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)

Operação e contratoFinalidadeFerramenta MCP prevista
GET /WebhookLista webhooks
Descrição da API

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 /WebhookCadastra webhook
Descrição da API

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}Consulta webhook por ID
Descrição da API

Retorna a configuração do webhook identificado por id no tenant autenticado. Requer ViewWebhooks.

zild_get_webhook_id_50ff5d5af22d
PUT /Webhook/{id}Atualiza webhook
Descrição da API

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}Solicita exclusão de webhook (sem efeito implementado)
Descrição da API

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