Documentação
Guias da plataforma, manuais dos apps e referência da API Zild.
- Começando — Oriente o primeiro projeto Zild: escolha o problema, defina o fluxo e entenda o que precisa estar pronto antes da implementação.
- O que é a Zild? — A Zild é uma AI Agent Management Platform (AMP): a camada operacional que conecta agentes de IA a modelos, contexto de negócio, canais, ações e governança.
- Como funciona — Veja o ciclo operacional da Zild: entrada, contexto, decisão, ação, handoff, registro e melhoria contínua.
- Guia rápido — Checklist prático para preparar, testar e colocar o primeiro fluxo Zild em produção com segurança.
- Visão geral da Plataforma Zild — A Zild é uma plataforma de gestão de agentes de IA para criar, operar, integrar, monitorar e governar agentes em canais e processos corporativos.
- Autenticação e autorização — A Zild usa tokens de acesso, claims JWT, contexto de tenant, papéis, grupos e permissões efetivas para controlar o acesso entre apps e serviços.
- Papéis e permissões — O Zild Admin centraliza usuários, grupos, papéis e escopos para que cada pessoa acesse somente os apps, dados e ações necessários ao seu trabalho.
- Integrações da plataforma — A Zild conecta canais de comunicação, sistemas internos, plataformas de automação, telefonia, provedores de IA e ferramentas de desktop com governança.
- Zild Admin — Use o Zild Admin para gerenciar o tenant, usuários, grupos, permissões, agentes, conexões, integrações, cobrança e configurações compartilhadas.
- Agentes — Use esta tela para consultar, filtrar, criar, editar ou excluir agentes. Ela é o ponto de partida para administrar esses registros.
- Criar agente — Use esta tela para cadastrar agente. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar agente — Use esta tela para revisar, alterar ou excluir agente. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Bases de conhecimento — Use esta tela para consultar, filtrar, criar, editar ou excluir bases de conhecimento. Ela é o ponto de partida para administrar esses registros.
- Criar base de conhecimento — Use esta tela para cadastrar base de conhecimento. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar base de conhecimento — Use esta tela para revisar, alterar ou excluir base de conhecimento. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Habilidades — Use esta tela para consultar, filtrar, criar, editar ou excluir habilidades. Ela é o ponto de partida para administrar esses registros.
- Criar habilidade — Use esta tela para cadastrar habilidade. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar habilidade — Use esta tela para revisar, alterar ou excluir habilidade. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Categorias de agentes — Use esta tela para consultar, filtrar, criar, editar ou excluir categorias de agentes. Ela é o ponto de partida para administrar esses registros.
- Criar categoria de agente — Use esta tela para cadastrar categoria de agente. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar categoria de agente — Use esta tela para revisar, alterar ou excluir categoria de agente. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Backlog dos agentes — Use esta tela para consultar, filtrar, criar, editar ou excluir backlog dos agentes. Ela é o ponto de partida para administrar esses registros.
- Criar item de backlog — Use esta tela para cadastrar item de backlog. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar item de backlog — Use esta tela para revisar, alterar ou excluir item de backlog. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Conversas — Use esta tela para consultar, filtrar, criar, editar ou excluir conversas. Ela é o ponto de partida para administrar esses registros.
- Editar conversa — Use esta tela para revisar, alterar ou excluir conversa. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Campos personalizados — Use esta tela para consultar, filtrar, criar, editar ou excluir campos personalizados. Ela é o ponto de partida para administrar esses registros.
- Criar campo personalizado — Use esta tela para cadastrar campo personalizado. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar campo personalizado — Use esta tela para revisar, alterar ou excluir campo personalizado. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Usuários — Use esta tela para consultar, filtrar, criar, editar ou excluir usuários. Ela é o ponto de partida para administrar esses registros.
- Criar usuário — Use esta tela para cadastrar usuário. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar usuário — Use esta tela para revisar, alterar ou excluir usuário. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Grupos — Use esta tela para consultar, filtrar, criar, editar ou excluir grupos. Ela é o ponto de partida para administrar esses registros.
- Criar grupo — Use esta tela para cadastrar grupo. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar grupo — Use esta tela para revisar, alterar ou excluir grupo. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Perfis de acesso — Use esta tela para consultar, filtrar, criar, editar ou excluir perfis de acesso. Ela é o ponto de partida para administrar esses registros.
- Criar perfil de acesso — Use esta tela para cadastrar perfil de acesso. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar perfil de acesso — Use esta tela para revisar, alterar ou excluir perfil de acesso. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Integrações — Use esta tela para consultar, filtrar, criar, editar ou excluir integrações. Ela é o ponto de partida para administrar esses registros.
- Webhooks — Entenda quando cada webhook da Zild é enviado e consulte os payloads entregues ao seu endpoint.
- Criar webhook — Use esta tela para cadastrar webhook. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar webhook — Use esta tela para revisar, alterar ou excluir webhook. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Assinatura — Use esta tela para consultar, filtrar, criar, editar ou excluir assinatura. Ela é o ponto de partida para administrar esses registros.
- Faturas — Use esta tela para consultar, filtrar, criar, editar ou excluir faturas. Ela é o ponto de partida para administrar esses registros.
- Editar fatura — Use esta tela para revisar, alterar ou excluir fatura. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Área de trabalho — Use esta tela do Zild Admin para executar a atividade de área de trabalho no dia a dia.
- Zild Assist — Use o Zild Assist para operar atendimento com IA por WhatsApp, e-mail e jornadas de webchat compatíveis, com handoff humano e contexto preservado.
- Dashboard — Use esta tela para acompanhar indicadores e identificar situações que precisam de atenção no Zild Assist.
- Atendimento ao vivo — Use esta tela do Zild Assist para executar a atividade de atendimento ao vivo no dia a dia.
- Editar live — Use esta tela para revisar, alterar ou excluir live. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Bulk Import — Use esta tela para consultar, filtrar, criar, editar ou excluir bulk import. Ela é o ponto de partida para administrar esses registros.
- Editar bulk import — Use esta tela para revisar, alterar ou excluir bulk import. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- History — Use esta tela para consultar, filtrar, criar, editar ou excluir history. Ela é o ponto de partida para administrar esses registros.
- Editar history — Use esta tela para revisar, alterar ou excluir history. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Contatos — Use esta tela para consultar, filtrar, criar, editar ou excluir contatos. Ela é o ponto de partida para administrar esses registros.
- Criar contato — Use esta tela para cadastrar contato. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar contato — Use esta tela para revisar, alterar ou excluir contato. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar contato — Use esta tela para revisar, alterar ou excluir contato. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Contas — Use esta tela para consultar, filtrar, criar, editar ou excluir contas. Ela é o ponto de partida para administrar esses registros.
- Criar conta — Use esta tela para cadastrar conta. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar conta — Use esta tela para revisar, alterar ou excluir conta. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar conta — Use esta tela para revisar, alterar ou excluir conta. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Agentes — Use esta tela para consultar, filtrar, criar, editar ou excluir agentes. Ela é o ponto de partida para administrar esses registros.
- Criar agente — Use esta tela para cadastrar agente. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar agente — Use esta tela para revisar, alterar ou excluir agente. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Filas — Use esta tela para consultar, filtrar, criar, editar ou excluir filas. Ela é o ponto de partida para administrar esses registros.
- Criar fila — Use esta tela para cadastrar fila. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar fila — Use esta tela para revisar, alterar ou excluir fila. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar fila — Use esta tela para revisar, alterar ou excluir fila. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Modelos de conversa — Use esta tela para consultar, filtrar, criar, editar ou excluir modelos de conversa. Ela é o ponto de partida para administrar esses registros.
- Criar modelo de conversa — Use esta tela para cadastrar modelo de conversa. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar modelo de conversa — Use esta tela para revisar, alterar ou excluir modelo de conversa. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar modelo de conversa — Use esta tela para revisar, alterar ou excluir modelo de conversa. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Motivos de encerramento — Use esta tela para consultar, filtrar, criar, editar ou excluir motivos de encerramento. Ela é o ponto de partida para administrar esses registros.
- Criar motivo de encerramento — Use esta tela para cadastrar motivo de encerramento. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar motivo de encerramento — Use esta tela para revisar, alterar ou excluir motivo de encerramento. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar motivo de encerramento — Use esta tela para revisar, alterar ou excluir motivo de encerramento. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Etiquetas — Use esta tela para consultar, filtrar, criar, editar ou excluir etiquetas. Ela é o ponto de partida para administrar esses registros.
- Criar etiqueta — Use esta tela para cadastrar etiqueta. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar etiqueta — Use esta tela para revisar, alterar ou excluir etiqueta. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar etiqueta — Use esta tela para revisar, alterar ou excluir etiqueta. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Zild Chat — Use o Zild Chat como interface conversacional governada para colaboradores acessarem agentes aprovados, conhecimento corporativo e tarefas compatíveis.
- Explorar agentes — Use esta tela do Zild Chat para executar a atividade de explorar agentes no dia a dia.
- Editar chat — Use esta tela para revisar, alterar ou excluir chat. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Criar chat — Use esta tela para cadastrar chat. Ela reúne os campos necessários para configurar o item antes de salvar.
- Agentes — Use esta tela para consultar, filtrar, criar, editar ou excluir agentes. Ela é o ponto de partida para administrar esses registros.
- Criar agente — Use esta tela para cadastrar agente. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar agente — Use esta tela para revisar, alterar ou excluir agente. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar histórico do agente — Use esta tela para revisar, alterar ou excluir histórico do agente. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Zild Coach — Use o Zild Coach para realizar simulações e role-plays por voz, aplicar critérios de avaliação, fornecer feedback e acompanhar o treinamento da equipe.
- Dashboard — Use esta tela para acompanhar indicadores e identificar situações que precisam de atenção no Zild Coach.
- Monitoria — Use esta tela do Zild Coach para executar a atividade de monitoria no dia a dia.
- Editar monitor — Use esta tela para revisar, alterar ou excluir monitor. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Tasks — Use esta tela para consultar, filtrar, criar, editar ou excluir tasks. Ela é o ponto de partida para administrar esses registros.
- Agentes — Use esta tela para consultar, filtrar, criar, editar ou excluir agentes. Ela é o ponto de partida para administrar esses registros.
- Criar agente — Use esta tela para cadastrar agente. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar agente — Use esta tela para revisar, alterar ou excluir agente. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar training — Use esta tela para revisar, alterar ou excluir training. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Zild Docs — Use o Zild Docs para leitura e OCR, extração estruturada, validação, revisão assistida de documentos e processamento rastreável de back-office.
- Dashboard — Use esta tela para acompanhar indicadores e identificar situações que precisam de atenção no Zild Docs.
- Documentos — Use esta tela para consultar, filtrar, criar, editar ou excluir documentos. Ela é o ponto de partida para administrar esses registros.
- Criar documento — Use esta tela para cadastrar documento. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar documento — Use esta tela para revisar, alterar ou excluir documento. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Status de documentos — Use esta tela para consultar, filtrar, criar, editar ou excluir status de documentos. Ela é o ponto de partida para administrar esses registros.
- Editar status de documento — Use esta tela para revisar, alterar ou excluir status de documento. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Checklists de documentos — Use esta tela para consultar, filtrar, criar, editar ou excluir checklists de documentos. Ela é o ponto de partida para administrar esses registros.
- Criar checklist de documento — Use esta tela para cadastrar checklist de documento. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar checklist de documento — Use esta tela para revisar, alterar ou excluir checklist de documento. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Zild Insight — Use o Zild Insight para monitoramento de conversas, pontuação de qualidade, checklists, extração estruturada e análise de desempenho baseada em evidências.
- Dashboard — Use esta tela para acompanhar indicadores e identificar situações que precisam de atenção no Zild Insight.
- Monitoria — Use esta tela do Zild Insight para executar a atividade de monitoria no dia a dia.
- Editar monitor — Use esta tela para revisar, alterar ou excluir monitor. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar chat — Use esta tela para revisar, alterar ou excluir chat. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Criar chat — Use esta tela para cadastrar chat. Ela reúne os campos necessários para configurar o item antes de salvar.
- Checklists — Use esta tela para consultar, filtrar, criar, editar ou excluir checklists. Ela é o ponto de partida para administrar esses registros.
- Criar checklist — Use esta tela para cadastrar checklist. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar checklist — Use esta tela para revisar, alterar ou excluir checklist. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Grupos do checklist — Use esta tela para consultar, filtrar, criar, editar ou excluir grupos do checklist. Ela é o ponto de partida para administrar esses registros.
- Criar grupo do checklist — Use esta tela para cadastrar grupo do checklist. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar grupo do checklist — Use esta tela para revisar, alterar ou excluir grupo do checklist. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Scripts do checklist — Use esta tela para consultar, filtrar, criar, editar ou excluir scripts do checklist. Ela é o ponto de partida para administrar esses registros.
- Criar script do checklist — Use esta tela para cadastrar script do checklist. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar script do checklist — Use esta tela para revisar, alterar ou excluir script do checklist. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Filas — Use esta tela para consultar, filtrar, criar, editar ou excluir filas. Ela é o ponto de partida para administrar esses registros.
- Criar fila — Use esta tela para cadastrar fila. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar fila — Use esta tela para revisar, alterar ou excluir fila. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar fila — Use esta tela para revisar, alterar ou excluir fila. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Zild Portal — Use o Zild Portal como ponto de entrada do usuário de negócio para agentes, solicitações e capacidades de IA habilitadas dentro do escopo autorizado.
- Início — Use esta tela do Zild Portal para executar a atividade de início no dia a dia.
- Agentes — Use esta tela para consultar, filtrar, criar, editar ou excluir agentes. Ela é o ponto de partida para administrar esses registros.
- Criar agente — Use esta tela para cadastrar agente. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar agente — Use esta tela para revisar, alterar ou excluir agente. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Solicitações de criação de agente — Use esta tela para consultar, filtrar, criar, editar ou excluir solicitações de criação de agente. Ela é o ponto de partida para administrar esses registros.
- Cadastro — Use esta tela do Zild Portal para executar a atividade de cadastro no dia a dia.
- Zild Flow — Gerencie tarefas associadas a pessoas ou agentes de IA com uma visualização clara da execução de processos.
- Dashboard de tarefas — Use esta tela para acompanhar indicadores e identificar situações que precisam de atenção no Zild Flow.
- Agent — Use esta tela para consultar, filtrar, criar, editar ou excluir agent. Ela é o ponto de partida para administrar esses registros.
- Criar agent — Use esta tela para cadastrar agent. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar agent — Use esta tela para revisar, alterar ou excluir agent. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- History — Use esta tela para consultar, filtrar, criar, editar ou excluir history. Ela é o ponto de partida para administrar esses registros.
- Editar history — Use esta tela para revisar, alterar ou excluir history. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Zild Voice — Use o Zild Voice para operar chamadas receptivas e ativas com IA, SIP ou PSTN, transcrição, integrações corporativas e handoff humano.
- Dashboard — Use esta tela para acompanhar indicadores e identificar situações que precisam de atenção no Zild Voice.
- Agentes — Use esta tela para consultar, filtrar, criar, editar ou excluir agentes. Ela é o ponto de partida para administrar esses registros.
- Criar agente — Use esta tela para cadastrar agente. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar agente — Use esta tela para revisar, alterar ou excluir agente. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Chamadas em lote — Use esta tela para consultar, filtrar, criar, editar ou excluir chamadas em lote. Ela é o ponto de partida para administrar esses registros.
- Editar chamada em lote — Use esta tela para revisar, alterar ou excluir chamada em lote. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Softphone — Use esta tela do Zild Voice para executar a atividade de softphone no dia a dia.
- Números de telefone — Use esta tela para consultar, filtrar, criar, editar ou excluir números de telefone. Ela é o ponto de partida para administrar esses registros.
- Criar número de telefone — Use esta tela para cadastrar número de telefone. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar número de telefone — Use esta tela para revisar, alterar ou excluir número de telefone. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Contatos — Use esta tela para consultar, filtrar, criar, editar ou excluir contatos. Ela é o ponto de partida para administrar esses registros.
- Criar contato — Use esta tela para cadastrar contato. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar contato — Use esta tela para revisar, alterar ou excluir contato. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar contato — Use esta tela para revisar, alterar ou excluir contato. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Contas — Use esta tela para consultar, filtrar, criar, editar ou excluir contas. Ela é o ponto de partida para administrar esses registros.
- Criar conta — Use esta tela para cadastrar conta. Ela reúne os campos necessários para configurar o item antes de salvar.
- Editar conta — Use esta tela para revisar, alterar ou excluir conta. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Editar conta — Use esta tela para revisar, alterar ou excluir conta. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- History — Use esta tela para consultar, filtrar, criar, editar ou excluir history. Ela é o ponto de partida para administrar esses registros.
- Editar history — Use esta tela para revisar, alterar ou excluir history. Antes de salvar, confira se a mudança não afeta outros fluxos do sistema.
- Visão geral de segurança — A Zild trata identidade, segregação por tenant, criptografia, proteção de segredos, prevenção de abuso, minimização de dados, observabilidade e auditoria como controles transversais.
- Compliance e auditoria — A Zild apoia requisitos corporativos com controles de identidade, segregação por tenant, fluxos de dados protegidos, integrações aprovadas e ações rastreáveis.
- Privacidade de dados — A Zild minimiza os dados compartilhados com provedores de IA e canais externos, limita o contexto armazenado, protege valores sensíveis e prioriza opções de retenção zero quando disponíveis.
- Criptografia — A Zild protege os dados em trânsito entre usuários, serviços, canais e provedores, além de proteger os dados persistidos em armazenamento gerenciado e Azure SQL.
- Perguntas frequentes — Respostas objetivas para dúvidas comuns sobre implantação, canais, governança, APIs e evolução da plataforma.
- Introdução à API — Integre com a API Zild usando o contrato OpenAPI atual, autenticação por API Key e exemplos completos de requisição e resposta.
- Conceitos centrais da API — O modelo de produto e dados por trás das integrações Zild: conversas, agentes, canais, filas, templates, avaliações, tarefas e documentos.
- Ciclo de vida da conversa — Como uma conversa Zild vai da entrada ao atendimento por IA, handoff humano, avaliação, relatórios e follow-up.
- Webhooks disponíveis — Configure webhooks para receber eventos da Zild, incluindo todas as mudanças de status de documentos no Zild Docs.
- Erros, retentativas e segurança operacional — Como desenhar integrações confiáveis com a API Zild sem duplicar conversas ou ignorar guardrails.
- Como acessar a Zild API — Gere uma API Key de usuário, entenda o escopo de permissões e conecte ferramentas como Claude Code e Codex diretamente à API da Zild.
- Listar contas — Este endpoint retorna todas as contas cadastradas.
- Criar conta — Este endpoint cria uma nova conta com os dados fornecidos no corpo da requisição.
- Consultar conta — Este endpoint retorna os detalhes de uma conta especificada pelo identificador.
- Atualizar conta — Este endpoint atualiza os dados de uma conta existente identificada pelo id.
- Excluir conta — Este endpoint deleta uma conta existente identificada pelo id.
- Listar agentes — Listar agentes. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar agente — Criar agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Consultar agente — Consultar agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Atualizar agente — Atualizar agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Excluir agente — Excluir agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Anexar arquivo ao agente — Anexar arquivo ao agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Remover arquivo do agente — Remover arquivo do agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Adicionar conhecimento web ao agente — Adicionar conhecimento web ao agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Atualizar conhecimento web do agente — Atualizar conhecimento web do agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar chamada telefônica — Criar chamada telefônica. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar chamadas em lote — Criar chamadas em lote. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Listar vozes disponíveis — Listar vozes disponíveis. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Listar ferramentas de voz — Listar ferramentas de voz. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Referenciar ferramenta de voz — Referenciar ferramenta de voz. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Remover referência de ferramenta de voz — Remover referência de ferramenta de voz. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Listar modelos da ElevenLabs — Listar modelos da ElevenLabs. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Enviar logo do agente — Enviar logo do agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Remover logo do agente — Remover logo do agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar conversa com agente — Criar conversa com agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Executar agente — Executar agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Listar fontes de conhecimento — Este endpoint retorna todos os conhecimentos de agente cadastrados.
- Criar fonte de conhecimento — Este endpoint cria um novo conhecimento de agente com os dados fornecidos.
- Consultar fonte de conhecimento — Este endpoint retorna os detalhes de um conhecimento de agente especificado pelo identificador.
- Atualizar fonte de conhecimento — Este endpoint atualiza os dados de um conhecimento de agente existente identificado pelo id.
- Excluir fonte de conhecimento — Este endpoint remove um conhecimento de agente existente identificado pelo id.
- Listar habilidades — Este endpoint retorna as skills do tenant e as skills globais habilitadas.
- Criar habilidade — Este endpoint cria uma nova skill para o tenant atual.
- Consultar habilidade — Este endpoint retorna os detalhes de uma skill especificada pelo identificador.
- Atualizar habilidade — Este endpoint atualiza uma skill do tenant atual.
- Excluir habilidade — Este endpoint remove uma skill do tenant atual.
- Consultar variável de coleta de dados do agente — Este endpoint retorna os detalhes de uma variável de coleta de dados de agente especificada pelo identificador.
- Atualizar variável de coleta de dados do agente — Este endpoint atualiza os dados de uma variável de coleta de dados de agente existente identificada pelo id.
- Excluir variável de coleta de dados do agente — Este endpoint remove uma variável de coleta de dados de agente existente identificada pelo id.
- Criar variável de coleta de dados do agente — Este endpoint cria uma nova variável de coleta de dados de agente com os dados fornecidos.
- Consultar variável dinâmica do agente — Este endpoint retorna os detalhes de uma variável dinâmica de agente especificada pelo identificador.
- Atualizar variável dinâmica do agente — Este endpoint atualiza os dados de uma variável dinâmica de agente existente identificada pelo id.
- Excluir variável dinâmica do agente — Este endpoint remove uma variável dinâmica de agente existente identificada pelo id.
- Criar variável dinâmica do agente — Este endpoint cria uma nova variável dinâmica de agente com os dados fornecidos.
- Consultar registro do histórico do agente — Este endpoint retorna os detalhes de um registro de histórico específico.
- Consultar versão específica do agente — Este endpoint retorna o estado do agente em uma versão específica.
- Filtrar histórico do agente — Este endpoint permite filtrar o histórico por agente (obrigatório), usuário, tipo de ação e período. Suporta paginação.
- Restaurar versão do agente — Este endpoint reverte o agente para o estado de uma versão específica.
- Consultar ferramenta do agente — Este endpoint retorna os detalhes de uma ferramenta de agente especificada pelo identificador.
- Atualizar ferramenta do agente — Este endpoint atualiza os dados de uma ferramenta de agente existente identificada pelo id.
- Excluir ferramenta do agente — Este endpoint remove uma ferramenta de agente existente identificada pelo id.
- Listar ferramentas do agente — Este endpoint retorna todas as ferramentas de um Agente de IA pelo identificador do Agente de IA.
- Criar ferramenta do agente — Este endpoint cria uma nova ferramenta de agente com os dados fornecidos.
- Listar checklists — Este endpoint retorna todos os checklists cadastrados.
- Criar checklist — Este endpoint cria um novo checklist com os dados fornecidos.
- Consultar checklist — Este endpoint retorna os detalhes de um checklist especificado pelo identificador.
- Atualizar checklist — Este endpoint atualiza os dados de um checklist existente identificado pelo id.
- Listar itens de checklist — Este endpoint retorna os itens de um checklist específico.
- Criar item de checklist — Este endpoint cria um novo item de checklist com os dados fornecidos.
- Consultar item de checklist — Este endpoint retorna os detalhes de um item de checklist especificado pelo identificador.
- Atualizar item de checklist — Este endpoint atualiza os dados de um item de checklist existente identificado pelo id.
- Excluir item de checklist — Este endpoint deleta um item de checklist. Só é possível deletar se o item não estiver vinculado a nenhuma conversa.
- Listar contatos — Este endpoint retorna todos os contatos cadastrados.
- Criar contato — Este endpoint cria um novo contato com os dados fornecidos no corpo da requisição.
- Listar contatos por conta — Este endpoint retorna todos os contatos vinculados a uma conta específica.
- Consultar contato — Este endpoint retorna os detalhes de um contato especificado pelo identificador.
- Atualizar contato — Este endpoint atualiza os dados de um contato existente identificado pelo id.
- Excluir contato — Este endpoint exclui um contato existente identificado pelo id.
- Processar e-mail recebido — Este endpoint recebe e e-mails e envia para o Agente de IA responder.
- Listar conversas com paginação — Este endpoint retorna as conversas paginadas conforme o filtro informado.
- Exportar conversas — Este endpoint retorna todas as conversas que atendem ao filtro informado, com itens de checklist opcionais.
- Consultar conversa — Este endpoint retorna os detalhes de uma conversa especificada pelo identificador.
- Reavaliar checklist da conversa — Este endpoint dispara a reavaliação do checklist de uma ou mais conversas.
- Criar conversa proativa no WhatsApp — Este endpoint cria uma conversa proativa com os dados fornecidos.
- Conectar chamada telefônica a usuário — Este endpoint cria uma ligação telefônica para um usuário interno e conecta com o cliente.
- Listar mensagens por conversa — Este endpoint retorna as mensagens de uma conversa especificada pelo identificador da conversa.
- Criar mensagem — Este endpoint cria uma nova mensagem, opcionalmente com arquivo, para uma conversa.
- Consultar mensagem — Este endpoint retorna os detalhes de uma mensagem especificada pelo identificador.
- Atualizar mensagem — Este endpoint atualiza os dados de uma mensagem existente identificada pelo id.
- Reenviar mensagem — Este endpoint reenvia uma mensagem já existente pelo seu identificador.
- Marcar mensagem como lida — Este endpoint marca uma mensagem específica como lida pelo usuário.
- Listar templates de conversa — Este endpoint retorna templates de conversa conforme os filtros informados.
- Criar template de conversa — Este endpoint cria um novo template de conversa com os dados fornecidos.
- Consultar template de conversa — Este endpoint retorna os detalhes de um template de conversa especificado pelo identificador.
- Atualizar template de conversa — Este endpoint atualiza os dados de um template de conversa existente identificado pelo id.
- Excluir template de conversa — Este endpoint deleta template de WhatsApp.
- Verificar aprovação do template — Este endpoint dispara uma verificação manual do status de aprovação do template de conversa no provedor.
- Introdução — Veja como enviar um arquivo, acompanhar o processamento assíncrono e receber o resultado pelo webhook DocumentCompleted.
- Listar documentos com paginação — Este endpoint retorna documentos paginados conforme o filtro informado.
- Consultar dashboard de documentos — Este endpoint retorna informações resumidas e estatísticas dos documentos para exibição em dashboard. Permite filtrar por período (createdAtStart e createdAtEnd).
- Consultar documento — Este endpoint retorna os detalhes de um documento especificado pelo identificador.
- Excluir documento — Este endpoint remove um documento existente identificado pelo id.
- Criar documento — Este endpoint cria um novo documento, opcionalmente com arquivo, com os dados fornecidos.
- Reprocessar documento — Este endpoint reprocessa um documento existente identificado pelo id.
- Consultar dashboard do Flow — Consultar dashboard do Flow. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Listar fluxos — Listar fluxos. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar fluxo — Criar fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Consultar fluxo — Consultar fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Atualizar fluxo — Atualizar fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Excluir fluxo — Excluir fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Listar ocorrências da tarefa recorrente — Listar ocorrências da tarefa recorrente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Listar tarefas recorrentes — Listar tarefas recorrentes. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar tarefa recorrente — Criar tarefa recorrente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Consultar tarefa recorrente — Consultar tarefa recorrente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Atualizar tarefa recorrente — Atualizar tarefa recorrente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Excluir tarefa recorrente — Excluir tarefa recorrente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Consultar etapa do fluxo — Consultar etapa do fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Atualizar etapa do fluxo — Atualizar etapa do fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Excluir etapa do fluxo — Excluir etapa do fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar etapa do fluxo — Criar etapa do fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Consultar tarefa do fluxo — Consultar tarefa do fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Atualizar tarefa do fluxo — Atualizar tarefa do fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Excluir tarefa do fluxo — Excluir tarefa do fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar tarefa do fluxo — Criar tarefa do fluxo. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Consultar histórico da tarefa — Consultar histórico da tarefa. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Atualizar histórico da tarefa — Atualizar histórico da tarefa. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Excluir histórico da tarefa — Excluir histórico da tarefa. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar histórico da tarefa — Criar histórico da tarefa. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Importar áudio para o Insight — Este endpoint cria uma conversa a partir de um arquivo de audio e metadados.
- Importar conversas do Microsoft Teams — Este endpoint importa conversas originadas do Microsoft Teams.
- Listar consumo da assinatura — Listar consumo da assinatura. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Listar webhooks — Listar webhooks. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Criar webhook — Criar webhook. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Consultar webhook — Consultar webhook. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Atualizar webhook — Atualizar webhook. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
- Excluir webhook — Excluir webhook. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.