{"openapi":"3.0.3","info":{"title":"Agents","version":"0.0.1"},"servers":[{"url":"https://api.meuassistente.rdstationmentoria.com.br/rest"}],"paths":{"/agents":{"get":{"operationId":"agents-list","summary":"Listar assistentes","description":"Lista assistentes com base nos parâmetros fornecidos.","tags":["Agents"],"security":[{"Authorization":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","minimum":1,"default":1},"description":"Número da página"},{"name":"size","in":"query","required":false,"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"description":"Tamanho da página"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Texto livre para busca pelo nome do assistente"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do assistente"},"name":{"type":"string","description":"Nome do assistente"},"description":{"type":"string","nullable":true,"default":null,"description":"Instruções ao modelo de IA para direcionar a geração de respostas desejadas"},"avatar":{"type":"object","properties":{"url":{"type":"string","description":"URL do arquivo"},"title":{"type":"string","nullable":true,"default":null,"description":"Título do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave única do arquivo"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Imagem associada ao arquivo"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição do arquivo"}},"required":["url"],"additionalProperties":false,"nullable":true,"default":null,"description":"Avatar do assistente"},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","default":"#ff5722","description":"Cor associada ao assistente"},"welcome":{"type":"string","nullable":true,"default":null,"description":"Mensagem de boas-vindas do assistente"},"instructions":{"type":"string","nullable":true,"default":null,"description":"Instruções para o assistente"},"off":{"type":"string","nullable":true,"default":null,"description":"Mensagem quando o assistente não souber a resposta"},"references":{"type":"boolean","default":false,"description":"Indica se o assistente usa referências"},"purpose":{"type":"string","enum":["general","leads","cs"],"description":"Finalidade do assistente","default":"leads"},"freedom":{"type":"string","enum":["free","restricted"],"default":"restricted","description":"Uso da base de conhecimento"},"behavior_type":{"type":"string","enum":["basic","custom"],"default":"basic","description":"Configuração de comportamento do assistente"},"status":{"type":"string","enum":["online","offline","draft"],"description":"Status do assistente","default":"draft"},"left":{"type":"boolean","default":false,"description":"Posição do widget do assistente à esquerda da tela"},"model":{"type":"string","nullable":true,"default":null,"description":"Modelo de IA do assistente"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.404Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.404Z","description":"Data da última atualização"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true}},"required":["id","name","workspaceId","createdBy","updatedBy"],"additionalProperties":false},"description":"Lista de registros da página"},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total de registros"},"page":{"type":"number","description":"Número da página atual"},"size":{"type":"number","description":"Quantidade de registros da página"},"first":{"type":"number","description":"Primeira página"},"last":{"type":"number","description":"Última página"},"next":{"type":"number","nullable":true,"description":"Próxima página"},"previous":{"type":"number","nullable":true,"description":"Página anterior"}},"required":["total","page","size","first","last","next","previous"],"additionalProperties":false,"description":"Metadados da página"}},"required":["data","meta"],"additionalProperties":false,"description":"Página de registros"}}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"agents-create","summary":"Criar assistente","description":"Cria um novo assistente com as configurações fornecidas.","tags":["Agents"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","nullable":true,"default":null,"description":"Instruções ao modelo de IA para direcionar a geração de respostas desejadas"},"purpose":{"type":"string","enum":["general","leads","cs"],"description":"Finalidade do assistente","default":"leads"},"kbs":{"type":"array","items":{"type":"string","description":"Identificador único da base de conhecimento"},"default":[],"description":"Bases de conhecimento associadas ao assistente"},"fields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","description":"Identificador único do campo"},"position":{"type":"number"},"required":{"type":"boolean"},"description":{"type":"string","nullable":true}},"required":["fieldId","position","required","description"],"additionalProperties":false},"default":[],"description":"Campos do assistente"},"name":{"type":"string","description":"Nome do assistente"},"avatar":{"type":"object","properties":{"url":{"type":"string","description":"URL do arquivo"},"title":{"type":"string","nullable":true,"default":null,"description":"Título do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave única do arquivo"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Imagem associada ao arquivo"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição do arquivo"}},"required":["url"],"additionalProperties":false,"nullable":true,"default":null,"description":"Avatar do assistente"},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","default":"#ff5722","description":"Cor associada ao assistente"},"status":{"type":"string","enum":["online","offline","draft"],"description":"Status do assistente","default":"draft"},"destinations":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["rdcrm","rd","exact","email","whatsapp"],"description":"Tipo de destino da qualificação"},"credentials":{"type":"object","additionalProperties":{},"description":"Credenciais utilizadas para envio ao destino"},"qualification":{"type":"object","additionalProperties":{"type":"object","properties":{"operator":{"type":"string","enum":["equals"],"description":"Operador utilizado para comparação"},"value":{"description":"Valor a ser comparado"},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo"}},"required":["operator","type"],"additionalProperties":false,"description":"Critério de qualificação com operador, valor e tipo"},"default":{},"description":"Mapa de critérios utilizados para qualificação"}},"required":["type","credentials"],"additionalProperties":false},"default":[],"description":"Destinos associados ao agente"},"behavior":{"type":"object","properties":{"answerLength":{"type":"string","enum":["short","medium","long"],"default":"short","description":"Comprimento da resposta do agente"},"personality":{"type":"string","enum":["fun","professional","personal"],"default":"personal","description":"Personalidade do agente"},"engagement":{"type":"string","enum":["active","passive"],"default":"active","description":"Nível de engajamento do agente"}},"additionalProperties":false,"nullable":true,"default":{"answerLength":"short","personality":"personal","engagement":"active"},"description":"Comportamento configurável do assistente"},"behavior_type":{"type":"string","enum":["basic","custom"],"default":"basic","description":"Configuração de comportamento do assistente"},"left":{"type":"boolean","default":false,"description":"Posição do widget do assistente à esquerda da tela"}},"required":["name"],"additionalProperties":false}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do assistente"},"name":{"type":"string","description":"Nome do assistente"},"description":{"type":"string","nullable":true,"default":null,"description":"Instruções ao modelo de IA para direcionar a geração de respostas desejadas"},"avatar":{"type":"object","properties":{"url":{"type":"string","description":"URL do arquivo"},"title":{"type":"string","nullable":true,"default":null,"description":"Título do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave única do arquivo"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Imagem associada ao arquivo"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição do arquivo"}},"required":["url"],"additionalProperties":false,"nullable":true,"default":null,"description":"Avatar do assistente"},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","default":"#ff5722","description":"Cor associada ao assistente"},"welcome":{"type":"string","nullable":true,"default":null,"description":"Mensagem de boas-vindas do assistente"},"instructions":{"type":"string","nullable":true,"default":null,"description":"Instruções para o assistente"},"off":{"type":"string","nullable":true,"default":null,"description":"Mensagem quando o assistente não souber a resposta"},"references":{"type":"boolean","default":false,"description":"Indica se o assistente usa referências"},"purpose":{"type":"string","enum":["general","leads","cs"],"description":"Finalidade do assistente","default":"leads"},"freedom":{"type":"string","enum":["free","restricted"],"default":"restricted","description":"Uso da base de conhecimento"},"behavior_type":{"type":"string","enum":["basic","custom"],"default":"basic","description":"Configuração de comportamento do assistente"},"status":{"type":"string","enum":["online","offline","draft"],"description":"Status do assistente","default":"draft"},"left":{"type":"boolean","default":false,"description":"Posição do widget do assistente à esquerda da tela"},"model":{"type":"string","nullable":true,"default":null,"description":"Modelo de IA do assistente"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.464Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.464Z","description":"Data da última atualização"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true}},"required":["id","name","workspaceId","createdBy","updatedBy"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}}},"/agents/{id}":{"get":{"operationId":"agents-get","summary":"Obter assistente","description":"Recupera os detalhes de um assistente.","tags":["Agents"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do assistente"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do assistente"},"name":{"type":"string","description":"Nome do assistente"},"description":{"type":"string","nullable":true,"default":null,"description":"Instruções ao modelo de IA para direcionar a geração de respostas desejadas"},"avatar":{"type":"object","properties":{"url":{"type":"string","description":"URL do arquivo"},"title":{"type":"string","nullable":true,"default":null,"description":"Título do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave única do arquivo"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Imagem associada ao arquivo"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição do arquivo"}},"required":["url"],"additionalProperties":false,"nullable":true,"default":null,"description":"Avatar do assistente"},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","default":"#ff5722","description":"Cor associada ao assistente"},"welcome":{"type":"string","nullable":true,"default":null,"description":"Mensagem de boas-vindas do assistente"},"instructions":{"type":"string","nullable":true,"default":null,"description":"Instruções para o assistente"},"off":{"type":"string","nullable":true,"default":null,"description":"Mensagem quando o assistente não souber a resposta"},"references":{"type":"boolean","default":false,"description":"Indica se o assistente usa referências"},"purpose":{"type":"string","enum":["general","leads","cs"],"description":"Finalidade do assistente","default":"leads"},"freedom":{"type":"string","enum":["free","restricted"],"default":"restricted","description":"Uso da base de conhecimento"},"behavior_type":{"type":"string","enum":["basic","custom"],"default":"basic","description":"Configuração de comportamento do assistente"},"status":{"type":"string","enum":["online","offline","draft"],"description":"Status do assistente","default":"draft"},"left":{"type":"boolean","default":false,"description":"Posição do widget do assistente à esquerda da tela"},"model":{"type":"string","nullable":true,"default":null,"description":"Modelo de IA do assistente"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.407Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.448Z","description":"Data da última atualização"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true},"kbs":{"type":"array","items":{"type":"string","description":"Identificador único da base de conhecimento"},"default":[],"description":"Bases de conhecimento associadas ao assistente"},"destinations":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["rdcrm","rd","exact","email","whatsapp"],"description":"Tipo de destino da qualificação"},"credentials":{"type":"object","additionalProperties":{},"description":"Credenciais utilizadas para envio ao destino"},"qualification":{"type":"object","additionalProperties":{"type":"object","properties":{"operator":{"type":"string","enum":["equals"],"description":"Operador utilizado para comparação"},"value":{"description":"Valor a ser comparado"},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo"}},"required":["operator","type"],"additionalProperties":false,"description":"Critério de qualificação com operador, valor e tipo"},"default":{},"description":"Mapa de critérios utilizados para qualificação"}},"required":["type","credentials"],"additionalProperties":false},"default":[],"description":"Destinos associados ao agente"},"fields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","description":"Identificador único do campo"},"position":{"type":"number"},"required":{"type":"boolean"},"description":{"type":"string","nullable":true}},"required":["fieldId","position","required","description"],"additionalProperties":false},"default":[],"description":"Campos do assistente"},"behavior":{"type":"object","properties":{"answerLength":{"type":"string","enum":["short","medium","long"],"default":"short","description":"Comprimento da resposta do agente"},"personality":{"type":"string","enum":["fun","professional","personal"],"default":"personal","description":"Personalidade do agente"},"engagement":{"type":"string","enum":["active","passive"],"default":"active","description":"Nível de engajamento do agente"}},"additionalProperties":false,"nullable":true,"default":{"answerLength":"short","personality":"personal","engagement":"active"},"description":"Comportamento configurável do assistente"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"agentId":{"type":"string","description":"Identificador do assistente"},"connectorId":{"type":"string","description":"ID do conector"},"status":{"type":"string","enum":["pending_auth","connected","expired","revoked","error"],"default":"pending_auth"},"qualification":{"type":"object","additionalProperties":{"type":"object","properties":{"operator":{"type":"string","enum":["equals"],"description":"Operador utilizado para comparação"},"value":{"description":"Valor a ser comparado"},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo"}},"required":["operator","type"],"additionalProperties":false,"description":"Critério de qualificação com operador, valor e tipo"},"default":{},"description":"Mapa de critérios utilizados para qualificação"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"connector":{"type":"object","properties":{"id":{"type":"string","description":"ID do conector"},"name":{"type":"string","description":"Nome"},"url":{"type":"string","format":"uri","description":"URL (stateless HTTP stream)"},"settingsUrl":{"type":"string","format":"uri","nullable":true,"default":null,"description":"URL de configuração"},"oneLiner":{"type":"string","description":"Descrição em uma linha"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição detalhada"},"logo":{"type":"string","nullable":true,"default":null,"description":"Logo"},"scope":{"type":"array","items":{"type":"string"},"description":"Escopos"},"headers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"description":"Headers"},"custom":{"type":"boolean","default":true,"description":"É um conector personalizado?"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"}},"required":["id","name","url","oneLiner","scope","headers","workspaceId"],"additionalProperties":false},"tools":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"type":"string","nullable":true,"default":null},"description":{"type":"string","nullable":true,"default":null},"inputSchema":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean","default":true}},"required":["id","name","inputSchema"],"additionalProperties":false},"default":[]}},"required":["id","agentId","connectorId","workspaceId","connector"],"additionalProperties":false},"default":[],"description":"Conectores habilitados"}},"required":["id","name","workspaceId","createdBy","updatedBy"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}},"put":{"operationId":"agents-update","summary":"Atualizar assistente","description":"Atualiza os dados de um assistente.","tags":["Agents"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome do assistente"},"description":{"type":"string","nullable":true,"default":null,"description":"Instruções ao modelo de IA para direcionar a geração de respostas desejadas"},"avatar":{"type":"object","properties":{"url":{"type":"string","description":"URL do arquivo"},"title":{"type":"string","nullable":true,"default":null,"description":"Título do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave única do arquivo"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Imagem associada ao arquivo"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição do arquivo"}},"required":["url"],"additionalProperties":false,"nullable":true,"default":null,"description":"Avatar do assistente"},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","default":"#ff5722","description":"Cor associada ao assistente"},"welcome":{"type":"string","nullable":true,"default":null,"description":"Mensagem de boas-vindas do assistente"},"instructions":{"type":"string","nullable":true,"default":null,"description":"Instruções para o assistente"},"off":{"type":"string","nullable":true,"default":null,"description":"Mensagem quando o assistente não souber a resposta"},"references":{"type":"boolean","default":false,"description":"Indica se o assistente usa referências"},"purpose":{"type":"string","enum":["general","leads","cs"],"description":"Finalidade do assistente","default":"leads"},"freedom":{"type":"string","enum":["free","restricted"],"default":"restricted","description":"Uso da base de conhecimento"},"behavior_type":{"type":"string","enum":["basic","custom"],"default":"basic","description":"Configuração de comportamento do assistente"},"status":{"type":"string","enum":["online","offline","draft"],"description":"Status do assistente","default":"draft"},"left":{"type":"boolean","default":false,"description":"Posição do widget do assistente à esquerda da tela"},"kbs":{"type":"array","items":{"type":"string","description":"Identificador único da base de conhecimento"},"default":[],"description":"Bases de conhecimento associadas ao assistente"},"destinations":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["rdcrm","rd","exact","email","whatsapp"],"description":"Tipo de destino da qualificação"},"credentials":{"type":"object","additionalProperties":{},"description":"Credenciais utilizadas para envio ao destino"},"qualification":{"type":"object","additionalProperties":{"type":"object","properties":{"operator":{"type":"string","enum":["equals"],"description":"Operador utilizado para comparação"},"value":{"description":"Valor a ser comparado"},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo"}},"required":["operator","type"],"additionalProperties":false,"description":"Critério de qualificação com operador, valor e tipo"},"default":{},"description":"Mapa de critérios utilizados para qualificação"}},"required":["type","credentials"],"additionalProperties":false},"default":[],"description":"Destinos associados ao agente"},"fields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","description":"Identificador único do campo"},"position":{"type":"number"},"required":{"type":"boolean"},"description":{"type":"string","nullable":true}},"required":["fieldId","position","required","description"],"additionalProperties":false},"default":[],"description":"Campos do assistente"},"behavior":{"type":"object","properties":{"answerLength":{"type":"string","enum":["short","medium","long"],"default":"short","description":"Comprimento da resposta do agente"},"personality":{"type":"string","enum":["fun","professional","personal"],"default":"personal","description":"Personalidade do agente"},"engagement":{"type":"string","enum":["active","passive"],"default":"active","description":"Nível de engajamento do agente"}},"additionalProperties":false,"nullable":true,"default":{"answerLength":"short","personality":"personal","engagement":"active"},"description":"Comportamento configurável do assistente"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"agentId":{"type":"string","description":"Identificador do assistente"},"connectorId":{"type":"string","description":"ID do conector"},"status":{"type":"string","enum":["pending_auth","connected","expired","revoked","error"],"default":"pending_auth"},"qualification":{"type":"object","additionalProperties":{"type":"object","properties":{"operator":{"type":"string","enum":["equals"],"description":"Operador utilizado para comparação"},"value":{"description":"Valor a ser comparado"},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo"}},"required":["operator","type"],"additionalProperties":false,"description":"Critério de qualificação com operador, valor e tipo"},"default":{},"description":"Mapa de critérios utilizados para qualificação"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"connector":{"type":"object","properties":{"id":{"type":"string","description":"ID do conector"},"name":{"type":"string","description":"Nome"},"url":{"type":"string","format":"uri","description":"URL (stateless HTTP stream)"},"settingsUrl":{"type":"string","format":"uri","nullable":true,"default":null,"description":"URL de configuração"},"oneLiner":{"type":"string","description":"Descrição em uma linha"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição detalhada"},"logo":{"type":"string","nullable":true,"default":null,"description":"Logo"},"scope":{"type":"array","items":{"type":"string"},"description":"Escopos"},"headers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"description":"Headers"},"custom":{"type":"boolean","default":true,"description":"É um conector personalizado?"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"}},"required":["id","name","url","oneLiner","scope","headers","workspaceId"],"additionalProperties":false},"tools":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"type":"string","nullable":true,"default":null},"description":{"type":"string","nullable":true,"default":null},"inputSchema":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean","default":true}},"required":["id","name","inputSchema"],"additionalProperties":false},"default":[]}},"required":["id","agentId","connectorId","workspaceId","connector"],"additionalProperties":false},"default":[],"description":"Conectores habilitados"}},"required":["name"],"additionalProperties":false}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do assistente"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"agents-remove","summary":"Remover assistente","description":"Remove um assistente.","tags":["Agents"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do assistente"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}},"/connections/auth/callback":{"get":{"operationId":"connections-callback","parameters":[{"name":"code","in":"query","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}},"/conversations/{id}":{"get":{"operationId":"conversations-get","summary":"Obter conversa","description":"Recupera as mensagens de uma conversa.","tags":["Conversations"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador da conversa"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da conversa"},"title":{"type":"string","description":"Título"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.467Z","description":"Data de criação"},"status":{"type":"string","enum":["active","finished"],"description":"Status","default":"active"},"summary":{"type":"string","nullable":true,"default":null,"description":"Resumo da conversa"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mensagem"},"conversationId":{"type":"string","description":"Identificador da conversa"},"role":{"type":"string","enum":["system","assistant","user","tool","function"],"description":"Define quem está enviando a mensagem"},"name":{"type":"string","nullable":true,"default":null,"description":"Nome do participante da conversa"},"content":{"type":"string","nullable":true,"default":null,"description":"Conteúdo da mensagem"},"toolCallId":{"type":"string","nullable":true,"default":null,"description":"Identificador da chamada de ferramenta associada"},"toolCalls":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da chamada de ferramenta"},"type":{"type":"string","enum":["function"],"description":"Tipo da chamada, sempre `function`"},"function":{"type":"object","properties":{"name":{"type":"string","description":"Nome da função chamada pela ferramenta"},"arguments":{"type":"string","description":"Argumentos fornecidos como entrada para a função"}},"required":["name","arguments"],"additionalProperties":false,"description":"Chamada de função"}},"required":["id","type","function"],"additionalProperties":false,"description":"Chamada de ferramenta"},"nullable":true,"default":null,"description":"Lista de chamadas de ferramentas associadas à mensagem"},"metadata":{"type":"object","additionalProperties":{},"default":{},"description":"Metadados adicionais da mensagem"},"feedback":{"type":"boolean","nullable":true,"default":null,"description":"Feedback do usuário para a mensagem — `true` para positivo, `false` para negativo"},"usage":{"type":"object","properties":{"promptTokens":{"type":"number","description":"Quantidade de tokens usados no prompt"},"completionTokens":{"type":"number","description":"Quantidade de tokens usados na conclusão"},"cachedTokens":{"type":"number","description":"Quantidade de tokens recuperados do cache"}},"additionalProperties":false,"description":"Informações de uso"},"attachments":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["image","audio"],"description":"Tipos de anexos"},"url":{"type":"string","description":"URL do arquivo de mídia anexado"},"content":{"type":"string","nullable":true,"default":null,"description":"Conteúdo adicional ao anexo"}},"required":["type","url"],"additionalProperties":false,"description":"Anexo de mensagem"},"nullable":true,"default":[],"description":"Anexos da mensagem"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.468Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.468Z","description":"Data da última atualização"}},"required":["id","conversationId","role","usage"],"additionalProperties":false},"default":[],"description":"\nHistórico completo de mensagens trocadas nesta conversa, ordenadas cronologicamente.\n\nCada mensagem possui:\n\n* `id`: identificador único da mensagem\n* `conversationId`: identificador da conversa à qual a mensagem pertence\n* `role`: quem falou (system, assistant, user, tool)\n* `name`: nome associado à mensagem, se aplicável\n* `content`: conteúdo textual da mensagem\n* `toolCallId`: identificador da chamada de ferramenta associada, se houver\n* `toolCalls`: lista de chamadas de ferramentas associadas, se houver\n* `metadata`: metadados adicionais em formato livre\n* `feedback`: indica se há feedback (booleano ou null)\n* `usage`: informações de uso, como tokens (se disponíveis)\n* `createdAt` e `updatedAt`: datas de criação e atualização da mensagem\n\n### Exemplo de retorno\n\n```json\n[\n  {\n    \"id\": \"msg_abc123\",\n    \"conversationId\": \"convo_001\",\n    \"role\": \"user\",\n    \"name\": \"João\",\n    \"content\": \"Olá, tudo bem?\",\n    \"createdAt\": \"2025-07-08T14:30:00.000Z\",\n    \"updatedAt\": \"2025-07-08T14:30:00.000Z\"\n  },\n  {\n    \"id\": \"msg_def456\",\n    \"conversationId\": \"convo_001\",\n    \"role\": \"assistant\",\n    \"name\": null,\n    \"content\": \"Olá! Como posso te ajudar?\",\n    \"feedback\": true,\n    \"usage\": {\n      \"inputTokens\": 6,\n      \"outputTokens\": 9,\n      \"totalTokens\": 15\n    },\n    \"createdAt\": \"2025-07-08T14:30:02.000Z\",\n    \"updatedAt\": \"2025-07-08T14:30:02.000Z\"\n  }\n]\n```\n"}},"required":["id","title"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"conversations-delete","summary":"Remover conversa","description":"Remove uma conversa.","tags":["Conversations"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador da conversa"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}},"/conversations/list/{agentId}":{"get":{"operationId":"conversations-list","summary":"Listar conversas","description":"Lista as conversas associadas a um assistente.","tags":["Conversations"],"security":[{"Authorization":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","minimum":1,"default":1},"description":"Número da página"},{"name":"size","in":"query","required":false,"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"description":"Tamanho da página"},{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do assistente"},{"name":"createdAtStart","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Data de criação"},{"name":"feedback","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da conversa"},"title":{"type":"string","description":"Título"},"agentId":{"type":"string","description":"Identificador do assistente"},"leadId":{"type":"string","description":"Identificador do lead","nullable":true,"default":null},"channelId":{"type":"string","description":"Identificador do canal"},"platform":{"type":"string","enum":["api","widget","slack"],"description":"Canal"},"stage":{"type":"string","enum":["identify","operational"],"description":"Estágio atual","default":"identify"},"context":{"type":"object","additionalProperties":{},"description":"Contexto adicional"},"platformUserIdentifier":{"type":"string","description":"Identificador do usuário na plataforma de origem"},"preview":{"type":"boolean","default":false,"description":"Se a conversa foi criada em modo de preview."},"summary":{"type":"string","nullable":true,"default":null,"description":"Resumo da conversa"},"status":{"type":"string","enum":["active","finished"],"description":"Status","default":"active"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.469Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.469Z","description":"Data da última atualização"},"lead":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do lead"},"name":{"type":"string","nullable":true,"default":null,"description":"Nome"},"email":{"type":"string","nullable":true,"default":null,"description":"Email"},"company":{"type":"string","nullable":true,"default":null,"description":"Empresa"},"phone":{"type":"string","nullable":true,"default":null,"description":"Telefone"},"site":{"type":"string","nullable":true,"default":null,"description":"Site"}},"required":["id"],"additionalProperties":false,"description":"Dados do lead","nullable":true,"default":null}},"required":["id","title","agentId","channelId","platform","context","platformUserIdentifier","workspaceId"],"additionalProperties":false},"description":"Lista de registros da página"},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total de registros"},"page":{"type":"number","description":"Número da página atual"},"size":{"type":"number","description":"Quantidade de registros da página"},"first":{"type":"number","description":"Primeira página"},"last":{"type":"number","description":"Última página"},"next":{"type":"number","nullable":true,"description":"Próxima página"},"previous":{"type":"number","nullable":true,"description":"Página anterior"}},"required":["total","page","size","first","last","next","previous"],"additionalProperties":false,"description":"Metadados da página"}},"required":["data","meta"],"additionalProperties":false,"description":"Página de registros"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/agents/{agentId}/channels":{"get":{"operationId":"channels-list","summary":"Listar canais","description":"Lista todos os canais associados a um assistente.","tags":["Channels"],"security":[{"Authorization":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","minimum":1,"default":1},"description":"Número da página"},{"name":"size","in":"query","required":false,"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"description":"Tamanho da página"},{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do assistente"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string","enum":["api","widget","slack"],"description":"Canal"},"id":{"type":"string","description":"Identificador do canal"}},"required":["platform","id"],"additionalProperties":false},"description":"Lista de registros da página"},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total de registros"},"page":{"type":"number","description":"Número da página atual"},"size":{"type":"number","description":"Quantidade de registros da página"},"first":{"type":"number","description":"Primeira página"},"last":{"type":"number","description":"Última página"},"next":{"type":"number","nullable":true,"description":"Próxima página"},"previous":{"type":"number","nullable":true,"description":"Página anterior"}},"required":["total","page","size","first","last","next","previous"],"additionalProperties":false,"description":"Metadados da página"}},"required":["data","meta"],"additionalProperties":false,"description":"Página de registros"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/fields":{"get":{"operationId":"fields-list","summary":"Listar campos","description":"Lista os campos com base nos parâmetros fornecidos.","tags":["Fields"],"security":[{"Authorization":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","minimum":1,"default":1},"description":"Número da página"},{"name":"size","in":"query","required":false,"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"description":"Tamanho da página"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Termo de busca para filtrar os campos"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do campo"},"name":{"type":"string","description":"Nome do campo"},"description":{"type":"string","description":"Descrição do campo"},"active":{"type":"boolean","default":true,"description":"Indica se o campo está ativo"},"fixed":{"type":"boolean","default":false},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo","default":"text"},"options":{"type":"array","items":{"type":"string"},"default":[],"description":"Lista de opções para campos do tipo `choice` ou `multi_choice`"},"new":{"type":"boolean","default":false,"description":"Flag de compatibilidade (integrações)"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.470Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.470Z","description":"Data da última atualização"}},"required":["id","name","description","workspaceId","createdBy","updatedBy"],"additionalProperties":false},"description":"Lista de registros da página"},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total de registros"},"page":{"type":"number","description":"Número da página atual"},"size":{"type":"number","description":"Quantidade de registros da página"},"first":{"type":"number","description":"Primeira página"},"last":{"type":"number","description":"Última página"},"next":{"type":"number","nullable":true,"description":"Próxima página"},"previous":{"type":"number","nullable":true,"description":"Página anterior"}},"required":["total","page","size","first","last","next","previous"],"additionalProperties":false,"description":"Metadados da página"}},"required":["data","meta"],"additionalProperties":false,"description":"Página de registros"}}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"fields-new","summary":"Criar campo","description":"Cria um novo campo.","tags":["Fields"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome do campo"},"description":{"type":"string","description":"Descrição do campo"},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo","default":"text"},"options":{"type":"array","items":{"type":"string"},"default":[],"description":"Lista de opções para campos do tipo `choice` ou `multi_choice`"}},"required":["name","description"],"additionalProperties":false}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do campo"},"name":{"type":"string","description":"Nome do campo"},"description":{"type":"string","description":"Descrição do campo"},"active":{"type":"boolean","default":true,"description":"Indica se o campo está ativo"},"fixed":{"type":"boolean","default":false},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo","default":"text"},"options":{"type":"array","items":{"type":"string"},"default":[],"description":"Lista de opções para campos do tipo `choice` ou `multi_choice`"},"new":{"type":"boolean","default":false,"description":"Flag de compatibilidade (integrações)"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.471Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.471Z","description":"Data da última atualização"}},"required":["id","name","description","workspaceId","createdBy","updatedBy"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}}},"/fields/{id}":{"get":{"operationId":"fields-get","summary":"Obter campo","description":"Recupera detalhes de um campo.","tags":["Fields"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do campo"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do campo"},"name":{"type":"string","description":"Nome do campo"},"description":{"type":"string","description":"Descrição do campo"},"active":{"type":"boolean","default":true,"description":"Indica se o campo está ativo"},"fixed":{"type":"boolean","default":false},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo","default":"text"},"options":{"type":"array","items":{"type":"string"},"default":[],"description":"Lista de opções para campos do tipo `choice` ou `multi_choice`"},"new":{"type":"boolean","default":false,"description":"Flag de compatibilidade (integrações)"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.471Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.471Z","description":"Data da última atualização"}},"required":["id","name","description","workspaceId","createdBy","updatedBy"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}},"put":{"operationId":"fields-update","summary":"Atualizar campo","description":"Atualiza as informações de um campo.","tags":["Fields"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome do campo"},"description":{"type":"string","description":"Descrição do campo"},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo","default":"text"},"options":{"type":"array","items":{"type":"string"},"default":[],"description":"Lista de opções para campos do tipo `choice` ou `multi_choice`"}},"required":["name","description"],"additionalProperties":false}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do campo"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do campo"},"name":{"type":"string","description":"Nome do campo"},"description":{"type":"string","description":"Descrição do campo"},"active":{"type":"boolean","default":true,"description":"Indica se o campo está ativo"},"fixed":{"type":"boolean","default":false},"type":{"type":"string","enum":["text","email","phone","number","url","boolean","date","choice","multi_choice","cpf","cnpj"],"description":"Tipo do campo","default":"text"},"options":{"type":"array","items":{"type":"string"},"default":[],"description":"Lista de opções para campos do tipo `choice` ou `multi_choice`"},"new":{"type":"boolean","default":false,"description":"Flag de compatibilidade (integrações)"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.472Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.472Z","description":"Data da última atualização"}},"required":["id","name","description","workspaceId","createdBy","updatedBy"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}}},"/fields/{id}/enable":{"put":{"operationId":"fields-enable","summary":"Ativar campo","description":"Ativa um campo, permitindo que seja utilizado em assistentes.","tags":["Fields"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do campo"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}},"/fields/{id}/disable":{"put":{"operationId":"fields-disable","summary":"Inativar campo","description":"Inativa um campo, impedindo seu uso por assistentes.","tags":["Fields"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do campo"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}},"/leads":{"get":{"operationId":"leads-list","summary":"Listar leads","description":"Lista leads com base nos parâmetros fornecidos.","tags":["Leads"],"security":[{"Authorization":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","minimum":1,"default":1},"description":"Número da página"},{"name":"size","in":"query","required":false,"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"description":"Tamanho da página"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Termo de pesquisa (full-text search)"},{"name":"name","in":"query","required":false,"schema":{"type":"string"},"description":"Nome"},{"name":"email","in":"query","required":false,"schema":{"type":"string"},"description":"Email"},{"name":"phone","in":"query","required":false,"schema":{"type":"string"},"description":"Telefone"},{"name":"orderBy","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"string","enum":["createdAtDesc","nameAsc"],"description":"Ordenação da lista de leads"}],"default":"createdAtDesc"},"description":"Ordenação da lista de leads"},{"name":"createdAtStart","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Data de criação"},{"name":"agentId","in":"query","required":false,"schema":{"type":"string"},"description":"Identificador do assistente"},{"name":"capture","in":"query","required":false,"schema":{"type":"string","enum":["completed","partial"]},"description":"Status da captura de dados do lead"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do lead"},"agentId":{"type":"string","description":"Assistente que capturou o lead","nullable":true,"default":null},"name":{"type":"string","nullable":true,"default":null,"description":"Nome"},"email":{"type":"string","nullable":true,"default":null,"description":"Email"},"phone":{"type":"string","nullable":true,"default":null,"description":"Telefone"},"company":{"type":"string","nullable":true,"default":null,"description":"Empresa"},"site":{"type":"string","nullable":true,"default":null,"description":"Site"},"custom":{"type":"object","additionalProperties":{"description":"Valor do campo"},"default":{},"description":"Campos"},"utm":{"type":"object","properties":{"source":{"type":"string","nullable":true,"description":"Fonte (`utm_source`)"},"medium":{"type":"string","nullable":true,"description":"Meio (`utm_medium`)"},"campaign":{"type":"string","nullable":true,"description":"Campanha (`utm_campaign`)"},"content":{"type":"string","nullable":true,"description":"Conteúdo (`utm_content`)"},"term":{"type":"string","nullable":true,"description":"Termo (`utm_term`)"}},"additionalProperties":false,"description":"Informações de rastreamento UTM","default":{}},"capture":{"type":"string","enum":["completed","partial"],"description":"Status da captura de dados do lead","default":"completed"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.473Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.473Z","description":"Data da última atualização"}},"required":["id","workspaceId"],"additionalProperties":false,"description":"Dados do lead"},"description":"Lista de registros da página"},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total de registros"},"page":{"type":"number","description":"Número da página atual"},"size":{"type":"number","description":"Quantidade de registros da página"},"first":{"type":"number","description":"Primeira página"},"last":{"type":"number","description":"Última página"},"next":{"type":"number","nullable":true,"description":"Próxima página"},"previous":{"type":"number","nullable":true,"description":"Página anterior"}},"required":["total","page","size","first","last","next","previous"],"additionalProperties":false,"description":"Metadados da página"}},"required":["data","meta"],"additionalProperties":false,"description":"Página de registros"}}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"leads-new","summary":"Criar lead","description":"Cria um novo lead.","tags":["Leads"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agentId":{"type":"string","description":"Assistente que capturou o lead","nullable":true,"default":null},"name":{"type":"string","nullable":true,"default":null,"description":"Nome"},"email":{"type":"string","nullable":true,"default":null,"description":"Email"},"phone":{"type":"string","nullable":true,"default":null,"description":"Telefone"},"company":{"type":"string","nullable":true,"default":null,"description":"Empresa"},"site":{"type":"string","nullable":true,"default":null,"description":"Site"},"custom":{"type":"object","additionalProperties":{"description":"Valor do campo"},"default":{},"description":"Campos"},"utm":{"type":"object","properties":{"source":{"type":"string","nullable":true,"description":"Fonte (`utm_source`)"},"medium":{"type":"string","nullable":true,"description":"Meio (`utm_medium`)"},"campaign":{"type":"string","nullable":true,"description":"Campanha (`utm_campaign`)"},"content":{"type":"string","nullable":true,"description":"Conteúdo (`utm_content`)"},"term":{"type":"string","nullable":true,"description":"Termo (`utm_term`)"}},"additionalProperties":false,"description":"Informações de rastreamento UTM","default":{}},"capture":{"type":"string","enum":["completed","partial"],"description":"Status da captura de dados do lead","default":"completed"}},"additionalProperties":false,"description":"Dados do lead"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do lead"},"agentId":{"type":"string","description":"Assistente que capturou o lead","nullable":true,"default":null},"name":{"type":"string","nullable":true,"default":null,"description":"Nome"},"email":{"type":"string","nullable":true,"default":null,"description":"Email"},"phone":{"type":"string","nullable":true,"default":null,"description":"Telefone"},"company":{"type":"string","nullable":true,"default":null,"description":"Empresa"},"site":{"type":"string","nullable":true,"default":null,"description":"Site"},"custom":{"type":"object","additionalProperties":{"description":"Valor do campo"},"default":{},"description":"Campos"},"utm":{"type":"object","properties":{"source":{"type":"string","nullable":true,"description":"Fonte (`utm_source`)"},"medium":{"type":"string","nullable":true,"description":"Meio (`utm_medium`)"},"campaign":{"type":"string","nullable":true,"description":"Campanha (`utm_campaign`)"},"content":{"type":"string","nullable":true,"description":"Conteúdo (`utm_content`)"},"term":{"type":"string","nullable":true,"description":"Termo (`utm_term`)"}},"additionalProperties":false,"description":"Informações de rastreamento UTM","default":{}},"capture":{"type":"string","enum":["completed","partial"],"description":"Status da captura de dados do lead","default":"completed"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.475Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.475Z","description":"Data da última atualização"}},"required":["id","workspaceId"],"additionalProperties":false,"description":"Dados do lead"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/leads/{id}":{"get":{"operationId":"leads-get","summary":"Obter lead","description":"Recupera informações detalhadas de um lead.","tags":["Leads"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do lead"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do lead"},"agentId":{"type":"string","description":"Assistente que capturou o lead","nullable":true,"default":null},"name":{"type":"string","nullable":true,"default":null,"description":"Nome"},"email":{"type":"string","nullable":true,"default":null,"description":"Email"},"phone":{"type":"string","nullable":true,"default":null,"description":"Telefone"},"company":{"type":"string","nullable":true,"default":null,"description":"Empresa"},"site":{"type":"string","nullable":true,"default":null,"description":"Site"},"custom":{"type":"object","additionalProperties":{"description":"Valor do campo"},"default":{},"description":"Campos"},"utm":{"type":"object","properties":{"source":{"type":"string","nullable":true,"description":"Fonte (`utm_source`)"},"medium":{"type":"string","nullable":true,"description":"Meio (`utm_medium`)"},"campaign":{"type":"string","nullable":true,"description":"Campanha (`utm_campaign`)"},"content":{"type":"string","nullable":true,"description":"Conteúdo (`utm_content`)"},"term":{"type":"string","nullable":true,"description":"Termo (`utm_term`)"}},"additionalProperties":false,"description":"Informações de rastreamento UTM","default":{}},"capture":{"type":"string","enum":["completed","partial"],"description":"Status da captura de dados do lead","default":"completed"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.474Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.474Z","description":"Data da última atualização"},"identities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da plataforma externa"},"platform":{"type":"string","description":"Nome da plataforma externa"}},"required":["id","platform"],"additionalProperties":false,"description":"Informações resumidas de identidade externa"},"default":[],"description":"Lista de identidades externas do lead"},"destinations":{"type":"array","items":{"type":"object","properties":{"destinationId":{"type":"string","description":"Id do destino para onde o lead foi enviado"},"contact":{"type":"string","nullable":true,"description":"Contato utilizado na comunicação com o destino"},"type":{"type":"string","enum":["rdcrm","rd","exact","email","whatsapp"],"description":"Tipo de destino da qualificação"}},"required":["destinationId","type"],"additionalProperties":false,"description":"Relacionamento entre o lead e um destino externo"},"default":[],"description":"Destinos associados ao lead"}},"required":["id","workspaceId"],"additionalProperties":false,"description":"Lead com identidades e destinos associados"}}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"leads-remove","summary":"Remover lead","description":"Remove um lead específico pelo ID.","tags":["Leads"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador do lead"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}},"/interactions":{"get":{"operationId":"interactions-current","summary":"Utilização no mês","description":"Recupera dados de utilização do mês corrente.","tags":["Interactions"],"security":[{"Authorization":[]}],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"month":{"type":"string"},"current":{"type":"integer"},"max":{"type":"integer"},"subscriptionId":{"type":"string"}},"required":["month","current","max","subscriptionId"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}}},"/settings":{"get":{"operationId":"settings-get","summary":"Obter configurações","description":"Recupera as configurações atuais da aplicação.","tags":["Settings"],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"merge":{"type":"string","enum":["always","never","assistant"],"description":"Define quando o lead deve ser unificado com outros leads existentes. \n `always`: Leads com e-mails iguais sempre serão unificados\n `never`: Leads com e-mails iguais serão duplicados\n `assistant`: Leads com e-mails iguais serão unificados quando o assistente que capturou as informações for o mesmo","default":"never"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.483Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.484Z","description":"Data da última atualização"}},"required":["workspaceId"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"settings-update","summary":"Atualizar configurações","description":"Atualiza as configurações da aplicação.","tags":["Settings"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"merge":{"type":"string","enum":["always","never","assistant"],"description":"Define quando o lead deve ser unificado com outros leads existentes. \n `always`: Leads com e-mails iguais sempre serão unificados\n `never`: Leads com e-mails iguais serão duplicados\n `assistant`: Leads com e-mails iguais serão unificados quando o assistente que capturou as informações for o mesmo","default":"never"}},"additionalProperties":false}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"merge":{"type":"string","enum":["always","never","assistant"],"description":"Define quando o lead deve ser unificado com outros leads existentes. \n `always`: Leads com e-mails iguais sempre serão unificados\n `never`: Leads com e-mails iguais serão duplicados\n `assistant`: Leads com e-mails iguais serão unificados quando o assistente que capturou as informações for o mesmo","default":"never"},"workspaceId":{"type":"string","description":"Identificador do workspace associado"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.484Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-31T21:06:25.484Z","description":"Data da última atualização"}},"required":["workspaceId"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}}}},"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false}}}}}}}