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étodo | Operações |
|---|---|
| GET | 51 |
| POST | 42 |
| PUT | 22 |
| DELETE | 22 |
Áreas disponíveis
| Área | Operações | Capacidades |
|---|---|---|
| CRM | 11 | Contas e contatos: listagem, consulta por ID, contatos por conta, criação, atualização e exclusão. |
| Agentes | 40 | Agentes, conhecimentos, skills, ferramentas, variáveis dinâmicas, coleta de dados, arquivos, links, conversas, execução e histórico com rollback. |
| Voz | 8 | Chamadas individuais e em lote, ligação para usuário, vozes, modelos ElevenLabs e referências de ferramentas de voz. |
| Insight | 12 | Checklists e itens, reavaliação de conversas, importação de áudio e importação do Microsoft Teams. |
| Assist | 8 | Processamento de e-mail, conversa proativa no WhatsApp, templates e verificação de aprovação. |
| Conversas e mensagens | 9 | Conversas paginadas, consulta por ID, exportação, mensagens, atualização, reenvio e marcação como lida. |
| Documentos | 6 | Documentos paginados, dashboard, consulta por ID, criação com arquivo, exclusão e reprocessamento. |
| Flow | 24 | Fluxos e dashboard; tarefas recorrentes e ocorrências; etapas, tarefas e histórico de tarefas, conforme os métodos publicados. |
| Conexões MCP de agentes | 6 | Associação de conectores a agentes, habilitação, ferramentas permitidas e descoberta de ferramentas de servidores MCP externos. |
| Departamentos e cotas | 7 | Cadastro e membros de departamentos; consulta de consumo e cotas do departamento e do tenant. |
| Consumo | 1 | Consulta do dashboard de consumo por filtros; o POST não registra consumo nem altera cotas. |
| Webhooks | 5 | Listagem, 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 contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
GET /Account | Retorna todas as contasDescrição da APIEste endpoint retorna todas as contas cadastradas. | zild_get_account_b6ca3624bad1 |
POST /Account | Cria uma nova contaDescrição da APIEste 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 idDescrição da APIEste endpoint retorna os detalhes de uma conta especificada pelo identificador. | zild_get_account_id_d5e47e76665c |
PUT /Account/{id} | Atualiza uma contaDescrição da APIEste endpoint atualiza os dados de uma conta existente identificada pelo id. | zild_put_account_id_80c250b0cfd5 |
DELETE /Account/{id} | Deleta uma contaDescrição da APIEste endpoint deleta uma conta existente identificada pelo id. | zild_delete_account_id_204d8590f9b6 |
GET /Contact | Retorna todos os contatosDescrição da APIEste endpoint retorna todos os contatos cadastrados. | zild_get_contact_f2bb51fbfdc0 |
POST /Contact | Cria um novo contatoDescrição da APIEste 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 contaDescrição da APIEste endpoint retorna todos os contatos vinculados a uma conta específica. | zild_get_contact_getbyaccountid_accountid_202dfb40f8d2 |
GET /Contact/{id} | Retorna um contato por idDescrição da APIEste endpoint retorna os detalhes de um contato especificado pelo identificador. | zild_get_contact_id_80e630e9c3e2 |
PUT /Contact/{id} | Atualiza um contatoDescrição da APIEste endpoint atualiza os dados de um contato existente identificado pelo id. | zild_put_contact_id_3f939fb12ff8 |
DELETE /Contact/{id} | Exclui um contatoDescrição da APIEste endpoint exclui um contato existente identificado pelo id. | zild_delete_contact_id_a7fbdb2dcdd6 |
Agentes (40)
| Operação e contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
GET /Agent | Returns all agentsDescrição da APIThis endpoint returns all registered agents. | zild_get_agent_e8da87db4e1e |
POST /Agent | Creates an agentDescrição da APIThis endpoint creates an agent. | zild_post_agent_76c52a0e94de |
POST /Agent/conversation | Creates a new Chat conversation with the agentDescrição da APIThis endpoint creates a new conversation between a user and the agent. | zild_post_agent_conversation_741a48920bd0 |
POST /Agent/file | Attaches a file to the agentDescrição da APIThis endpoint adds a file to the specified agent. | zild_post_agent_file_a4068926a82e |
DELETE /Agent/file | Removes a file from the agentDescrição da APIThis endpoint removes a file previously attached to the agent. | zild_delete_agent_file_ada1d1fb917c |
POST /Agent/run | Send an user message and runs the agentDescrição da APIThis endpoint runs the agent with the provided input message. | zild_post_agent_run_7a8bef807cdd |
POST /Agent/web-link | Adds web page knowledge to the agentDescrição da APIThis 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 | Updates web page knowledge of the agentDescrição da APIThis 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 idDescrição da APIThis endpoint returns the details of an agent specified by the identifier. | zild_get_agent_id_28a7bbddfe13 |
PUT /Agent/{id} | Updates the agentDescrição da APIThis endpoint updates the agent. | zild_put_agent_id_c288777250f2 |
DELETE /Agent/{id} | Deletes an agentDescrição da APIThis 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 | Uploads the agent logo/iconDescrição da APIThis endpoint uploads a logo/icon image for the specified agent. | zild_post_agent_id_logo_icon_21edf2bd8222 |
DELETE /Agent/{id}/logo-icon | Removes the agent logo/iconDescrição da APIThis endpoint removes the logo/icon image of the specified agent. | zild_delete_agent_id_logo_icon_f4bbf4622b43 |
POST /AgentDataCollection | Cria uma nova variável de coleta de dados de agenteDescrição da APIEste 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 idDescrição da APIEste 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 agenteDescrição da APIEste 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 agenteDescrição da APIEste endpoint remove uma variável de coleta de dados de agente existente identificada pelo id. | zild_delete_agentdatacollection_id_b55d01d6f756 |
POST /AgentDynamicVariable | Cria uma nova variável dinâmica de agenteDescrição da APIEste 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 idDescrição da APIEste 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 agenteDescrição da APIEste 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 agenteDescrição da APIEste 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 agenteDescrição da APIEste endpoint retorna o estado do agente em uma versão específica. | zild_get_agenthistory_agent_agentid_version_version_02ff2fcb9306 |
POST /AgentHistory/filter | Filtra o histórico de alterações com paginaçãoDescrição da APIEste 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 | Reverte o agente para uma versão anteriorDescrição da APIEste 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 IDDescrição da APIEste endpoint retorna os detalhes de um registro de histórico específico. | zild_get_agenthistory_id_872a6efee8bf |
GET /AgentTool | Retorna todas as ferramentas de um Agente de IADescrição da APIEste endpoint retorna todas as ferramentas de um Agente de IA pelo identificador do Agente de IA. | zild_get_agenttool_782c31184b2e |
POST /AgentTool | Cria uma nova ferramenta de agenteDescrição da APIEste endpoint cria uma nova ferramenta de agente com os dados fornecidos. | zild_post_agenttool_2999969ce386 |
GET /AgentTool/{id} | Retorna uma ferramenta de agente por idDescrição da APIEste endpoint retorna os detalhes de uma ferramenta de agente especificada pelo identificador. | zild_get_agenttool_id_bf409ee13b10 |
PUT /AgentTool/{id} | Atualiza uma ferramenta de agenteDescrição da APIEste 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 agenteDescrição da APIEste endpoint remove uma ferramenta de agente existente identificada pelo id. | zild_delete_agenttool_id_c77127694d7f |
GET /Knowledge | Retorna todos os conhecimentos de agenteDescrição da APIEste endpoint retorna todos os conhecimentos de agente cadastrados. | zild_get_knowledge_edf5231cdb00 |
POST /Knowledge | Cria um novo conhecimento de agenteDescrição da APIEste endpoint cria um novo conhecimento de agente com os dados fornecidos. | zild_post_knowledge_5157806c8d4b |
GET /Knowledge/{id} | Retorna um conhecimento de agente por idDescrição da APIEste endpoint retorna os detalhes de um conhecimento de agente especificado pelo identificador. | zild_get_knowledge_id_38263d11e5b5 |
PUT /Knowledge/{id} | Atualiza um conhecimento de agenteDescrição da APIEste 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 agenteDescrição da APIEste endpoint remove um conhecimento de agente existente identificado pelo id. | zild_delete_knowledge_id_89360176d8fb |
GET /Skill | Retorna todas as skills visiveisDescrição da APIEste endpoint retorna as skills do tenant e as skills globais habilitadas. | zild_get_skill_a0e49fd5d860 |
POST /Skill | Cria uma nova skillDescrição da APIEste endpoint cria uma nova skill para o tenant atual. | zild_post_skill_0713798a9d8e |
GET /Skill/{id} | Retorna uma skill por idDescrição da APIEste endpoint retorna os detalhes de uma skill especificada pelo identificador. | zild_get_skill_id_dcc59e89d18c |
PUT /Skill/{id} | Atualiza uma skillDescrição da APIEste endpoint atualiza uma skill do tenant atual. | zild_put_skill_id_b44b2e0a722a |
DELETE /Skill/{id} | Remove uma skillDescrição da APIEste endpoint remove uma skill do tenant atual. | zild_delete_skill_id_97756762ea5e |
Voz (8)
| Operação e contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
POST /Agent/create-batch-call | Creates batch callsDescrição da APIThis endpoint creates multiple batch phone calls for an ElevenLabs agent. | zild_post_agent_create_batch_call_47019dde720e |
POST /Agent/create-phone-call | Creates a phone callDescrição da APIThis endpoint creates a phone call for an ElevenLabs agent. | zild_post_agent_create_phone_call_016b07989851 |
GET /Agent/elevenlabs-llms | Returns available ElevenLabs LLMsDescrição da APIThis endpoint returns the available ElevenLabs LLM models and safe capabilities for use with agents. | zild_get_agent_elevenlabs_llms_e8a97b6a9c1a |
GET /Agent/voice | Returns available voices by providerDescrição da APIThis endpoint returns the available voices from a specific provider (ElevenLabs) for use with agents. | zild_get_agent_voice_dc6eb2b3c727 |
GET /Agent/voice-tools | Returns available voice tools for the current tenantDescrição da APILists 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 | References a voice tool for the current tenantDescrição da APIRegisters 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 tenantDescrição da APIRemoves 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 | Cria ligação telefônica para usuárioDescrição da APIEste 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 contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
GET /Checklist | Retorna todos os checklistsDescrição da APIEste endpoint retorna todos os checklists cadastrados. | zild_get_checklist_3746e42fc684 |
POST /Checklist | Cria um novo checklistDescrição da APIEste endpoint cria um novo checklist com os dados fornecidos. | zild_post_checklist_a430b4271aaa |
GET /Checklist/{id} | Retorna um checklist por idDescrição da APIEste endpoint retorna os detalhes de um checklist especificado pelo identificador. | zild_get_checklist_id_5c69f4f7ae5c |
PUT /Checklist/{id} | Atualiza um checklistDescrição da APIEste endpoint atualiza os dados de um checklist existente identificado pelo id. | zild_put_checklist_id_66bd7e5ebc5e |
GET /ChecklistItem | Retorna itens de checklist por checklistDescrição da APIEste endpoint retorna os itens de um checklist específico. | zild_get_checklistitem_c37c1db2ddf1 |
POST /ChecklistItem | Cria um novo item de checklistDescrição da APIEste endpoint cria um novo item de checklist com os dados fornecidos. | zild_post_checklistitem_8b86e2e97c31 |
GET /ChecklistItem/{id} | Retorna um item de checklist por idDescrição da APIEste endpoint retorna os detalhes de um item de checklist especificado pelo identificador. | zild_get_checklistitem_id_cc26b8f6ee14 |
PUT /ChecklistItem/{id} | Atualiza um item de checklistDescrição da APIEste 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 checklistDescrição da APIEste 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 | Reavalia checklist da conversaDescrição da APIEste endpoint dispara a reavaliação do checklist de uma ou mais conversas. | zild_post_conversation_reevaluate_dda3800e6e85 |
POST /Insight/audio | Importa conversa de áudio para processamento do Zild InsightDescrição da APIEste endpoint cria uma conversa a partir de um arquivo de audio e metadados. | zild_post_insight_audio_28eeb9723766 |
POST /Insight/import-ms-teams | Importa conversas do Microsoft Teams para processamento do Zild InsightDescrição da APIEste endpoint importa conversas originadas do Microsoft Teams. | zild_post_insight_import_ms_teams_8e5a295feb9a |
Assist (8)
| Operação e contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
POST /Conversation/email | Recebe e responde e-mailsDescrição da APIEste endpoint recebe e e-mails e envia para o Agente de IA responder. | zild_post_conversation_email_e7e79d806db1 |
POST /Conversation/whatsapp-proactive-conversation | Cria conversa proativa no WhatsAppDescrição da APIEste endpoint cria uma conversa proativa com os dados fornecidos. | zild_post_conversation_whatsapp_proactive_conversation_31db3875643e |
GET /ConversationTemplate | Retorna templates de WhatsApp por filtroDescrição da APIEste endpoint retorna templates de conversa conforme os filtros informados. | zild_get_conversationtemplate_84bbce40064c |
POST /ConversationTemplate | Cria um novo template de WhatsAppDescrição da APIEste endpoint cria um novo template de conversa com os dados fornecidos. | zild_post_conversationtemplate_2db9c29b2e15 |
GET /ConversationTemplate/{id} | Retorna um template de WhatsApp por idDescrição da APIEste endpoint retorna os detalhes de um template de conversa especificado pelo identificador. | zild_get_conversationtemplate_id_81a744baeb1f |
PUT /ConversationTemplate/{id} | Atualiza um template de WhatsAppDescrição da APIEste 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 WhatsAppDescrição da APIEste endpoint deleta template de WhatsApp. | zild_delete_conversationtemplate_id_78c6d16c4f7e |
POST /ConversationTemplate/{id}/check-approval | Verifica manualmente o status de aprovaçãoDescrição da APIEste 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 contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
POST /Conversation/export | Exporta conversas por filtroDescrição da APIEste endpoint retorna todas as conversas que atendem ao filtro informado, com itens de checklist opcionais. | zild_post_conversation_export_83914eb76ba2 |
GET /Conversation/paged | Retorna conversas paginadasDescrição da APIEste endpoint retorna as conversas paginadas conforme o filtro informado. | zild_get_conversation_paged_8777cc7449d2 |
GET /Conversation/{id} | Retorna uma conversa por idDescrição da APIEste endpoint retorna os detalhes de uma conversa especificada pelo identificador. | zild_get_conversation_id_499ae9457461 |
GET /Message | Retorna mensagens por conversaDescrição da APIEste endpoint retorna as mensagens de uma conversa especificada pelo identificador da conversa. | zild_get_message_f14013758dfb |
POST /Message | Cria uma nova mensagemDescrição da APIEste endpoint cria uma nova mensagem, opcionalmente com arquivo, para uma conversa. | zild_post_message_dd1c2cb71f86 |
POST /Message/resend | Reenvia uma mensagemDescrição da APIEste endpoint reenvia uma mensagem já existente pelo seu identificador. | zild_post_message_resend_11e4db8122c8 |
GET /Message/{id} | Retorna uma mensagem por idDescrição da APIEste endpoint retorna os detalhes de uma mensagem especificada pelo identificador. | zild_get_message_id_e2575153d29b |
PUT /Message/{id} | Atualiza uma mensagemDescrição da APIEste endpoint atualiza os dados de uma mensagem existente identificada pelo id. | zild_put_message_id_19b6e597d699 |
PUT /Message/{messageId}/read | Marca uma mensagem como lida pelo usuárioDescrição da APIEste endpoint marca uma mensagem específica como lida pelo usuário. | zild_put_message_messageid_read_6b89be4f8644 |
Documentos (6)
| Operação e contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
POST /Document | Cria um novo documentoDescrição da APIEste endpoint cria um novo documento, opcionalmente com arquivo, com os dados fornecidos. | zild_post_document_550502414b9f |
GET /Document/dashboard | Retorna dashboard de documentosDescrição da APIEste 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 | Retorna documentos paginadosDescrição da APIEste endpoint retorna documentos paginados conforme o filtro informado. | zild_get_document_paged_090de02b746f |
GET /Document/{id} | Retorna um documento por idDescrição da APIEste endpoint retorna os detalhes de um documento especificado pelo identificador. | zild_get_document_id_a13894680bb2 |
DELETE /Document/{id} | Remove um documentoDescrição da APIEste endpoint remove um documento existente identificado pelo id. | zild_delete_document_id_5ecae91db708 |
POST /Document/{id}/reprocess | Reprocessa um documentoDescrição da APIEste endpoint reprocessa um documento existente identificado pelo id. | zild_post_document_id_reprocess_1470ac0c91a9 |
Flow (24)
| Operação e contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
GET /Flow | Lista fluxosDescrição da APIRetorna a lista de fluxos do tenant do usuário autenticado. | zild_get_flow_96ec9435526f |
POST /Flow | Cria fluxoDescrição da APICria um registro de fluxo com os dados do corpo da requisição e retorna o registro criado. | zild_post_flow_1c87790c6811 |
GET /Flow/dashboard | Consulta indicadores de fluxos e tarefasDescrição da APIRetorna 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 IDDescrição da APIRetorna 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 fluxoDescrição da APIAtualiza 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 fluxoDescrição da APIExclui o registro de fluxo identificado por id. Retorna 204 sem conteúdo. | zild_delete_flow_id_e2092f067f1d |
GET /FlowRecurringTask | Lista recorrências de tarefasDescrição da APIRetorna a lista de recorrências de tarefas do tenant do usuário autenticado. | zild_get_flowrecurringtask_697550d65a44 |
POST /FlowRecurringTask | Cria recorrência de tarefasDescrição da APICadastra 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 IDDescrição da APIRetorna 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 tarefasDescrição da APIAtualiza 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 tarefasDescrição da APIExclui o registro de recorrência de tarefas identificado por id. Retorna 204 sem conteúdo. | zild_delete_flowrecurringtask_id_84b453427dbc |
GET /FlowRecurringTask/{id}/occurrences | Consulta próximas ocorrências de uma recorrênciaDescrição da APIRetorna 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 | Cria raia de fluxoDescrição da APICadastra 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 IDDescrição da APIRetorna 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 fluxoDescrição da APIAtualiza 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 fluxoDescrição da APIExclui o registro de raia de fluxo identificado por id. Retorna 204 sem conteúdo. | zild_delete_flowstage_id_c30ed03e7b3d |
POST /FlowTask | Cria tarefa de fluxoDescrição da APICadastra 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 IDDescrição da APIRetorna 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 fluxoDescrição da APIAtualiza 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 fluxoDescrição da APIExclui o registro de tarefa de fluxo identificado por id. Retorna 204 sem conteúdo. | zild_delete_flowtask_id_8cd5dc4068f6 |
POST /FlowTaskHistory | Cria registro de histórico de tarefaDescrição da APICadastra 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 IDDescrição da APIRetorna 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 tarefaDescrição da APIAtualiza 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 tarefaDescrição da APIExclui 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 contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
GET /AgentMcpConnection | Lista conexões MCP de um agenteDescrição da APIRetorna 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 | Associa conector MCP a um agenteDescrição da APICria 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 | Descobre ferramentas de um conector MCPDescrição da APIConecta 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 IDDescrição da APIRetorna 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 MCPDescrição da APIAtualiza 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 agenteDescrição da APIExclui 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 contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
GET /Department | Lista departamentosDescrição da APIRetorna os departamentos do tenant do usuário autenticado. | zild_get_department_a3e131e08369 |
POST /Department | Cria departamentoDescrição da APICria 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 | Consulta consumo e cota do tenantDescrição da APIRetorna 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 IDDescrição da APIRetorna 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 membrosDescrição da APIAtualiza 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 departamentoDescrição da APIExclui 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 | Consulta consumo e cotas de um departamentoDescrição da APIRetorna 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 contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
POST /ConsumptionDashboard | Consulta indicadores de consumoDescrição da APIConsulta 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 contrato | Finalidade | Ferramenta MCP prevista |
|---|---|---|
GET /Webhook | Lista webhooksDescrição da APIRetorna 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 | Cadastra webhookDescrição da APICadastra 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 IDDescrição da APIRetorna a configuração do webhook identificado por id no tenant autenticado. Requer ViewWebhooks. | zild_get_webhook_id_50ff5d5af22d |
PUT /Webhook/{id} | Atualiza webhookDescrição da APIAtualiza 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 APIEsta 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 |