{"openapi":"3.1.0","info":{"title":"Atendia REST API","version":"2026-07","description":"Referência OpenAPI interativa das operações REST da Atendia. Nos fluxos Perguntar à IA, responde primeiro com a descrição da operação selecionada, em vez de dar uma visão geral de todo o catálogo da API."},"servers":[{"url":"https://api.atendia.pt/api/v1","description":"API de produção da Atendia"}],"tags":[{"name":"Agentes","description":"Cria agentes, consulta configurações, inicia sessões de pré-visualização e gere definições de voz/modelo."},{"name":"Números de telefone","description":"Pesquisa, compra, associa e liberta números de telefone de entrada e de saída."},{"name":"Chamadas e registos","description":"Ingere chamadas concluídas, consulta registos históricos, lê transcrições e controla chamadas em curso."},{"name":"Visão geral","description":"Resumos usados pela visão geral das operações."},{"name":"Chamadas de saída","description":"Pede chamadas com uma chave API, inicia chamadas rápidas, carrega lotes, gere campanhas e consulta o estado das chamadas de saída."},{"name":"Base de conhecimento","description":"Carrega e gere fontes de conhecimento dos agentes."},{"name":"Ferramentas","description":"Configura ferramentas HTTP que os agentes podem chamar durante as conversas."},{"name":"Segredos","description":"Guarda valores secretos redigidos para headers, corpos de webhooks e configuração de ferramentas."},{"name":"Widgets de website","description":"Gere widgets de agentes e sessões públicas no browser."},{"name":"Faturação","description":"Consulta o saldo e o histórico de faturação da organização. Carregamentos, o cartão guardado, o carregamento automático e os dados fiscais são só na consola (proprietários e administradores); as chaves de API só leem."}],"paths":{"/agents":{"post":{"tags":["Agentes"],"summary":"Cria um agente a partir de um template ou de uma configuração vazia.","description":"Endpoint selecionado: POST /agents.\n\nO que faz: Cria um agente a partir de um template ou de uma configuração vazia.\n\nQuando usar: Utiliza esta operação para cria um agente a partir de um template ou de uma configuração vazia.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: agent:create.\n\nCorpo do pedido: name: string, mínimo de 2 caracteres; isActive: boolean; templateId: uuid | business | medical | support | blank | null.\n\nResposta: 201 { success, message, data: Agent }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /agents. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /agents Cria um agente a partir de um template ou de uma configuração vazia. Finalidade: Utiliza esta operação para cria um agente a partir de um template ou de uma configuração vazia. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/agent/agent.route.ts.","operationId":"post-agents","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"name: string, mínimo de 2 caracteres"},"isActive":{"type":"string","description":"isActive: boolean"},"templateId":{"type":"string","description":"templateId: uuid | business | medical | support | blank | null"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"201":{"description":"{ success, message, data: Agent }"}},"x-atendia-source":"apps/server/src/modules/agent/agent.route.ts","x-atendia-permission":"agent:create","x-atendia-ai-context":"POST /agents Cria um agente a partir de um template ou de uma configuração vazia. Finalidade: Utiliza esta operação para cria um agente a partir de um template ou de uma configuração vazia. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para cria um agente a partir de um template ou de uma configuração vazia.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."},"get":{"tags":["Agentes"],"summary":"Lista os agentes da organização ativa.","description":"Endpoint selecionado: GET /agents.\n\nO que faz: Lista os agentes da organização ativa.\n\nQuando usar: Utiliza esta operação para lista os agentes da organização ativa.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: agent:read.\n\nResposta: 200 { success, message, data: Agent[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /agents. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /agents Lista os agentes da organização ativa. Finalidade: Utiliza esta operação para lista os agentes da organização ativa. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/agent/agent.route.ts.","operationId":"get-agents","security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: Agent[] }"}},"x-atendia-source":"apps/server/src/modules/agent/agent.route.ts","x-atendia-permission":"agent:read","x-atendia-ai-context":"GET /agents Lista os agentes da organização ativa. Finalidade: Utiliza esta operação para lista os agentes da organização ativa. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista os agentes da organização ativa.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/agents/voice/catalog":{"get":{"tags":["Agentes"],"summary":"Lista as opções disponíveis de STT, LLM, TTS e voz.","description":"Endpoint selecionado: GET /agents/voice/catalog.\n\nO que faz: Lista as opções disponíveis de STT, LLM, TTS e voz.\n\nQuando usar: Utiliza esta operação para lista as opções disponíveis de stt, llm, tts e voz.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: agentConfiguration:read.\n\nResposta: 200 { success, message, data: VoiceCatalog }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /agents/voice/catalog. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /agents/voice/catalog Lista as opções disponíveis de STT, LLM, TTS e voz. Finalidade: Utiliza esta operação para lista as opções disponíveis de stt, llm, tts e voz. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/agent/agent.route.ts.","operationId":"get-agents-voice-catalog","security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: VoiceCatalog }"}},"x-atendia-source":"apps/server/src/modules/agent/agent.route.ts","x-atendia-permission":"agentConfiguration:read","x-atendia-ai-context":"GET /agents/voice/catalog Lista as opções disponíveis de STT, LLM, TTS e voz. Finalidade: Utiliza esta operação para lista as opções disponíveis de stt, llm, tts e voz. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista as opções disponíveis de stt, llm, tts e voz.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/agents/{agentId}/preview-session":{"post":{"tags":["Agentes"],"summary":"Cria uma sessão de pré-visualização no browser para o agente selecionado. Só na consola: as chaves de API recebem 403.","description":"Endpoint selecionado: POST /agents/{agentId}/preview-session.\n\nO que faz: Cria uma sessão de pré-visualização no browser para o agente selecionado. Só na consola: as chaves de API recebem 403.\n\nQuando usar: Utiliza esta operação para cria uma sessão de pré-visualização no browser para o agente selecionado. só na consola: as chaves de api recebem 403.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: agentConfiguration:read.\n\nParâmetros do caminho: agentId: uuid.\n\nCorpo do pedido: dynamicVariables?: Record<string, string>.\n\nResposta: 200 { success, message, data: PreviewSession }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /agents/{agentId}/preview-session. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /agents/{agentId}/preview-session Cria uma sessão de pré-visualização no browser para o agente selecionado. Só na consola: as chaves de API recebem 403. Finalidade: Utiliza esta operação para cria uma sessão de pré-visualização no browser para o agente selecionado. só na consola: as chaves de api recebem 403. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/agent/agent.route.ts.","operationId":"post-agents-by-agentid-preview-session","parameters":[{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"dynamicVariables":{"type":"string","description":"dynamicVariables?: Record<string, string>"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: PreviewSession }"}},"x-atendia-source":"apps/server/src/modules/agent/agent.route.ts","x-atendia-permission":"agentConfiguration:read","x-atendia-ai-context":"POST /agents/{agentId}/preview-session Cria uma sessão de pré-visualização no browser para o agente selecionado. Só na consola: as chaves de API recebem 403. Finalidade: Utiliza esta operação para cria uma sessão de pré-visualização no browser para o agente selecionado. só na consola: as chaves de api recebem 403. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para cria uma sessão de pré-visualização no browser para o agente selecionado. só na consola: as chaves de api recebem 403.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/agents/{id}":{"patch":{"tags":["Agentes"],"summary":"Atualiza metadados do agente, como o nome, o estado ativo ou o template.","description":"Endpoint selecionado: PATCH /agents/{id}.\n\nO que faz: Atualiza metadados do agente, como o nome, o estado ativo ou o template.\n\nQuando usar: Utiliza esta operação para atualiza metadados do agente, como o nome, o estado ativo ou o template.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: agent:update.\n\nParâmetros do caminho: id: uuid.\n\nCorpo do pedido: name?: string; isActive?: boolean; templateId?: uuid | template slug | null.\n\nResposta: 200 { success, message, data: Agent }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre PATCH /agents/{id}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: PATCH /agents/{id} Atualiza metadados do agente, como o nome, o estado ativo ou o template. Finalidade: Utiliza esta operação para atualiza metadados do agente, como o nome, o estado ativo ou o template. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/agent/agent.route.ts.","operationId":"patch-agents-by-id","parameters":[{"name":"id","in":"path","required":true,"description":"id: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"name?: string"},"isActive":{"type":"string","description":"isActive?: boolean"},"templateId":{"type":"string","description":"templateId?: uuid | template slug | null"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: Agent }"}},"x-atendia-source":"apps/server/src/modules/agent/agent.route.ts","x-atendia-permission":"agent:update","x-atendia-ai-context":"PATCH /agents/{id} Atualiza metadados do agente, como o nome, o estado ativo ou o template. Finalidade: Utiliza esta operação para atualiza metadados do agente, como o nome, o estado ativo ou o template. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para atualiza metadados do agente, como o nome, o estado ativo ou o template.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/agents/{agentId}":{"delete":{"tags":["Agentes"],"summary":"Elimina um agente da organização.","description":"Endpoint selecionado: DELETE /agents/{agentId}.\n\nO que faz: Elimina um agente da organização.\n\nQuando usar: Utiliza esta operação para elimina um agente da organização.\n\nEfeitos secundários e risco: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: agent:delete.\n\nParâmetros do caminho: agentId: uuid.\n\nResposta: 200 { success, message, data: null }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre DELETE /agents/{agentId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: DELETE /agents/{agentId} Elimina um agente da organização. Finalidade: Utiliza esta operação para elimina um agente da organização. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nOrigem: apps/server/src/modules/agent/agent.route.ts.","operationId":"delete-agents-by-agentid","parameters":[{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: null }"}},"x-atendia-source":"apps/server/src/modules/agent/agent.route.ts","x-atendia-permission":"agent:delete","x-atendia-ai-context":"DELETE /agents/{agentId} Elimina um agente da organização. Finalidade: Utiliza esta operação para elimina um agente da organização. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.","x-atendia-use-case":"Utiliza esta operação para elimina um agente da organização.","x-atendia-side-effects":"Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador."}},"/agents/{agentId}/config":{"post":{"tags":["Agentes"],"summary":"Guarda a configuração completa do agente de voz.","description":"Endpoint selecionado: POST /agents/{agentId}/config.\n\nO que faz: Guarda a configuração completa do agente de voz.\n\nQuando usar: Utiliza esta operação para guarda a configuração completa do agente de voz.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: agentConfiguration:create/update.\n\nParâmetros do caminho: agentId: uuid.\n\nCorpo do pedido: agent_language, firstMessage, systemPrompt; llmModel, sttModel, ttsModel, voiceId; realtimeModel? e realtimeVoice? juntos (a voz natural: um modelo e uma voz do catálogo do servidor, por exemplo google/gemini-3.8-live; lista fechada, null e qualquer outro valor são recusados; sem nenhum dos dois, a escolha mantém-se); data_needed[], data_evaluation[]; initiation_webhook?, post_call_webhook?; variables?, preemptive_generation, ivr_navigation_enabled, timezone; max_call_duration_minutes?: inteiro de 1 a 240 ou null (a duração máxima da chamada, em minutos, contada desde que é atendida; ao chegar a esse tempo, o agente diz uma frase de despedida e termina a chamada; uma chamada já passada a uma pessoa não é cortada; null desliga; por omissão 60; se não vier, fica o valor guardado); transferEnabled? e transferDestination? juntos (um número fixo ou móvel português, por exemplo 912 345 678), transferDestination2? e transferDestination3? (o 2.º e o 3.º números, marcados por ordem; nunca repetidos, nunca sem transferDestination), transferInstructions? (máximo de 1000 caracteres), transferMode? (transfer, ask ou both: passar a chamada, perguntar à pessoa ou deixar a pessoa escolher; por omissão transfer).\n\nResposta: 200 { success, message, data: AgentConfiguration }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /agents/{agentId}/config. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /agents/{agentId}/config Guarda a configuração completa do agente de voz. Finalidade: Utiliza esta operação para guarda a configuração completa do agente de voz. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/agent/agent.route.ts.","operationId":"post-agents-by-agentid-config","parameters":[{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"agent_language":{"type":"string","description":"agent_language, firstMessage, systemPrompt"},"llmModel":{"type":"string","description":"llmModel, sttModel, ttsModel, voiceId"},"realtimeModel? e realtimeVoice? juntos (a voz natural":{"type":"string","description":"realtimeModel? e realtimeVoice? juntos (a voz natural: um modelo e uma voz do catálogo do servidor, por exemplo google/gemini-3.8-live; lista fechada, null e qualquer outro valor são recusados; sem nenhum dos dois, a escolha mantém-se)"},"data_needed[]":{"type":"string","description":"data_needed[], data_evaluation[]"},"initiation_webhook":{"type":"string","description":"initiation_webhook?, post_call_webhook?"},"variables":{"type":"string","description":"variables?, preemptive_generation, ivr_navigation_enabled, timezone"},"max_call_duration_minutes":{"type":"string","description":"max_call_duration_minutes?: inteiro de 1 a 240 ou null (a duração máxima da chamada, em minutos, contada desde que é atendida; ao chegar a esse tempo, o agente diz uma frase de despedida e termina a chamada; uma chamada já passada a uma pessoa não é cortada; null desliga; por omissão 60; se não vier, fica o valor guardado)"},"transferEnabled? e transferDestination? juntos (um número fixo ou móvel português":{"type":"string","description":"transferEnabled? e transferDestination? juntos (um número fixo ou móvel português, por exemplo 912 345 678), transferDestination2? e transferDestination3? (o 2.º e o 3.º números, marcados por ordem; nunca repetidos, nunca sem transferDestination), transferInstructions? (máximo de 1000 caracteres), transferMode? (transfer, ask ou both: passar a chamada, perguntar à pessoa ou deixar a pessoa escolher; por omissão transfer)"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: AgentConfiguration }"}},"x-atendia-source":"apps/server/src/modules/agent/agent.route.ts","x-atendia-permission":"agentConfiguration:create/update","x-atendia-ai-context":"POST /agents/{agentId}/config Guarda a configuração completa do agente de voz. Finalidade: Utiliza esta operação para guarda a configuração completa do agente de voz. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para guarda a configuração completa do agente de voz.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."},"get":{"tags":["Agentes"],"summary":"Consulta a configuração guardada do agente de voz.","description":"Endpoint selecionado: GET /agents/{agentId}/config.\n\nO que faz: Consulta a configuração guardada do agente de voz.\n\nQuando usar: Utiliza esta operação para consulta a configuração guardada do agente de voz.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: agentConfiguration:read.\n\nParâmetros do caminho: agentId: uuid.\n\nResposta: 200 { success, message, data: AgentConfiguration }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /agents/{agentId}/config. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /agents/{agentId}/config Consulta a configuração guardada do agente de voz. Finalidade: Utiliza esta operação para consulta a configuração guardada do agente de voz. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/agent/agent.route.ts.","operationId":"get-agents-by-agentid-config","parameters":[{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: AgentConfiguration }"}},"x-atendia-source":"apps/server/src/modules/agent/agent.route.ts","x-atendia-permission":"agentConfiguration:read","x-atendia-ai-context":"GET /agents/{agentId}/config Consulta a configuração guardada do agente de voz. Finalidade: Utiliza esta operação para consulta a configuração guardada do agente de voz. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta a configuração guardada do agente de voz.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/agents/{agentId}/outbound-pending":{"get":{"tags":["Agentes"],"summary":"Conta as chamadas de saída de um agente que ainda estão à espera: as que esperam pelo horário do agente (hoursWaiting), as chamadas de volta por fazer (callbacksPending) e as que esperam por uma nova tentativa automática (retriesPending). voicemailSuspended vem a true enquanto o reconhecimento da caixa de correio estiver suspenso.","description":"Endpoint selecionado: GET /agents/{agentId}/outbound-pending.\n\nO que faz: Conta as chamadas de saída de um agente que ainda estão à espera: as que esperam pelo horário do agente (hoursWaiting), as chamadas de volta por fazer (callbacksPending) e as que esperam por uma nova tentativa automática (retriesPending). voicemailSuspended vem a true enquanto o reconhecimento da caixa de correio estiver suspenso.\n\nQuando usar: Utiliza esta operação para conta as chamadas de saída de um agente que ainda estão à espera: as que esperam pelo horário do agente (hourswaiting), as chamadas de volta por fazer (callbackspending) e as que esperam por uma nova tentativa automática (retriespending). voicemailsuspended vem a true enquanto o reconhecimento da caixa de correio estiver suspenso.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: agentConfiguration:read.\n\nParâmetros do caminho: agentId: uuid.\n\nResposta: 200 { success, data: { hoursWaiting, callbacksPending, voicemailSuspended, retriesPending } }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /agents/{agentId}/outbound-pending. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /agents/{agentId}/outbound-pending Conta as chamadas de saída de um agente que ainda estão à espera: as que esperam pelo horário do agente (hoursWaiting), as chamadas de volta por fazer (callbacksPending) e as que esperam por uma nova tentativa automática (retriesPending). voicemailSuspended vem a true enquanto o reconhecimento da caixa de correio estiver suspenso. Finalidade: Utiliza esta operação para conta as chamadas de saída de um agente que ainda estão à espera: as que esperam pelo horário do agente (hourswaiting), as chamadas de volta por fazer (callbackspending) e as que esperam por uma nova tentativa automática (retriespending). voicemailsuspended vem a true enquanto o reconhecimento da caixa de correio estiver suspenso. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/outbound/outbound-pending.route.ts.","operationId":"get-agents-by-agentid-outbound-pending","parameters":[{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, data: { hoursWaiting, callbacksPending, voicemailSuspended, retriesPending } }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-pending.route.ts","x-atendia-permission":"agentConfiguration:read","x-atendia-ai-context":"GET /agents/{agentId}/outbound-pending Conta as chamadas de saída de um agente que ainda estão à espera: as que esperam pelo horário do agente (hoursWaiting), as chamadas de volta por fazer (callbacksPending) e as que esperam por uma nova tentativa automática (retriesPending). voicemailSuspended vem a true enquanto o reconhecimento da caixa de correio estiver suspenso. Finalidade: Utiliza esta operação para conta as chamadas de saída de um agente que ainda estão à espera: as que esperam pelo horário do agente (hourswaiting), as chamadas de volta por fazer (callbackspending) e as que esperam por uma nova tentativa automática (retriespending). voicemailsuspended vem a true enquanto o reconhecimento da caixa de correio estiver suspenso. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para conta as chamadas de saída de um agente que ainda estão à espera: as que esperam pelo horário do agente (hourswaiting), as chamadas de volta por fazer (callbackspending) e as que esperam por uma nova tentativa automática (retriespending). voicemailsuspended vem a true enquanto o reconhecimento da caixa de correio estiver suspenso.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/numbers/search":{"get":{"tags":["Números de telefone"],"summary":"Pesquisa números disponíveis dos fornecedores e obtém uma cotação assinada de billing alojado antes da compra.","description":"Endpoint selecionado: GET /numbers/search.\n\nO que faz: Pesquisa números disponíveis dos fornecedores e obtém uma cotação assinada de billing alojado antes da compra.\n\nQuando usar: Utiliza esta operação para pesquisa números disponíveis dos fornecedores e obtém uma cotação assinada de billing alojado antes da compra.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Apenas sessão.\n\nPermissão: phoneNumber:create.\n\nParâmetros de query: provider: TELNYX; country: ISO-3166 alpha-2; areaCode?: positive integer; limit?: 1-50.\n\nResposta: 200 { success, message, data: Array<{ phoneNumber, friendlyName, locality?, region?, isoCountry?, providerMonthlyCostMicros, monthlyPriceMicros, quoteId, quoteExpiresAt, rateCatalogVersion }> }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /numbers/search. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /numbers/search Pesquisa números disponíveis dos fornecedores e obtém uma cotação assinada de billing alojado antes da compra. Finalidade: Utiliza esta operação para pesquisa números disponíveis dos fornecedores e obtém uma cotação assinada de billing alojado antes da compra. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/numbers/phone.route.ts.","operationId":"get-numbers-search","parameters":[{"name":"provider","in":"query","required":true,"description":"provider: TELNYX","schema":{"type":"string"}},{"name":"country","in":"query","required":true,"description":"country: ISO-3166 alpha-2","schema":{"type":"string"}},{"name":"areaCode","in":"query","required":false,"description":"areaCode?: positive integer","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"limit?: 1-50","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: Array<{ phoneNumber, friendlyName, locality?, region?, isoCountry?, providerMonthlyCostMicros, monthlyPriceMicros, quoteId, quoteExpiresAt, rateCatalogVersion }> }"}},"x-atendia-source":"apps/server/src/modules/numbers/phone.route.ts","x-atendia-permission":"phoneNumber:create","x-atendia-ai-context":"GET /numbers/search Pesquisa números disponíveis dos fornecedores e obtém uma cotação assinada de billing alojado antes da compra. Finalidade: Utiliza esta operação para pesquisa números disponíveis dos fornecedores e obtém uma cotação assinada de billing alojado antes da compra. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para pesquisa números disponíveis dos fornecedores e obtém uma cotação assinada de billing alojado antes da compra.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/numbers":{"get":{"tags":["Números de telefone"],"summary":"Lista os números comprados da organização ativa.","description":"Endpoint selecionado: GET /numbers.\n\nO que faz: Lista os números comprados da organização ativa.\n\nQuando usar: Utiliza esta operação para lista os números comprados da organização ativa.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: phoneNumber:read.\n\nResposta: 200 { success, message, data: PhoneNumber[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /numbers. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /numbers Lista os números comprados da organização ativa. Finalidade: Utiliza esta operação para lista os números comprados da organização ativa. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/numbers/phone.route.ts.","operationId":"get-numbers","security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: PhoneNumber[] }"}},"x-atendia-source":"apps/server/src/modules/numbers/phone.route.ts","x-atendia-permission":"phoneNumber:read","x-atendia-ai-context":"GET /numbers Lista os números comprados da organização ativa. Finalidade: Utiliza esta operação para lista os números comprados da organização ativa. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista os números comprados da organização ativa.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."},"post":{"tags":["Números de telefone"],"summary":"Compra um número do fornecedor usando a cotação de pesquisa assinada atual. No modo alojado, quoteId é obrigatório, está associado à organização e expira em quoteExpiresAt.","description":"Endpoint selecionado: POST /numbers.\n\nO que faz: Compra um número do fornecedor usando a cotação de pesquisa assinada atual. No modo alojado, quoteId é obrigatório, está associado à organização e expira em quoteExpiresAt.\n\nQuando usar: Utiliza esta operação para compra um número do fornecedor usando a cotação de pesquisa assinada atual. no modo alojado, quoteid é obrigatório, está associado à organização e expira em quoteexpiresat.\n\nEfeitos secundários e risco: Pode disponibilizar recursos de telefonia faturáveis; confirma antes de usar.\n\nAutenticação: Apenas sessão de proprietário/administrador.\n\nPermissão: phoneNumber:create + billing:manage.\n\nCorpo do pedido: provider: TELNYX; phoneNumber: E.164 string; quoteId: signed quoteId returned by GET /numbers/search (obrigatório no modo alojado).\n\nResposta: 201 { success, message, data: PhoneNumber }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /numbers. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /numbers Compra um número do fornecedor usando a cotação de pesquisa assinada atual. No modo alojado, quoteId é obrigatório, está associado à organização e expira em quoteExpiresAt. Finalidade: Utiliza esta operação para compra um número do fornecedor usando a cotação de pesquisa assinada atual. no modo alojado, quoteid é obrigatório, está associado à organização e expira em quoteexpiresat. Efeitos secundários: Pode disponibilizar recursos de telefonia faturáveis; confirma antes de usar.\n\nOrigem: apps/server/src/modules/numbers/phone.route.ts.","operationId":"post-numbers","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"provider":{"type":"string","description":"provider: TELNYX"},"phoneNumber":{"type":"string","description":"phoneNumber: E.164 string"},"quoteId":{"type":"string","description":"quoteId: signed quoteId returned by GET /numbers/search (obrigatório no modo alojado)"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"201":{"description":"{ success, message, data: PhoneNumber }"}},"x-atendia-source":"apps/server/src/modules/numbers/phone.route.ts","x-atendia-permission":"phoneNumber:create + billing:manage","x-atendia-ai-context":"POST /numbers Compra um número do fornecedor usando a cotação de pesquisa assinada atual. No modo alojado, quoteId é obrigatório, está associado à organização e expira em quoteExpiresAt. Finalidade: Utiliza esta operação para compra um número do fornecedor usando a cotação de pesquisa assinada atual. no modo alojado, quoteid é obrigatório, está associado à organização e expira em quoteexpiresat. Efeitos secundários: Pode disponibilizar recursos de telefonia faturáveis; confirma antes de usar.","x-atendia-use-case":"Utiliza esta operação para compra um número do fornecedor usando a cotação de pesquisa assinada atual. no modo alojado, quoteid é obrigatório, está associado à organização e expira em quoteexpiresat.","x-atendia-side-effects":"Pode disponibilizar recursos de telefonia faturáveis; confirma antes de usar."}},"/numbers/{phId}":{"patch":{"tags":["Números de telefone"],"summary":"Associa ou desassocia um número de telefone de um agente.","description":"Endpoint selecionado: PATCH /numbers/{phId}.\n\nO que faz: Associa ou desassocia um número de telefone de um agente.\n\nQuando usar: Utiliza esta operação para associa ou desassocia um número de telefone de um agente.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão de proprietário/administrador.\n\nPermissão: phoneNumber:update + billing:manage.\n\nParâmetros do caminho: phId: uuid.\n\nCorpo do pedido: agentId: uuid | null.\n\nResposta: 200 { success, message, data: PhoneNumber }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre PATCH /numbers/{phId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: PATCH /numbers/{phId} Associa ou desassocia um número de telefone de um agente. Finalidade: Utiliza esta operação para associa ou desassocia um número de telefone de um agente. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/numbers/phone.route.ts.","operationId":"patch-numbers-by-phid","parameters":[{"name":"phId","in":"path","required":true,"description":"phId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"agentId":{"type":"string","description":"agentId: uuid | null"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: PhoneNumber }"}},"x-atendia-source":"apps/server/src/modules/numbers/phone.route.ts","x-atendia-permission":"phoneNumber:update + billing:manage","x-atendia-ai-context":"PATCH /numbers/{phId} Associa ou desassocia um número de telefone de um agente. Finalidade: Utiliza esta operação para associa ou desassocia um número de telefone de um agente. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para associa ou desassocia um número de telefone de um agente.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."},"delete":{"tags":["Números de telefone"],"summary":"Liberta imediatamente um número de telefone comprado junto do fornecedor. Esta ação é permanente e o número pode não ser recuperável.","description":"Endpoint selecionado: DELETE /numbers/{phId}.\n\nO que faz: Liberta imediatamente um número de telefone comprado junto do fornecedor. Esta ação é permanente e o número pode não ser recuperável.\n\nQuando usar: Utiliza esta operação para liberta imediatamente um número de telefone comprado junto do fornecedor. esta ação é permanente e o número pode não ser recuperável.\n\nEfeitos secundários e risco: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nAutenticação: Apenas sessão de proprietário/administrador.\n\nPermissão: phoneNumber:delete + billing:manage.\n\nParâmetros do caminho: phId: uuid.\n\nResposta: 200 { success, message }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre DELETE /numbers/{phId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: DELETE /numbers/{phId} Liberta imediatamente um número de telefone comprado junto do fornecedor. Esta ação é permanente e o número pode não ser recuperável. Finalidade: Utiliza esta operação para liberta imediatamente um número de telefone comprado junto do fornecedor. esta ação é permanente e o número pode não ser recuperável. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nOrigem: apps/server/src/modules/numbers/phone.route.ts.","operationId":"delete-numbers-by-phid","parameters":[{"name":"phId","in":"path","required":true,"description":"phId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message }"}},"x-atendia-source":"apps/server/src/modules/numbers/phone.route.ts","x-atendia-permission":"phoneNumber:delete + billing:manage","x-atendia-ai-context":"DELETE /numbers/{phId} Liberta imediatamente um número de telefone comprado junto do fornecedor. Esta ação é permanente e o número pode não ser recuperável. Finalidade: Utiliza esta operação para liberta imediatamente um número de telefone comprado junto do fornecedor. esta ação é permanente e o número pode não ser recuperável. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.","x-atendia-use-case":"Utiliza esta operação para liberta imediatamente um número de telefone comprado junto do fornecedor. esta ação é permanente e o número pode não ser recuperável.","x-atendia-side-effects":"Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador."}},"/calls":{"get":{"tags":["Chamadas e registos"],"summary":"Lista os registos de chamadas com filtros e paginação por cursor.","description":"Endpoint selecionado: GET /calls.\n\nO que faz: Lista os registos de chamadas com filtros e paginação por cursor.\n\nQuando usar: Utiliza esta operação para lista os registos de chamadas com filtros e paginação por cursor.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: callLogs:read.\n\nParâmetros de query: agentId?: uuid; status?: CallStatus; direction?: inbound | outbound; from?: ISO datetime; to?: ISO datetime; limit?: 1-100; cursor?: string.\n\nResposta: 200 { success, message, data: CallLog[], nextCursor?, total? }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /calls. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /calls Lista os registos de chamadas com filtros e paginação por cursor. Finalidade: Utiliza esta operação para lista os registos de chamadas com filtros e paginação por cursor. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/calllogs/calllog.route.ts.","operationId":"get-calls","parameters":[{"name":"agentId","in":"query","required":false,"description":"agentId?: uuid","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"status?: CallStatus","schema":{"type":"string"}},{"name":"direction","in":"query","required":false,"description":"direction?: inbound | outbound","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"from?: ISO datetime","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"to?: ISO datetime","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"limit?: 1-100","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"cursor?: string","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: CallLog[], nextCursor?, total? }"}},"x-atendia-source":"apps/server/src/modules/calllogs/calllog.route.ts","x-atendia-permission":"callLogs:read","x-atendia-ai-context":"GET /calls Lista os registos de chamadas com filtros e paginação por cursor. Finalidade: Utiliza esta operação para lista os registos de chamadas com filtros e paginação por cursor. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista os registos de chamadas com filtros e paginação por cursor.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/calls/live":{"get":{"tags":["Chamadas e registos"],"summary":"Lista as chamadas atualmente em curso.","description":"Endpoint selecionado: GET /calls/live.\n\nO que faz: Lista as chamadas atualmente em curso.\n\nQuando usar: Utiliza esta operação para lista as chamadas atualmente em curso.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: callLogs:read.\n\nResposta: 200 { success, message, data: LiveCall[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /calls/live. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /calls/live Lista as chamadas atualmente em curso. Finalidade: Utiliza esta operação para lista as chamadas atualmente em curso. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/calllogs/calllog.route.ts.","operationId":"get-calls-live","security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: LiveCall[] }"}},"x-atendia-source":"apps/server/src/modules/calllogs/calllog.route.ts","x-atendia-permission":"callLogs:read","x-atendia-ai-context":"GET /calls/live Lista as chamadas atualmente em curso. Finalidade: Utiliza esta operação para lista as chamadas atualmente em curso. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista as chamadas atualmente em curso.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/calls/live/end":{"post":{"tags":["Chamadas e registos"],"summary":"Termina uma chamada em curso pelo nome da sala LiveKit.","description":"Endpoint selecionado: POST /calls/live/end.\n\nO que faz: Termina uma chamada em curso pelo nome da sala LiveKit.\n\nQuando usar: Utiliza esta operação para termina uma chamada em curso pelo nome da sala livekit.\n\nEfeitos secundários e risco: Interrompe trabalho ativo ou agendado; confirma antes de usar.\n\nAutenticação: Apenas sessão.\n\nPermissão: callLogs:delete.\n\nCorpo do pedido: roomName: string.\n\nResposta: 200 { success, message, data: EndLiveCallResult }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /calls/live/end. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /calls/live/end Termina uma chamada em curso pelo nome da sala LiveKit. Finalidade: Utiliza esta operação para termina uma chamada em curso pelo nome da sala livekit. Efeitos secundários: Interrompe trabalho ativo ou agendado; confirma antes de usar.\n\nOrigem: apps/server/src/modules/calllogs/calllog.route.ts.","operationId":"post-calls-live-end","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"roomName":{"type":"string","description":"roomName: string"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: EndLiveCallResult }"}},"x-atendia-source":"apps/server/src/modules/calllogs/calllog.route.ts","x-atendia-permission":"callLogs:delete","x-atendia-ai-context":"POST /calls/live/end Termina uma chamada em curso pelo nome da sala LiveKit. Finalidade: Utiliza esta operação para termina uma chamada em curso pelo nome da sala livekit. Efeitos secundários: Interrompe trabalho ativo ou agendado; confirma antes de usar.","x-atendia-use-case":"Utiliza esta operação para termina uma chamada em curso pelo nome da sala livekit.","x-atendia-side-effects":"Interrompe trabalho ativo ou agendado; confirma antes de usar."}},"/calls/{callId}":{"get":{"tags":["Chamadas e registos"],"summary":"Consulta um registo de chamada, incluindo os metadados da chamada.","description":"Endpoint selecionado: GET /calls/{callId}.\n\nO que faz: Consulta um registo de chamada, incluindo os metadados da chamada.\n\nQuando usar: Utiliza esta operação para consulta um registo de chamada, incluindo os metadados da chamada.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: callLogs:read.\n\nParâmetros do caminho: callId: string.\n\nResposta: 200 { success, message, data: CallLog }. data.metadata.closeReason diz como a chamada acabou, num código: agent_ended (o agente terminou a chamada), hung_up (a pessoa desligou ou saiu), caller_silent (a pessoa ficou em silêncio; numa chamada de saída, ninguém falou), max_duration (chegou à duração máxima), transferred (foi passada a uma pessoa e depois acabou), answered_by_recording (atendeu o correio de voz ou uma gravação), no_answer (ninguém atendeu), declined (recusada ou com a linha ocupada), line_failed (a linha telefónica falhou antes de atenderem), worker_error (erro interno) ou session_ended (sem motivo mais específico); uma chamada FAILED pode trazer session_start_failed ou um código billing_ em vez destes. As chamadas mais antigas não têm closeReason.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /calls/{callId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /calls/{callId} Consulta um registo de chamada, incluindo os metadados da chamada. Finalidade: Utiliza esta operação para consulta um registo de chamada, incluindo os metadados da chamada. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/calllogs/calllog.route.ts.","operationId":"get-calls-by-callid","parameters":[{"name":"callId","in":"path","required":true,"description":"callId: string","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: CallLog }. data.metadata.closeReason diz como a chamada acabou, num código: agent_ended (o agente terminou a chamada), hung_up (a pessoa desligou ou saiu), caller_silent (a pessoa ficou em silêncio; numa chamada de saída, ninguém falou), max_duration (chegou à duração máxima), transferred (foi passada a uma pessoa e depois acabou), answered_by_recording (atendeu o correio de voz ou uma gravação), no_answer (ninguém atendeu), declined (recusada ou com a linha ocupada), line_failed (a linha telefónica falhou antes de atenderem), worker_error (erro interno) ou session_ended (sem motivo mais específico); uma chamada FAILED pode trazer session_start_failed ou um código billing_ em vez destes. As chamadas mais antigas não têm closeReason"}},"x-atendia-source":"apps/server/src/modules/calllogs/calllog.route.ts","x-atendia-permission":"callLogs:read","x-atendia-ai-context":"GET /calls/{callId} Consulta um registo de chamada, incluindo os metadados da chamada. Finalidade: Utiliza esta operação para consulta um registo de chamada, incluindo os metadados da chamada. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta um registo de chamada, incluindo os metadados da chamada.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."},"delete":{"tags":["Chamadas e registos"],"summary":"Elimina um registo de chamada.","description":"Endpoint selecionado: DELETE /calls/{callId}.\n\nO que faz: Elimina um registo de chamada.\n\nQuando usar: Utiliza esta operação para elimina um registo de chamada.\n\nEfeitos secundários e risco: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: callLogs:delete.\n\nParâmetros do caminho: callId: string.\n\nResposta: 200 { success, message }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre DELETE /calls/{callId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: DELETE /calls/{callId} Elimina um registo de chamada. Finalidade: Utiliza esta operação para elimina um registo de chamada. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nOrigem: apps/server/src/modules/calllogs/calllog.route.ts.","operationId":"delete-calls-by-callid","parameters":[{"name":"callId","in":"path","required":true,"description":"callId: string","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message }"}},"x-atendia-source":"apps/server/src/modules/calllogs/calllog.route.ts","x-atendia-permission":"callLogs:delete","x-atendia-ai-context":"DELETE /calls/{callId} Elimina um registo de chamada. Finalidade: Utiliza esta operação para elimina um registo de chamada. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.","x-atendia-use-case":"Utiliza esta operação para elimina um registo de chamada.","x-atendia-side-effects":"Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador."}},"/calls/{callId}/transcripts":{"get":{"tags":["Chamadas e registos"],"summary":"Consulta as mensagens da transcrição de uma chamada.","description":"Endpoint selecionado: GET /calls/{callId}/transcripts.\n\nO que faz: Consulta as mensagens da transcrição de uma chamada.\n\nQuando usar: Utiliza esta operação para consulta as mensagens da transcrição de uma chamada.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: callLogs:read.\n\nParâmetros do caminho: callId: string.\n\nParâmetros de query: limit?: 1-100; cursor?: string.\n\nResposta: 200 { success, message, data: Transcript[], nextCursor? }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /calls/{callId}/transcripts. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /calls/{callId}/transcripts Consulta as mensagens da transcrição de uma chamada. Finalidade: Utiliza esta operação para consulta as mensagens da transcrição de uma chamada. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/calllogs/calllog.route.ts.","operationId":"get-calls-by-callid-transcripts","parameters":[{"name":"callId","in":"path","required":true,"description":"callId: string","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"limit?: 1-100","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"cursor?: string","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: Transcript[], nextCursor? }"}},"x-atendia-source":"apps/server/src/modules/calllogs/calllog.route.ts","x-atendia-permission":"callLogs:read","x-atendia-ai-context":"GET /calls/{callId}/transcripts Consulta as mensagens da transcrição de uma chamada. Finalidade: Utiliza esta operação para consulta as mensagens da transcrição de uma chamada. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta as mensagens da transcrição de uma chamada.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/dashboard/summary":{"get":{"tags":["Visão geral"],"summary":"Devolve dados de KPI e de intervalo temporal para a visão geral.","description":"Endpoint selecionado: GET /dashboard/summary.\n\nO que faz: Devolve dados de KPI e de intervalo temporal para a visão geral.\n\nQuando usar: Utiliza esta operação para devolve dados de kpi e de intervalo temporal para a visão geral.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: callLogs:read.\n\nParâmetros de query: range?: 24h | 7d | 30d | custom; from?: date, obrigatório para custom; to?: date, obrigatório para custom; máximo do intervalo customizado: 90 dias.\n\nResposta: 200 { success, message, data: DashboardSummary }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /dashboard/summary. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /dashboard/summary Devolve dados de KPI e de intervalo temporal para a visão geral. Finalidade: Utiliza esta operação para devolve dados de kpi e de intervalo temporal para a visão geral. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/dashboard/dashboard.route.ts.","operationId":"get-dashboard-summary","parameters":[{"name":"range","in":"query","required":false,"description":"range?: 24h | 7d | 30d | custom","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"from?: date, obrigatório para custom","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"to?: date, obrigatório para custom","schema":{"type":"string"}},{"name":"máximo do intervalo customizado","in":"query","required":true,"description":"máximo do intervalo customizado: 90 dias","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: DashboardSummary }"}},"x-atendia-source":"apps/server/src/modules/dashboard/dashboard.route.ts","x-atendia-permission":"callLogs:read","x-atendia-ai-context":"GET /dashboard/summary Devolve dados de KPI e de intervalo temporal para a visão geral. Finalidade: Utiliza esta operação para devolve dados de kpi e de intervalo temporal para a visão geral. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para devolve dados de kpi e de intervalo temporal para a visão geral.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/outbound-calls":{"get":{"tags":["Chamadas de saída"],"summary":"Lista chamadas de saída com filtros, também pela tua referência.","description":"Endpoint selecionado: GET /outbound-calls.\n\nO que faz: Lista chamadas de saída com filtros, também pela tua referência.\n\nQuando usar: Utiliza esta operação para lista chamadas de saída com filtros, também pela tua referência.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: outboundCalls:read.\n\nParâmetros de query: agentId?: uuid; status?: CallStatus; mode?: OutboundCallMode; limit?: 1-100; cursor?: string; reference?: string (a tua referência, exata); search?: string, máximo 200 (part of the reference, key or agent name, start of the outboundId, or 3+ digits of a number).\n\nResposta: 200 { success, message, data: OutboundCallList }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /outbound-calls. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /outbound-calls Lista chamadas de saída com filtros, também pela tua referência. Finalidade: Utiliza esta operação para lista chamadas de saída com filtros, também pela tua referência. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"get-outbound-calls","parameters":[{"name":"agentId","in":"query","required":false,"description":"agentId?: uuid","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"status?: CallStatus","schema":{"type":"string"}},{"name":"mode","in":"query","required":false,"description":"mode?: OutboundCallMode","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"limit?: 1-100","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"cursor?: string","schema":{"type":"string"}},{"name":"reference","in":"query","required":false,"description":"reference?: string (a tua referência, exata)","schema":{"type":"string"}},{"name":"search","in":"query","required":false,"description":"search?: string, máximo 200 (part of the reference, key or agent name, start of the outboundId, or 3+ digits of a number)","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: OutboundCallList }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:read","x-atendia-ai-context":"GET /outbound-calls Lista chamadas de saída com filtros, também pela tua referência. Finalidade: Utiliza esta operação para lista chamadas de saída com filtros, também pela tua referência. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista chamadas de saída com filtros, também pela tua referência.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."},"post":{"tags":["Chamadas de saída"],"summary":"Pede uma chamada de saída com uma chave API. A chamada espera pela hora e por uma linha livre; o resultado vai para o webhook pós-chamada do agente.","description":"Endpoint selecionado: POST /outbound-calls.\n\nO que faz: Pede uma chamada de saída com uma chave API. A chamada espera pela hora e por uma linha livre; o resultado vai para o webhook pós-chamada do agente.\n\nQuando usar: Utiliza esta operação para pede uma chamada de saída com uma chave api. a chamada espera pela hora e por uma linha livre; o resultado vai para o webhook pós-chamada do agente.\n\nEfeitos secundários e risco: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.\n\nAutenticação: Chave API (leitura e chamadas).\n\nPermissão: outboundCalls:create.\n\nCorpo do pedido: cabeçalho Idempotency-Key?: até 200 caracteres; agentId: uuid; phoneNumber: string; fromNumber?: string (só é preciso quando o agente tem mais do que um número); scheduledAt?: data e hora ISO com fuso, de há 5 minutos até daqui a 90 dias (sem ela: agora); notAfter?: data e hora ISO com fuso; nenhuma chamada do pedido começa depois dela (400 NOT_AFTER_IN_PAST se já passou, 400 SCHEDULED_AT_AFTER_NOT_AFTER se scheduledAt for igual ou posterior); firstMessage?, systemPrompt?; dynamicVariables?: Record<string, string>; reference?: string, máximo de 200 caracteres, sem dados pessoais.\n\nResposta: 201 { success, message, data: { outboundId, status, reason, waitReason (line, credit, hours ou retry), nextAttemptAt, scheduledAt, notAfter, callbackScheduled, callbackOf, answeredBy, messageLeft, reference, origin, attempt, maxAttempts, endedByDeadline } }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls Pede uma chamada de saída com uma chave API. A chamada espera pela hora e por uma linha livre; o resultado vai para o webhook pós-chamada do agente. Finalidade: Utiliza esta operação para pede uma chamada de saída com uma chave api. a chamada espera pela hora e por uma linha livre; o resultado vai para o webhook pós-chamada do agente. Efeitos secundários: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.\n\nOrigem: apps/server/src/modules/outbound/outbound-api.route.ts.","operationId":"post-outbound-calls","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"cabeçalho Idempotency-Key":{"type":"string","description":"cabeçalho Idempotency-Key?: até 200 caracteres"},"agentId":{"type":"string","description":"agentId: uuid"},"phoneNumber":{"type":"string","description":"phoneNumber: string"},"fromNumber":{"type":"string","description":"fromNumber?: string (só é preciso quando o agente tem mais do que um número)"},"scheduledAt":{"type":"string","description":"scheduledAt?: data e hora ISO com fuso, de há 5 minutos até daqui a 90 dias (sem ela: agora)"},"notAfter":{"type":"string","description":"notAfter?: data e hora ISO com fuso; nenhuma chamada do pedido começa depois dela (400 NOT_AFTER_IN_PAST se já passou, 400 SCHEDULED_AT_AFTER_NOT_AFTER se scheduledAt for igual ou posterior)"},"firstMessage":{"type":"string","description":"firstMessage?, systemPrompt?"},"dynamicVariables":{"type":"string","description":"dynamicVariables?: Record<string, string>"},"reference":{"type":"string","description":"reference?: string, máximo de 200 caracteres, sem dados pessoais"}}}}}},"security":[{"apiKey":[]}],"responses":{"201":{"description":"{ success, message, data: { outboundId, status, reason, waitReason (line, credit, hours ou retry), nextAttemptAt, scheduledAt, notAfter, callbackScheduled, callbackOf, answeredBy, messageLeft, reference, origin, attempt, maxAttempts, endedByDeadline } }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-api.route.ts","x-atendia-permission":"outboundCalls:create","x-atendia-ai-context":"POST /outbound-calls Pede uma chamada de saída com uma chave API. A chamada espera pela hora e por uma linha livre; o resultado vai para o webhook pós-chamada do agente. Finalidade: Utiliza esta operação para pede uma chamada de saída com uma chave api. a chamada espera pela hora e por uma linha livre; o resultado vai para o webhook pós-chamada do agente. Efeitos secundários: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.","x-atendia-use-case":"Utiliza esta operação para pede uma chamada de saída com uma chave api. a chamada espera pela hora e por uma linha livre; o resultado vai para o webhook pós-chamada do agente.","x-atendia-side-effects":"Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar."}},"/outbound-calls/quick":{"post":{"tags":["Chamadas de saída"],"summary":"Inicia imediatamente uma chamada de saída.","description":"Endpoint selecionado: POST /outbound-calls/quick.\n\nO que faz: Inicia imediatamente uma chamada de saída.\n\nQuando usar: Utiliza esta operação para inicia imediatamente uma chamada de saída.\n\nEfeitos secundários e risco: Cria uma chamada ou sessão em tempo real; pode consumir minutos ou contactar uma pessoa, por isso confirma a intenção antes de usar.\n\nAutenticação: Apenas sessão.\n\nPermissão: outboundCalls:create.\n\nCorpo do pedido: agentId: uuid; phoneNumber: string; fromNumber: string; firstMessage?, systemPrompt?, username?; dynamicVariables?: Record<string, string>; agentSpeaksFirst?: boolean (default false).\n\nResposta: 201 { success, message, data: OutboundCall }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/quick. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/quick Inicia imediatamente uma chamada de saída. Finalidade: Utiliza esta operação para inicia imediatamente uma chamada de saída. Efeitos secundários: Cria uma chamada ou sessão em tempo real; pode consumir minutos ou contactar uma pessoa, por isso confirma a intenção antes de usar.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-quick","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"agentId":{"type":"string","description":"agentId: uuid"},"phoneNumber":{"type":"string","description":"phoneNumber: string"},"fromNumber":{"type":"string","description":"fromNumber: string"},"firstMessage":{"type":"string","description":"firstMessage?, systemPrompt?, username?"},"dynamicVariables":{"type":"string","description":"dynamicVariables?: Record<string, string>"},"agentSpeaksFirst":{"type":"string","description":"agentSpeaksFirst?: boolean (default false)"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"201":{"description":"{ success, message, data: OutboundCall }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:create","x-atendia-ai-context":"POST /outbound-calls/quick Inicia imediatamente uma chamada de saída. Finalidade: Utiliza esta operação para inicia imediatamente uma chamada de saída. Efeitos secundários: Cria uma chamada ou sessão em tempo real; pode consumir minutos ou contactar uma pessoa, por isso confirma a intenção antes de usar.","x-atendia-use-case":"Utiliza esta operação para inicia imediatamente uma chamada de saída.","x-atendia-side-effects":"Cria uma chamada ou sessão em tempo real; pode consumir minutos ou contactar uma pessoa, por isso confirma a intenção antes de usar."}},"/outbound-calls/batch-upload-url":{"get":{"tags":["Chamadas de saída"],"summary":"Cria um URL de carregamento pré-assinado para ficheiros CSV/XLSX de origem de campanhas (até 50 MB). O PUT tem de enviar os requiredHeaders (If-None-Match: *): o URL só escreve o ficheiro uma vez.","description":"Endpoint selecionado: GET /outbound-calls/batch-upload-url.\n\nO que faz: Cria um URL de carregamento pré-assinado para ficheiros CSV/XLSX de origem de campanhas (até 50 MB). O PUT tem de enviar os requiredHeaders (If-None-Match: *): o URL só escreve o ficheiro uma vez.\n\nQuando usar: Utiliza esta operação para cria um url de carregamento pré-assinado para ficheiros csv/xlsx de origem de campanhas (até 50 mb). o put tem de enviar os requiredheaders (if-none-match: *): o url só escreve o ficheiro uma vez.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API (leitura e chamadas).\n\nPermissão: outboundCalls:create.\n\nParâmetros de query: fileName: .csv or .xlsx; contentType: string.\n\nResposta: 200 { success, message, data: { uploadUrl, s3Key, contentType, maxUploadBytes, requiredHeaders } } — PUT the file with requiredHeaders (If-None-Match: *).\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /outbound-calls/batch-upload-url. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /outbound-calls/batch-upload-url Cria um URL de carregamento pré-assinado para ficheiros CSV/XLSX de origem de campanhas (até 50 MB). O PUT tem de enviar os requiredHeaders (If-None-Match: *): o URL só escreve o ficheiro uma vez. Finalidade: Utiliza esta operação para cria um url de carregamento pré-assinado para ficheiros csv/xlsx de origem de campanhas (até 50 mb). o put tem de enviar os requiredheaders (if-none-match: *): o url só escreve o ficheiro uma vez. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"get-outbound-calls-batch-upload-url","parameters":[{"name":"fileName","in":"query","required":true,"description":"fileName: .csv or .xlsx","schema":{"type":"string"}},{"name":"contentType","in":"query","required":true,"description":"contentType: string","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: { uploadUrl, s3Key, contentType, maxUploadBytes, requiredHeaders } } — PUT the file with requiredHeaders (If-None-Match: *)"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:create","x-atendia-ai-context":"GET /outbound-calls/batch-upload-url Cria um URL de carregamento pré-assinado para ficheiros CSV/XLSX de origem de campanhas (até 50 MB). O PUT tem de enviar os requiredHeaders (If-None-Match: *): o URL só escreve o ficheiro uma vez. Finalidade: Utiliza esta operação para cria um url de carregamento pré-assinado para ficheiros csv/xlsx de origem de campanhas (até 50 mb). o put tem de enviar os requiredheaders (if-none-match: *): o url só escreve o ficheiro uma vez. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para cria um url de carregamento pré-assinado para ficheiros csv/xlsx de origem de campanhas (até 50 mb). o put tem de enviar os requiredheaders (if-none-match: *): o url só escreve o ficheiro uma vez.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/outbound-calls/batches":{"post":{"tags":["Chamadas de saída"],"summary":"Cria uma campanha em lote a partir de um ficheiro de origem carregado.","description":"Endpoint selecionado: POST /outbound-calls/batches.\n\nO que faz: Cria uma campanha em lote a partir de um ficheiro de origem carregado.\n\nQuando usar: Utiliza esta operação para cria uma campanha em lote a partir de um ficheiro de origem carregado.\n\nEfeitos secundários e risco: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.\n\nAutenticação: Sessão ou chave API (leitura e chamadas).\n\nPermissão: outboundCalls:create.\n\nCorpo do pedido: name: string; agentId: uuid; fromNumber: string; sourceFileKey: string; sourceFileName: string; scheduledAt?: date | null; timezone?: string; ringingTimeoutSeconds?: 10-70; agentSpeaksFirst?: boolean (default false).\n\nResposta: 201 { success, message, data: BatchCampaign }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/batches. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/batches Cria uma campanha em lote a partir de um ficheiro de origem carregado. Finalidade: Utiliza esta operação para cria uma campanha em lote a partir de um ficheiro de origem carregado. Efeitos secundários: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-batches","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"name: string"},"agentId":{"type":"string","description":"agentId: uuid"},"fromNumber":{"type":"string","description":"fromNumber: string"},"sourceFileKey":{"type":"string","description":"sourceFileKey: string"},"sourceFileName":{"type":"string","description":"sourceFileName: string"},"scheduledAt":{"type":"string","description":"scheduledAt?: date | null"},"timezone":{"type":"string","description":"timezone?: string"},"ringingTimeoutSeconds":{"type":"string","description":"ringingTimeoutSeconds?: 10-70"},"agentSpeaksFirst":{"type":"string","description":"agentSpeaksFirst?: boolean (default false)"}}}}}},"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"201":{"description":"{ success, message, data: BatchCampaign }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:create","x-atendia-ai-context":"POST /outbound-calls/batches Cria uma campanha em lote a partir de um ficheiro de origem carregado. Finalidade: Utiliza esta operação para cria uma campanha em lote a partir de um ficheiro de origem carregado. Efeitos secundários: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.","x-atendia-use-case":"Utiliza esta operação para cria uma campanha em lote a partir de um ficheiro de origem carregado.","x-atendia-side-effects":"Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar."},"get":{"tags":["Chamadas de saída"],"summary":"Lista as campanhas em lote.","description":"Endpoint selecionado: GET /outbound-calls/batches.\n\nO que faz: Lista as campanhas em lote.\n\nQuando usar: Utiliza esta operação para lista as campanhas em lote.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: outboundCalls:read.\n\nParâmetros de query: agentId?: uuid.\n\nResposta: 200 { success, message, data: BatchCampaign[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /outbound-calls/batches. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /outbound-calls/batches Lista as campanhas em lote. Finalidade: Utiliza esta operação para lista as campanhas em lote. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"get-outbound-calls-batches","parameters":[{"name":"agentId","in":"query","required":false,"description":"agentId?: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: BatchCampaign[] }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:read","x-atendia-ai-context":"GET /outbound-calls/batches Lista as campanhas em lote. Finalidade: Utiliza esta operação para lista as campanhas em lote. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista as campanhas em lote.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/outbound-calls/batches/list":{"post":{"tags":["Chamadas de saída"],"summary":"Cria uma campanha com uma chave API, a partir de uma lista de até 5000 contactos no próprio pedido (no máximo 2 MB).","description":"Endpoint selecionado: POST /outbound-calls/batches/list.\n\nO que faz: Cria uma campanha com uma chave API, a partir de uma lista de até 5000 contactos no próprio pedido (no máximo 2 MB).\n\nQuando usar: Utiliza esta operação para cria uma campanha com uma chave api, a partir de uma lista de até 5000 contactos no próprio pedido (no máximo 2 mb).\n\nEfeitos secundários e risco: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.\n\nAutenticação: Chave API (leitura e chamadas).\n\nPermissão: outboundCalls:create.\n\nCorpo do pedido: cabeçalho Idempotency-Key?: até 200 caracteres; name: string, máximo 120; agentId: uuid; fromNumber?: string; scheduledAt?: data e hora ISO com fuso (sem ela: agora); contacts: { phoneNumber, firstMessage?, systemPrompt?, dynamicVariables?, reference? }[], 1-5000.\n\nResposta: 201 { success, message, data: { campaignId, accepted, rejectedCount, rejected (os primeiros 100: position, reference, reason) } }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/batches/list. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/batches/list Cria uma campanha com uma chave API, a partir de uma lista de até 5000 contactos no próprio pedido (no máximo 2 MB). Finalidade: Utiliza esta operação para cria uma campanha com uma chave api, a partir de uma lista de até 5000 contactos no próprio pedido (no máximo 2 mb). Efeitos secundários: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.\n\nOrigem: apps/server/src/modules/outbound/outbound-api-list.route.ts.","operationId":"post-outbound-calls-batches-list","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"cabeçalho Idempotency-Key":{"type":"string","description":"cabeçalho Idempotency-Key?: até 200 caracteres"},"name":{"type":"string","description":"name: string, máximo 120"},"agentId":{"type":"string","description":"agentId: uuid"},"fromNumber":{"type":"string","description":"fromNumber?: string"},"scheduledAt":{"type":"string","description":"scheduledAt?: data e hora ISO com fuso (sem ela: agora)"},"contacts":{"type":"string","description":"contacts: { phoneNumber, firstMessage?, systemPrompt?, dynamicVariables?, reference? }[], 1-5000"}}}}}},"security":[{"apiKey":[]}],"responses":{"201":{"description":"{ success, message, data: { campaignId, accepted, rejectedCount, rejected (os primeiros 100: position, reference, reason) } }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-api-list.route.ts","x-atendia-permission":"outboundCalls:create","x-atendia-ai-context":"POST /outbound-calls/batches/list Cria uma campanha com uma chave API, a partir de uma lista de até 5000 contactos no próprio pedido (no máximo 2 MB). Finalidade: Utiliza esta operação para cria uma campanha com uma chave api, a partir de uma lista de até 5000 contactos no próprio pedido (no máximo 2 mb). Efeitos secundários: Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar.","x-atendia-use-case":"Utiliza esta operação para cria uma campanha com uma chave api, a partir de uma lista de até 5000 contactos no próprio pedido (no máximo 2 mb).","x-atendia-side-effects":"Faz chamadas reais a pessoas; gasta minutos e saldo. Confirma a intenção antes de usar."}},"/outbound-calls/batches/{campaignId}":{"get":{"tags":["Chamadas de saída"],"summary":"Consulta uma campanha em lote com uma página dos destinatários, pela ordem do ficheiro. Para a página seguinte, envia o nextCursor como cursor.","description":"Endpoint selecionado: GET /outbound-calls/batches/{campaignId}.\n\nO que faz: Consulta uma campanha em lote com uma página dos destinatários, pela ordem do ficheiro. Para a página seguinte, envia o nextCursor como cursor.\n\nQuando usar: Utiliza esta operação para consulta uma campanha em lote com uma página dos destinatários, pela ordem do ficheiro. para a página seguinte, envia o nextcursor como cursor.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: outboundCalls:read.\n\nParâmetros do caminho: campaignId: uuid.\n\nParâmetros de query: limit?: 1-100 (por omissão 50); cursor?: string (o nextCursor da página anterior).\n\nResposta: 200 { success, message, data: BatchCampaignDetail { ...campanha, outboundCalls (uma página), nextCursor (null na última página), callCounts { total, byStatus, retriesPending } } }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /outbound-calls/batches/{campaignId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /outbound-calls/batches/{campaignId} Consulta uma campanha em lote com uma página dos destinatários, pela ordem do ficheiro. Para a página seguinte, envia o nextCursor como cursor. Finalidade: Utiliza esta operação para consulta uma campanha em lote com uma página dos destinatários, pela ordem do ficheiro. para a página seguinte, envia o nextcursor como cursor. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"get-outbound-calls-batches-by-campaignid","parameters":[{"name":"campaignId","in":"path","required":true,"description":"campaignId: uuid","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"limit?: 1-100 (por omissão 50)","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"cursor?: string (o nextCursor da página anterior)","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: BatchCampaignDetail { ...campanha, outboundCalls (uma página), nextCursor (null na última página), callCounts { total, byStatus, retriesPending } } }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:read","x-atendia-ai-context":"GET /outbound-calls/batches/{campaignId} Consulta uma campanha em lote com uma página dos destinatários, pela ordem do ficheiro. Para a página seguinte, envia o nextCursor como cursor. Finalidade: Utiliza esta operação para consulta uma campanha em lote com uma página dos destinatários, pela ordem do ficheiro. para a página seguinte, envia o nextcursor como cursor. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta uma campanha em lote com uma página dos destinatários, pela ordem do ficheiro. para a página seguinte, envia o nextcursor como cursor.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/outbound-calls/batches/{campaignId}/results.csv":{"get":{"tags":["Chamadas de saída"],"summary":"Descarrega os resultados de uma campanha num ficheiro CSV, com uma linha por destinatário, pela ordem do ficheiro. Com uma chave API, failure_reason é um código da lista fechada de motivos de falha, nunca o texto guardado. Um download cortado antes do fim está incompleto.","description":"Endpoint selecionado: GET /outbound-calls/batches/{campaignId}/results.csv.\n\nO que faz: Descarrega os resultados de uma campanha num ficheiro CSV, com uma linha por destinatário, pela ordem do ficheiro. Com uma chave API, failure_reason é um código da lista fechada de motivos de falha, nunca o texto guardado. Um download cortado antes do fim está incompleto.\n\nQuando usar: Utiliza esta operação para descarrega os resultados de uma campanha num ficheiro csv, com uma linha por destinatário, pela ordem do ficheiro. com uma chave api, failure_reason é um código da lista fechada de motivos de falha, nunca o texto guardado. um download cortado antes do fim está incompleto.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: outboundCalls:read.\n\nParâmetros do caminho: campaignId: uuid.\n\nResposta: 200 anexo text/csv, não JSON: row_number, phone_number, outbound_status, call_status, call_id, outbound_id, duration_seconds, failure_reason, started_at, ended_at, depois as colunas do ficheiro e os dados recolhidos.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /outbound-calls/batches/{campaignId}/results.csv. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /outbound-calls/batches/{campaignId}/results.csv Descarrega os resultados de uma campanha num ficheiro CSV, com uma linha por destinatário, pela ordem do ficheiro. Com uma chave API, failure_reason é um código da lista fechada de motivos de falha, nunca o texto guardado. Um download cortado antes do fim está incompleto. Finalidade: Utiliza esta operação para descarrega os resultados de uma campanha num ficheiro csv, com uma linha por destinatário, pela ordem do ficheiro. com uma chave api, failure_reason é um código da lista fechada de motivos de falha, nunca o texto guardado. um download cortado antes do fim está incompleto. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"get-outbound-calls-batches-by-campaignid-results-csv","parameters":[{"name":"campaignId","in":"path","required":true,"description":"campaignId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"anexo text/csv, não JSON: row_number, phone_number, outbound_status, call_status, call_id, outbound_id, duration_seconds, failure_reason, started_at, ended_at, depois as colunas do ficheiro e os dados recolhidos"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:read","x-atendia-ai-context":"GET /outbound-calls/batches/{campaignId}/results.csv Descarrega os resultados de uma campanha num ficheiro CSV, com uma linha por destinatário, pela ordem do ficheiro. Com uma chave API, failure_reason é um código da lista fechada de motivos de falha, nunca o texto guardado. Um download cortado antes do fim está incompleto. Finalidade: Utiliza esta operação para descarrega os resultados de uma campanha num ficheiro csv, com uma linha por destinatário, pela ordem do ficheiro. com uma chave api, failure_reason é um código da lista fechada de motivos de falha, nunca o texto guardado. um download cortado antes do fim está incompleto. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para descarrega os resultados de uma campanha num ficheiro csv, com uma linha por destinatário, pela ordem do ficheiro. com uma chave api, failure_reason é um código da lista fechada de motivos de falha, nunca o texto guardado. um download cortado antes do fim está incompleto.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/outbound-calls/batches/{campaignId}/personalization/preflight":{"post":{"tags":["Chamadas de saída"],"summary":"Valida a personalização tipada por destinatário, o comportamento de fallback, as pré-visualizações renderizadas e os digests do snapshot antes do envio.","description":"Endpoint selecionado: POST /outbound-calls/batches/{campaignId}/personalization/preflight.\n\nO que faz: Valida a personalização tipada por destinatário, o comportamento de fallback, as pré-visualizações renderizadas e os digests do snapshot antes do envio.\n\nQuando usar: Utiliza esta operação para valida a personalização tipada por destinatário, o comportamento de fallback, as pré-visualizações renderizadas e os digests do snapshot antes do envio.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: outboundCalls:read.\n\nParâmetros do caminho: campaignId: uuid.\n\nCorpo do pedido: schema: { version, fields, templates }; recipients: { recipientKey, rowNumber?, values }[]; includeSensitivePreview?: boolean.\n\nResposta: 200 { success, message, data: CampaignPersonalizationPreflight }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/batches/{campaignId}/personalization/preflight. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/batches/{campaignId}/personalization/preflight Valida a personalização tipada por destinatário, o comportamento de fallback, as pré-visualizações renderizadas e os digests do snapshot antes do envio. Finalidade: Utiliza esta operação para valida a personalização tipada por destinatário, o comportamento de fallback, as pré-visualizações renderizadas e os digests do snapshot antes do envio. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-batches-by-campaignid-personalization-preflight","parameters":[{"name":"campaignId","in":"path","required":true,"description":"campaignId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"schema":{"type":"string","description":"schema: { version, fields, templates }"},"recipients":{"type":"string","description":"recipients: { recipientKey, rowNumber?, values }[]"},"includeSensitivePreview":{"type":"string","description":"includeSensitivePreview?: boolean"}}}}}},"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: CampaignPersonalizationPreflight }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:read","x-atendia-ai-context":"POST /outbound-calls/batches/{campaignId}/personalization/preflight Valida a personalização tipada por destinatário, o comportamento de fallback, as pré-visualizações renderizadas e os digests do snapshot antes do envio. Finalidade: Utiliza esta operação para valida a personalização tipada por destinatário, o comportamento de fallback, as pré-visualizações renderizadas e os digests do snapshot antes do envio. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para valida a personalização tipada por destinatário, o comportamento de fallback, as pré-visualizações renderizadas e os digests do snapshot antes do envio.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/outbound-calls/batches/{campaignId}/experiments/assignments":{"post":{"tags":["Chamadas de saída"],"summary":"Calcula atribuições determinísticas de variantes de experiência para os destinatários.","description":"Endpoint selecionado: POST /outbound-calls/batches/{campaignId}/experiments/assignments.\n\nO que faz: Calcula atribuições determinísticas de variantes de experiência para os destinatários.\n\nQuando usar: Utiliza esta operação para calcula atribuições determinísticas de variantes de experiência para os destinatários.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: outboundCalls:create.\n\nParâmetros do caminho: campaignId: uuid.\n\nCorpo do pedido: experiment: { experimentId, version, hypothesis, primaryMetric, unit, stoppingPolicy, variants }; unitKeys: string[]; excludedUnitKeys?: Record<string, string>.\n\nResposta: 200 { success, message, data: CampaignExperimentAssignments }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/batches/{campaignId}/experiments/assignments. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/batches/{campaignId}/experiments/assignments Calcula atribuições determinísticas de variantes de experiência para os destinatários. Finalidade: Utiliza esta operação para calcula atribuições determinísticas de variantes de experiência para os destinatários. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-batches-by-campaignid-experiments-assignments","parameters":[{"name":"campaignId","in":"path","required":true,"description":"campaignId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"experiment":{"type":"string","description":"experiment: { experimentId, version, hypothesis, primaryMetric, unit, stoppingPolicy, variants }"},"unitKeys":{"type":"string","description":"unitKeys: string[]"},"excludedUnitKeys":{"type":"string","description":"excludedUnitKeys?: Record<string, string>"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: CampaignExperimentAssignments }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:create","x-atendia-ai-context":"POST /outbound-calls/batches/{campaignId}/experiments/assignments Calcula atribuições determinísticas de variantes de experiência para os destinatários. Finalidade: Utiliza esta operação para calcula atribuições determinísticas de variantes de experiência para os destinatários. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para calcula atribuições determinísticas de variantes de experiência para os destinatários.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/outbound-calls/batches/{campaignId}/conversions/validate":{"post":{"tags":["Chamadas de saída"],"summary":"Valida um evento de conversão antes da ingestão idempotente e da atribuição. Numa campanha que não guarda dados pessoais, um número de telefone em externalCustomerId é recusado (código CUSTOMER_ID_IS_PHONE_NUMBER); a chave certa é a do próprio cliente, a coluna recipient_key do ficheiro.","description":"Endpoint selecionado: POST /outbound-calls/batches/{campaignId}/conversions/validate.\n\nO que faz: Valida um evento de conversão antes da ingestão idempotente e da atribuição. Numa campanha que não guarda dados pessoais, um número de telefone em externalCustomerId é recusado (código CUSTOMER_ID_IS_PHONE_NUMBER); a chave certa é a do próprio cliente, a coluna recipient_key do ficheiro.\n\nQuando usar: Utiliza esta operação para valida um evento de conversão antes da ingestão idempotente e da atribuição. numa campanha que não guarda dados pessoais, um número de telefone em externalcustomerid é recusado (código customer_id_is_phone_number); a chave certa é a do próprio cliente, a coluna recipient_key do ficheiro.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: outboundCalls:create.\n\nParâmetros do caminho: campaignId: uuid.\n\nCorpo do pedido: goalKey: string; dedupeKey: string; externalCustomerId: string; occurredAt: date; valueCents?: integer; currency?: ISO 4217; source: string; evidence?: object.\n\nResposta: 200 { success, message, data: CampaignConversionValidation } ou rejeição de validação 400.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/batches/{campaignId}/conversions/validate. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/batches/{campaignId}/conversions/validate Valida um evento de conversão antes da ingestão idempotente e da atribuição. Numa campanha que não guarda dados pessoais, um número de telefone em externalCustomerId é recusado (código CUSTOMER_ID_IS_PHONE_NUMBER); a chave certa é a do próprio cliente, a coluna recipient_key do ficheiro. Finalidade: Utiliza esta operação para valida um evento de conversão antes da ingestão idempotente e da atribuição. numa campanha que não guarda dados pessoais, um número de telefone em externalcustomerid é recusado (código customer_id_is_phone_number); a chave certa é a do próprio cliente, a coluna recipient_key do ficheiro. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-batches-by-campaignid-conversions-validate","parameters":[{"name":"campaignId","in":"path","required":true,"description":"campaignId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"goalKey":{"type":"string","description":"goalKey: string"},"dedupeKey":{"type":"string","description":"dedupeKey: string"},"externalCustomerId":{"type":"string","description":"externalCustomerId: string"},"occurredAt":{"type":"string","description":"occurredAt: date"},"valueCents":{"type":"string","description":"valueCents?: integer"},"currency":{"type":"string","description":"currency?: ISO 4217"},"source":{"type":"string","description":"source: string"},"evidence":{"type":"string","description":"evidence?: object"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: CampaignConversionValidation } ou rejeição de validação 400"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:create","x-atendia-ai-context":"POST /outbound-calls/batches/{campaignId}/conversions/validate Valida um evento de conversão antes da ingestão idempotente e da atribuição. Numa campanha que não guarda dados pessoais, um número de telefone em externalCustomerId é recusado (código CUSTOMER_ID_IS_PHONE_NUMBER); a chave certa é a do próprio cliente, a coluna recipient_key do ficheiro. Finalidade: Utiliza esta operação para valida um evento de conversão antes da ingestão idempotente e da atribuição. numa campanha que não guarda dados pessoais, um número de telefone em externalcustomerid é recusado (código customer_id_is_phone_number); a chave certa é a do próprio cliente, a coluna recipient_key do ficheiro. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para valida um evento de conversão antes da ingestão idempotente e da atribuição. numa campanha que não guarda dados pessoais, um número de telefone em externalcustomerid é recusado (código customer_id_is_phone_number); a chave certa é a do próprio cliente, a coluna recipient_key do ficheiro.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/outbound-calls/batches/{campaignId}/reports/preview":{"post":{"tags":["Chamadas de saída"],"summary":"Gera relatórios de campanha ao nível da variante, com denominadores, custo, incerteza e etiquetas de evidência observacional/randomizada, sobre todos os destinatários e conversões não rejeitadas da campanha.","description":"Endpoint selecionado: POST /outbound-calls/batches/{campaignId}/reports/preview.\n\nO que faz: Gera relatórios de campanha ao nível da variante, com denominadores, custo, incerteza e etiquetas de evidência observacional/randomizada, sobre todos os destinatários e conversões não rejeitadas da campanha.\n\nQuando usar: Utiliza esta operação para gera relatórios de campanha ao nível da variante, com denominadores, custo, incerteza e etiquetas de evidência observacional/randomizada, sobre todos os destinatários e conversões não rejeitadas da campanha.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: outboundCalls:read.\n\nParâmetros do caminho: campaignId: uuid.\n\nCorpo do pedido: randomized?: boolean; persistReport?: boolean.\n\nResposta: 200 { success, message, data: CampaignReportPreview }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/batches/{campaignId}/reports/preview. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/batches/{campaignId}/reports/preview Gera relatórios de campanha ao nível da variante, com denominadores, custo, incerteza e etiquetas de evidência observacional/randomizada, sobre todos os destinatários e conversões não rejeitadas da campanha. Finalidade: Utiliza esta operação para gera relatórios de campanha ao nível da variante, com denominadores, custo, incerteza e etiquetas de evidência observacional/randomizada, sobre todos os destinatários e conversões não rejeitadas da campanha. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-batches-by-campaignid-reports-preview","parameters":[{"name":"campaignId","in":"path","required":true,"description":"campaignId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"randomized":{"type":"string","description":"randomized?: boolean"},"persistReport":{"type":"string","description":"persistReport?: boolean"}}}}}},"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: CampaignReportPreview }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:read","x-atendia-ai-context":"POST /outbound-calls/batches/{campaignId}/reports/preview Gera relatórios de campanha ao nível da variante, com denominadores, custo, incerteza e etiquetas de evidência observacional/randomizada, sobre todos os destinatários e conversões não rejeitadas da campanha. Finalidade: Utiliza esta operação para gera relatórios de campanha ao nível da variante, com denominadores, custo, incerteza e etiquetas de evidência observacional/randomizada, sobre todos os destinatários e conversões não rejeitadas da campanha. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para gera relatórios de campanha ao nível da variante, com denominadores, custo, incerteza e etiquetas de evidência observacional/randomizada, sobre todos os destinatários e conversões não rejeitadas da campanha.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/outbound-calls/batches/{campaignId}/cancel":{"post":{"tags":["Chamadas de saída"],"summary":"Cancela uma campanha em lote, agendada ou já em curso (ACTIVE). As chamadas já feitas terminam normalmente; os destinatários ainda por ligar já não são chamados. Uma chave API só cancela campanhas criadas por chaves API.","description":"Endpoint selecionado: POST /outbound-calls/batches/{campaignId}/cancel.\n\nO que faz: Cancela uma campanha em lote, agendada ou já em curso (ACTIVE). As chamadas já feitas terminam normalmente; os destinatários ainda por ligar já não são chamados. Uma chave API só cancela campanhas criadas por chaves API.\n\nQuando usar: Utiliza esta operação para cancela uma campanha em lote, agendada ou já em curso (active). as chamadas já feitas terminam normalmente; os destinatários ainda por ligar já não são chamados. uma chave api só cancela campanhas criadas por chaves api.\n\nEfeitos secundários e risco: Interrompe trabalho ativo ou agendado; confirma antes de usar.\n\nAutenticação: Sessão ou chave API (leitura e chamadas).\n\nPermissão: outboundCalls:delete.\n\nParâmetros do caminho: campaignId: uuid.\n\nResposta: 200 { success, message, data: BatchCampaign }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/batches/{campaignId}/cancel. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/batches/{campaignId}/cancel Cancela uma campanha em lote, agendada ou já em curso (ACTIVE). As chamadas já feitas terminam normalmente; os destinatários ainda por ligar já não são chamados. Uma chave API só cancela campanhas criadas por chaves API. Finalidade: Utiliza esta operação para cancela uma campanha em lote, agendada ou já em curso (active). as chamadas já feitas terminam normalmente; os destinatários ainda por ligar já não são chamados. uma chave api só cancela campanhas criadas por chaves api. Efeitos secundários: Interrompe trabalho ativo ou agendado; confirma antes de usar.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-batches-by-campaignid-cancel","parameters":[{"name":"campaignId","in":"path","required":true,"description":"campaignId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: BatchCampaign }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:delete","x-atendia-ai-context":"POST /outbound-calls/batches/{campaignId}/cancel Cancela uma campanha em lote, agendada ou já em curso (ACTIVE). As chamadas já feitas terminam normalmente; os destinatários ainda por ligar já não são chamados. Uma chave API só cancela campanhas criadas por chaves API. Finalidade: Utiliza esta operação para cancela uma campanha em lote, agendada ou já em curso (active). as chamadas já feitas terminam normalmente; os destinatários ainda por ligar já não são chamados. uma chave api só cancela campanhas criadas por chaves api. Efeitos secundários: Interrompe trabalho ativo ou agendado; confirma antes de usar.","x-atendia-use-case":"Utiliza esta operação para cancela uma campanha em lote, agendada ou já em curso (active). as chamadas já feitas terminam normalmente; os destinatários ainda por ligar já não são chamados. uma chave api só cancela campanhas criadas por chaves api.","x-atendia-side-effects":"Interrompe trabalho ativo ou agendado; confirma antes de usar."}},"/outbound-calls/{outboundId}":{"get":{"tags":["Chamadas de saída"],"summary":"Consulta os detalhes de uma chamada de saída, com o estado, o motivo, a razão da espera, a hora a que sai (nextAttemptAt, quando espera pelo horário do agente ou pela nova tentativa automática), o limite notAfter, a chamada de volta marcada nesta chamada (callbackScheduled: { at, outboundId }, ou null), a chamada de onde veio uma chamada de volta (callbackOf: o outboundId dela, ou null), quem atendeu (answeredBy: person, voicemail, operator_recording ou nobody_spoke; só quando o reconhecimento correu, nobody_spoke sempre), se ficou mensagem na caixa de correio (messageLeft: true quando o agente a deixou), a tentativa em que vai (attempt: 1 na primeira chamada), o máximo de chamadas do pedido (maxAttempts), se o limite notAfter a fechou entre tentativas (endedByDeadline), a referência, a origem, a duração e, com callLogs:read, os dados recolhidos.","description":"Endpoint selecionado: GET /outbound-calls/{outboundId}.\n\nO que faz: Consulta os detalhes de uma chamada de saída, com o estado, o motivo, a razão da espera, a hora a que sai (nextAttemptAt, quando espera pelo horário do agente ou pela nova tentativa automática), o limite notAfter, a chamada de volta marcada nesta chamada (callbackScheduled: { at, outboundId }, ou null), a chamada de onde veio uma chamada de volta (callbackOf: o outboundId dela, ou null), quem atendeu (answeredBy: person, voicemail, operator_recording ou nobody_spoke; só quando o reconhecimento correu, nobody_spoke sempre), se ficou mensagem na caixa de correio (messageLeft: true quando o agente a deixou), a tentativa em que vai (attempt: 1 na primeira chamada), o máximo de chamadas do pedido (maxAttempts), se o limite notAfter a fechou entre tentativas (endedByDeadline), a referência, a origem, a duração e, com callLogs:read, os dados recolhidos.\n\nQuando usar: Utiliza esta operação para consulta os detalhes de uma chamada de saída, com o estado, o motivo, a razão da espera, a hora a que sai (nextattemptat, quando espera pelo horário do agente ou pela nova tentativa automática), o limite notafter, a chamada de volta marcada nesta chamada (callbackscheduled: { at, outboundid }, ou null), a chamada de onde veio uma chamada de volta (callbackof: o outboundid dela, ou null), quem atendeu (answeredby: person, voicemail, operator_recording ou nobody_spoke; só quando o reconhecimento correu, nobody_spoke sempre), se ficou mensagem na caixa de correio (messageleft: true quando o agente a deixou), a tentativa em que vai (attempt: 1 na primeira chamada), o máximo de chamadas do pedido (maxattempts), se o limite notafter a fechou entre tentativas (endedbydeadline), a referência, a origem, a duração e, com calllogs:read, os dados recolhidos.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: outboundCalls:read.\n\nParâmetros do caminho: outboundId: uuid.\n\nResposta: 200 { success, message, data: OutboundCall }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /outbound-calls/{outboundId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /outbound-calls/{outboundId} Consulta os detalhes de uma chamada de saída, com o estado, o motivo, a razão da espera, a hora a que sai (nextAttemptAt, quando espera pelo horário do agente ou pela nova tentativa automática), o limite notAfter, a chamada de volta marcada nesta chamada (callbackScheduled: { at, outboundId }, ou null), a chamada de onde veio uma chamada de volta (callbackOf: o outboundId dela, ou null), quem atendeu (answeredBy: person, voicemail, operator_recording ou nobody_spoke; só quando o reconhecimento correu, nobody_spoke sempre), se ficou mensagem na caixa de correio (messageLeft: true quando o agente a deixou), a tentativa em que vai (attempt: 1 na primeira chamada), o máximo de chamadas do pedido (maxAttempts), se o limite notAfter a fechou entre tentativas (endedByDeadline), a referência, a origem, a duração e, com callLogs:read, os dados recolhidos. Finalidade: Utiliza esta operação para consulta os detalhes de uma chamada de saída, com o estado, o motivo, a razão da espera, a hora a que sai (nextattemptat, quando espera pelo horário do agente ou pela nova tentativa automática), o limite notafter, a chamada de volta marcada nesta chamada (callbackscheduled: { at, outboundid }, ou null), a chamada de onde veio uma chamada de volta (callbackof: o outboundid dela, ou null), quem atendeu (answeredby: person, voicemail, operator_recording ou nobody_spoke; só quando o reconhecimento correu, nobody_spoke sempre), se ficou mensagem na caixa de correio (messageleft: true quando o agente a deixou), a tentativa em que vai (attempt: 1 na primeira chamada), o máximo de chamadas do pedido (maxattempts), se o limite notafter a fechou entre tentativas (endedbydeadline), a referência, a origem, a duração e, com calllogs:read, os dados recolhidos. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"get-outbound-calls-by-outboundid","parameters":[{"name":"outboundId","in":"path","required":true,"description":"outboundId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: OutboundCall }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:read","x-atendia-ai-context":"GET /outbound-calls/{outboundId} Consulta os detalhes de uma chamada de saída, com o estado, o motivo, a razão da espera, a hora a que sai (nextAttemptAt, quando espera pelo horário do agente ou pela nova tentativa automática), o limite notAfter, a chamada de volta marcada nesta chamada (callbackScheduled: { at, outboundId }, ou null), a chamada de onde veio uma chamada de volta (callbackOf: o outboundId dela, ou null), quem atendeu (answeredBy: person, voicemail, operator_recording ou nobody_spoke; só quando o reconhecimento correu, nobody_spoke sempre), se ficou mensagem na caixa de correio (messageLeft: true quando o agente a deixou), a tentativa em que vai (attempt: 1 na primeira chamada), o máximo de chamadas do pedido (maxAttempts), se o limite notAfter a fechou entre tentativas (endedByDeadline), a referência, a origem, a duração e, com callLogs:read, os dados recolhidos. Finalidade: Utiliza esta operação para consulta os detalhes de uma chamada de saída, com o estado, o motivo, a razão da espera, a hora a que sai (nextattemptat, quando espera pelo horário do agente ou pela nova tentativa automática), o limite notafter, a chamada de volta marcada nesta chamada (callbackscheduled: { at, outboundid }, ou null), a chamada de onde veio uma chamada de volta (callbackof: o outboundid dela, ou null), quem atendeu (answeredby: person, voicemail, operator_recording ou nobody_spoke; só quando o reconhecimento correu, nobody_spoke sempre), se ficou mensagem na caixa de correio (messageleft: true quando o agente a deixou), a tentativa em que vai (attempt: 1 na primeira chamada), o máximo de chamadas do pedido (maxattempts), se o limite notafter a fechou entre tentativas (endedbydeadline), a referência, a origem, a duração e, com calllogs:read, os dados recolhidos. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta os detalhes de uma chamada de saída, com o estado, o motivo, a razão da espera, a hora a que sai (nextattemptat, quando espera pelo horário do agente ou pela nova tentativa automática), o limite notafter, a chamada de volta marcada nesta chamada (callbackscheduled: { at, outboundid }, ou null), a chamada de onde veio uma chamada de volta (callbackof: o outboundid dela, ou null), quem atendeu (answeredby: person, voicemail, operator_recording ou nobody_spoke; só quando o reconhecimento correu, nobody_spoke sempre), se ficou mensagem na caixa de correio (messageleft: true quando o agente a deixou), a tentativa em que vai (attempt: 1 na primeira chamada), o máximo de chamadas do pedido (maxattempts), se o limite notafter a fechou entre tentativas (endedbydeadline), a referência, a origem, a duração e, com calllogs:read, os dados recolhidos.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/outbound-calls/{outboundId}/status":{"get":{"tags":["Chamadas de saída"],"summary":"Consulta o estado resumido de uma chamada de saída, para ir perguntando.","description":"Endpoint selecionado: GET /outbound-calls/{outboundId}/status.\n\nO que faz: Consulta o estado resumido de uma chamada de saída, para ir perguntando.\n\nQuando usar: Utiliza esta operação para consulta o estado resumido de uma chamada de saída, para ir perguntando.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: outboundCalls:read.\n\nParâmetros do caminho: outboundId: uuid.\n\nResposta: 200 { success, message, data: { outboundId, status, failureReason, updatedAt } }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /outbound-calls/{outboundId}/status. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /outbound-calls/{outboundId}/status Consulta o estado resumido de uma chamada de saída, para ir perguntando. Finalidade: Utiliza esta operação para consulta o estado resumido de uma chamada de saída, para ir perguntando. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"get-outbound-calls-by-outboundid-status","parameters":[{"name":"outboundId","in":"path","required":true,"description":"outboundId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: { outboundId, status, failureReason, updatedAt } }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:read","x-atendia-ai-context":"GET /outbound-calls/{outboundId}/status Consulta o estado resumido de uma chamada de saída, para ir perguntando. Finalidade: Utiliza esta operação para consulta o estado resumido de uma chamada de saída, para ir perguntando. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta o estado resumido de uma chamada de saída, para ir perguntando.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/outbound-calls/{outboundId}/cancel":{"post":{"tags":["Chamadas de saída"],"summary":"Cancela uma chamada de saída. Uma chave API só cancela as chamadas únicas pedidas por chaves API, antes de começarem a marcar; repetir o cancelamento dá a mesma resposta. Com a conversa em curso, é recusado com 400 e details.furtherAttempts false: já não fica marcada uma chamada de volta.","description":"Endpoint selecionado: POST /outbound-calls/{outboundId}/cancel.\n\nO que faz: Cancela uma chamada de saída. Uma chave API só cancela as chamadas únicas pedidas por chaves API, antes de começarem a marcar; repetir o cancelamento dá a mesma resposta. Com a conversa em curso, é recusado com 400 e details.furtherAttempts false: já não fica marcada uma chamada de volta.\n\nQuando usar: Utiliza esta operação para cancela uma chamada de saída. uma chave api só cancela as chamadas únicas pedidas por chaves api, antes de começarem a marcar; repetir o cancelamento dá a mesma resposta. com a conversa em curso, é recusado com 400 e details.furtherattempts false: já não fica marcada uma chamada de volta.\n\nEfeitos secundários e risco: Interrompe trabalho ativo ou agendado; confirma antes de usar.\n\nAutenticação: Sessão ou chave API (leitura e chamadas).\n\nPermissão: outboundCalls:delete.\n\nParâmetros do caminho: outboundId: uuid.\n\nCorpo do pedido: reason?: string, máximo de 500 caracteres.\n\nResposta: 200 { success, message, data: OutboundCall }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/{outboundId}/cancel. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/{outboundId}/cancel Cancela uma chamada de saída. Uma chave API só cancela as chamadas únicas pedidas por chaves API, antes de começarem a marcar; repetir o cancelamento dá a mesma resposta. Com a conversa em curso, é recusado com 400 e details.furtherAttempts false: já não fica marcada uma chamada de volta. Finalidade: Utiliza esta operação para cancela uma chamada de saída. uma chave api só cancela as chamadas únicas pedidas por chaves api, antes de começarem a marcar; repetir o cancelamento dá a mesma resposta. com a conversa em curso, é recusado com 400 e details.furtherattempts false: já não fica marcada uma chamada de volta. Efeitos secundários: Interrompe trabalho ativo ou agendado; confirma antes de usar.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-by-outboundid-cancel","parameters":[{"name":"outboundId","in":"path","required":true,"description":"outboundId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"reason":{"type":"string","description":"reason?: string, máximo de 500 caracteres"}}}}}},"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: OutboundCall }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:delete","x-atendia-ai-context":"POST /outbound-calls/{outboundId}/cancel Cancela uma chamada de saída. Uma chave API só cancela as chamadas únicas pedidas por chaves API, antes de começarem a marcar; repetir o cancelamento dá a mesma resposta. Com a conversa em curso, é recusado com 400 e details.furtherAttempts false: já não fica marcada uma chamada de volta. Finalidade: Utiliza esta operação para cancela uma chamada de saída. uma chave api só cancela as chamadas únicas pedidas por chaves api, antes de começarem a marcar; repetir o cancelamento dá a mesma resposta. com a conversa em curso, é recusado com 400 e details.furtherattempts false: já não fica marcada uma chamada de volta. Efeitos secundários: Interrompe trabalho ativo ou agendado; confirma antes de usar.","x-atendia-use-case":"Utiliza esta operação para cancela uma chamada de saída. uma chave api só cancela as chamadas únicas pedidas por chaves api, antes de começarem a marcar; repetir o cancelamento dá a mesma resposta. com a conversa em curso, é recusado com 400 e details.furtherattempts false: já não fica marcada uma chamada de volta.","x-atendia-side-effects":"Interrompe trabalho ativo ou agendado; confirma antes de usar."}},"/outbound-calls/{outboundId}/retry":{"post":{"tags":["Chamadas de saída"],"summary":"Repete uma chamada de saída que falhou ou foi cancelada.","description":"Endpoint selecionado: POST /outbound-calls/{outboundId}/retry.\n\nO que faz: Repete uma chamada de saída que falhou ou foi cancelada.\n\nQuando usar: Utiliza esta operação para repete uma chamada de saída que falhou ou foi cancelada.\n\nEfeitos secundários e risco: Pode repetir uma chamada ou fluxo; confirma antes de usar, pois pode contactar uma pessoa ou consumir recursos.\n\nAutenticação: Apenas sessão.\n\nPermissão: outboundCalls:create.\n\nParâmetros do caminho: outboundId: uuid.\n\nResposta: 201 { success, message, data: OutboundCall }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /outbound-calls/{outboundId}/retry. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /outbound-calls/{outboundId}/retry Repete uma chamada de saída que falhou ou foi cancelada. Finalidade: Utiliza esta operação para repete uma chamada de saída que falhou ou foi cancelada. Efeitos secundários: Pode repetir uma chamada ou fluxo; confirma antes de usar, pois pode contactar uma pessoa ou consumir recursos.\n\nOrigem: apps/server/src/modules/outbound/outbound-call.route.ts.","operationId":"post-outbound-calls-by-outboundid-retry","parameters":[{"name":"outboundId","in":"path","required":true,"description":"outboundId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"201":{"description":"{ success, message, data: OutboundCall }"}},"x-atendia-source":"apps/server/src/modules/outbound/outbound-call.route.ts","x-atendia-permission":"outboundCalls:create","x-atendia-ai-context":"POST /outbound-calls/{outboundId}/retry Repete uma chamada de saída que falhou ou foi cancelada. Finalidade: Utiliza esta operação para repete uma chamada de saída que falhou ou foi cancelada. Efeitos secundários: Pode repetir uma chamada ou fluxo; confirma antes de usar, pois pode contactar uma pessoa ou consumir recursos.","x-atendia-use-case":"Utiliza esta operação para repete uma chamada de saída que falhou ou foi cancelada.","x-atendia-side-effects":"Pode repetir uma chamada ou fluxo; confirma antes de usar, pois pode contactar uma pessoa ou consumir recursos."}},"/kb":{"post":{"tags":["Base de conhecimento"],"summary":"Cria fontes de conhecimento para um agente.","description":"Endpoint selecionado: POST /kb.\n\nO que faz: Cria fontes de conhecimento para um agente.\n\nQuando usar: Utiliza esta operação para cria fontes de conhecimento para um agente.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: knowledgeSource:create.\n\nCorpo do pedido: agentId: uuid; documents: Array<{ name, sourceType, url?, s3Key?, originalFileName? }>.\n\nResposta: 201 { success, message, data: KnowledgeSource[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /kb. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /kb Cria fontes de conhecimento para um agente. Finalidade: Utiliza esta operação para cria fontes de conhecimento para um agente. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/kb/kb.route.ts.","operationId":"post-kb","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"agentId":{"type":"string","description":"agentId: uuid"},"documents":{"type":"string","description":"documents: Array<{ name, sourceType, url?, s3Key?, originalFileName? }>"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"201":{"description":"{ success, message, data: KnowledgeSource[] }"}},"x-atendia-source":"apps/server/src/modules/kb/kb.route.ts","x-atendia-permission":"knowledgeSource:create","x-atendia-ai-context":"POST /kb Cria fontes de conhecimento para um agente. Finalidade: Utiliza esta operação para cria fontes de conhecimento para um agente. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para cria fontes de conhecimento para um agente.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."},"get":{"tags":["Base de conhecimento"],"summary":"Lista fontes de conhecimento, opcionalmente associadas a um agente.","description":"Endpoint selecionado: GET /kb.\n\nO que faz: Lista fontes de conhecimento, opcionalmente associadas a um agente.\n\nQuando usar: Utiliza esta operação para lista fontes de conhecimento, opcionalmente associadas a um agente.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: knowledgeSource:read.\n\nParâmetros de query: agentId?: uuid.\n\nResposta: 200 { success, message, data: KnowledgeSource[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /kb. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /kb Lista fontes de conhecimento, opcionalmente associadas a um agente. Finalidade: Utiliza esta operação para lista fontes de conhecimento, opcionalmente associadas a um agente. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/kb/kb.route.ts.","operationId":"get-kb","parameters":[{"name":"agentId","in":"query","required":false,"description":"agentId?: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: KnowledgeSource[] }"}},"x-atendia-source":"apps/server/src/modules/kb/kb.route.ts","x-atendia-permission":"knowledgeSource:read","x-atendia-ai-context":"GET /kb Lista fontes de conhecimento, opcionalmente associadas a um agente. Finalidade: Utiliza esta operação para lista fontes de conhecimento, opcionalmente associadas a um agente. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista fontes de conhecimento, opcionalmente associadas a um agente.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/kb/upload-url":{"get":{"tags":["Base de conhecimento"],"summary":"Cria um URL de carregamento S3 pré-assinado para um ficheiro de conhecimento.","description":"Endpoint selecionado: GET /kb/upload-url.\n\nO que faz: Cria um URL de carregamento S3 pré-assinado para um ficheiro de conhecimento.\n\nQuando usar: Utiliza esta operação para cria um url de carregamento s3 pré-assinado para um ficheiro de conhecimento.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Apenas sessão.\n\nPermissão: knowledgeSource:create.\n\nParâmetros de query: fileName: string; contentType: string MIME.\n\nResposta: 200 { success, message, data: { uploadUrl, s3Key } }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /kb/upload-url. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /kb/upload-url Cria um URL de carregamento S3 pré-assinado para um ficheiro de conhecimento. Finalidade: Utiliza esta operação para cria um url de carregamento s3 pré-assinado para um ficheiro de conhecimento. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/kb/kb.route.ts.","operationId":"get-kb-upload-url","parameters":[{"name":"fileName","in":"query","required":true,"description":"fileName: string","schema":{"type":"string"}},{"name":"contentType","in":"query","required":true,"description":"contentType: string MIME","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: { uploadUrl, s3Key } }"}},"x-atendia-source":"apps/server/src/modules/kb/kb.route.ts","x-atendia-permission":"knowledgeSource:create","x-atendia-ai-context":"GET /kb/upload-url Cria um URL de carregamento S3 pré-assinado para um ficheiro de conhecimento. Finalidade: Utiliza esta operação para cria um url de carregamento s3 pré-assinado para um ficheiro de conhecimento. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para cria um url de carregamento s3 pré-assinado para um ficheiro de conhecimento.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/kb/{kbId}":{"delete":{"tags":["Base de conhecimento"],"summary":"Elimina uma fonte de conhecimento.","description":"Endpoint selecionado: DELETE /kb/{kbId}.\n\nO que faz: Elimina uma fonte de conhecimento.\n\nQuando usar: Utiliza esta operação para elimina uma fonte de conhecimento.\n\nEfeitos secundários e risco: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: knowledgeSource:delete.\n\nParâmetros do caminho: kbId: uuid.\n\nResposta: 200 { success, message }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre DELETE /kb/{kbId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: DELETE /kb/{kbId} Elimina uma fonte de conhecimento. Finalidade: Utiliza esta operação para elimina uma fonte de conhecimento. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nOrigem: apps/server/src/modules/kb/kb.route.ts.","operationId":"delete-kb-by-kbid","parameters":[{"name":"kbId","in":"path","required":true,"description":"kbId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message }"}},"x-atendia-source":"apps/server/src/modules/kb/kb.route.ts","x-atendia-permission":"knowledgeSource:delete","x-atendia-ai-context":"DELETE /kb/{kbId} Elimina uma fonte de conhecimento. Finalidade: Utiliza esta operação para elimina uma fonte de conhecimento. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.","x-atendia-use-case":"Utiliza esta operação para elimina uma fonte de conhecimento.","x-atendia-side-effects":"Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador."}},"/tools":{"get":{"tags":["Ferramentas"],"summary":"Lista as ferramentas da organização.","description":"Endpoint selecionado: GET /tools.\n\nO que faz: Lista as ferramentas da organização.\n\nQuando usar: Utiliza esta operação para lista as ferramentas da organização.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: tools:read.\n\nResposta: 200 { success, message, data: Tool[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /tools. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /tools Lista as ferramentas da organização. Finalidade: Utiliza esta operação para lista as ferramentas da organização. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/tools/tool.route.ts.","operationId":"get-tools","security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: Tool[] }"}},"x-atendia-source":"apps/server/src/modules/tools/tool.route.ts","x-atendia-permission":"tools:read","x-atendia-ai-context":"GET /tools Lista as ferramentas da organização. Finalidade: Utiliza esta operação para lista as ferramentas da organização. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista as ferramentas da organização.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."},"post":{"tags":["Ferramentas"],"summary":"Cria uma definição de ferramenta HTTP.","description":"Endpoint selecionado: POST /tools.\n\nO que faz: Cria uma definição de ferramenta HTTP.\n\nQuando usar: Utiliza esta operação para cria uma definição de ferramenta http.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: tools:create.\n\nCorpo do pedido: name, description, api_url; api_method?: GET|POST|PUT|PATCH|DELETE; api_headers?, api_body?, api_query_params?, api_path_params?; api_body[].path?: onde o valor fica no corpo JSON, por exemplo cliente.nome ou servicos[0].id (só no corpo; letras, dígitos e _ $ @ : -, no máximo 8 passos e 200 caracteres; vazio é o mesmo que nenhum); Um Static Value em api_body, api_query_params ou api_path_params fica guardado cifrado; quem pode editar ferramentas lê-o em claro. Um valor que comece por qvsec: é recusado (400); response_fields?: os campos que o agente lê da resposta, [{ name, path }], de 0 a 20; null ou vazio dá a resposta inteira. name: letras, dígitos e _ (até 64), único e sem ar de segredo (token, password, webhook...); path: por exemplo cliente.nome ou servicos[*].id. A resposta é limpa antes de os campos serem escolhidos. Devolvido em todas as leituras da ferramenta; response_timeout_secs?, dynamic_variables?; disable_interruptions?, force_pre_tool_speech?.\n\nResposta: 201 { success, message, data: Tool }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /tools. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /tools Cria uma definição de ferramenta HTTP. Finalidade: Utiliza esta operação para cria uma definição de ferramenta http. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/tools/tool.route.ts.","operationId":"post-tools","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"name, description, api_url"},"api_method":{"type":"string","description":"api_method?: GET|POST|PUT|PATCH|DELETE"},"api_headers":{"type":"string","description":"api_headers?, api_body?, api_query_params?, api_path_params?"},"api_body[].path":{"type":"string","description":"api_body[].path?: onde o valor fica no corpo JSON, por exemplo cliente.nome ou servicos[0].id (só no corpo; letras, dígitos e _ $ @ : -, no máximo 8 passos e 200 caracteres; vazio é o mesmo que nenhum)"},"Um Static Value em api_body":{"type":"string","description":"Um Static Value em api_body, api_query_params ou api_path_params fica guardado cifrado; quem pode editar ferramentas lê-o em claro. Um valor que comece por qvsec: é recusado (400)"},"response_fields":{"type":"string","description":"response_fields?: os campos que o agente lê da resposta, [{ name, path }], de 0 a 20; null ou vazio dá a resposta inteira. name: letras, dígitos e _ (até 64), único e sem ar de segredo (token, password, webhook...); path: por exemplo cliente.nome ou servicos[*].id. A resposta é limpa antes de os campos serem escolhidos. Devolvido em todas as leituras da ferramenta"},"response_timeout_secs":{"type":"string","description":"response_timeout_secs?, dynamic_variables?"},"disable_interruptions":{"type":"string","description":"disable_interruptions?, force_pre_tool_speech?"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"201":{"description":"{ success, message, data: Tool }"}},"x-atendia-source":"apps/server/src/modules/tools/tool.route.ts","x-atendia-permission":"tools:create","x-atendia-ai-context":"POST /tools Cria uma definição de ferramenta HTTP. Finalidade: Utiliza esta operação para cria uma definição de ferramenta http. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para cria uma definição de ferramenta http.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/tools/{toolId}":{"patch":{"tags":["Ferramentas"],"summary":"Atualiza uma definição de ferramenta HTTP.","description":"Endpoint selecionado: PATCH /tools/{toolId}.\n\nO que faz: Atualiza uma definição de ferramenta HTTP.\n\nQuando usar: Utiliza esta operação para atualiza uma definição de ferramenta http.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: tools:update.\n\nParâmetros do caminho: toolId: uuid.\n\nCorpo do pedido: Qualquer campo de create-tool; pelo menos um é obrigatório; Um campo que não vem fica com o valor guardado: não há valores por omissão.\n\nResposta: 200 { success, message, data: Tool }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre PATCH /tools/{toolId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: PATCH /tools/{toolId} Atualiza uma definição de ferramenta HTTP. Finalidade: Utiliza esta operação para atualiza uma definição de ferramenta http. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/tools/tool.route.ts.","operationId":"patch-tools-by-toolid","parameters":[{"name":"toolId","in":"path","required":true,"description":"toolId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Qualquer campo de create-tool; pelo menos um é obrigatório":{"type":"string","description":"Qualquer campo de create-tool; pelo menos um é obrigatório"},"Um campo que não vem fica com o valor guardado":{"type":"string","description":"Um campo que não vem fica com o valor guardado: não há valores por omissão"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: Tool }"}},"x-atendia-source":"apps/server/src/modules/tools/tool.route.ts","x-atendia-permission":"tools:update","x-atendia-ai-context":"PATCH /tools/{toolId} Atualiza uma definição de ferramenta HTTP. Finalidade: Utiliza esta operação para atualiza uma definição de ferramenta http. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para atualiza uma definição de ferramenta http.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."},"delete":{"tags":["Ferramentas"],"summary":"Elimina uma ferramenta HTTP.","description":"Endpoint selecionado: DELETE /tools/{toolId}.\n\nO que faz: Elimina uma ferramenta HTTP.\n\nQuando usar: Utiliza esta operação para elimina uma ferramenta http.\n\nEfeitos secundários e risco: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: tools:delete.\n\nParâmetros do caminho: toolId: uuid.\n\nResposta: 200 { success, message, data: null }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre DELETE /tools/{toolId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: DELETE /tools/{toolId} Elimina uma ferramenta HTTP. Finalidade: Utiliza esta operação para elimina uma ferramenta http. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nOrigem: apps/server/src/modules/tools/tool.route.ts.","operationId":"delete-tools-by-toolid","parameters":[{"name":"toolId","in":"path","required":true,"description":"toolId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: null }"}},"x-atendia-source":"apps/server/src/modules/tools/tool.route.ts","x-atendia-permission":"tools:delete","x-atendia-ai-context":"DELETE /tools/{toolId} Elimina uma ferramenta HTTP. Finalidade: Utiliza esta operação para elimina uma ferramenta http. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.","x-atendia-use-case":"Utiliza esta operação para elimina uma ferramenta http.","x-atendia-side-effects":"Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador."}},"/tools/agent/{agentId}":{"get":{"tags":["Ferramentas"],"summary":"Lista as ferramentas associadas a um agente.","description":"Endpoint selecionado: GET /tools/agent/{agentId}.\n\nO que faz: Lista as ferramentas associadas a um agente.\n\nQuando usar: Utiliza esta operação para lista as ferramentas associadas a um agente.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: tools:read.\n\nParâmetros do caminho: agentId: uuid.\n\nResposta: 200 { success, message, data: Tool[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /tools/agent/{agentId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /tools/agent/{agentId} Lista as ferramentas associadas a um agente. Finalidade: Utiliza esta operação para lista as ferramentas associadas a um agente. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/tools/tool.route.ts.","operationId":"get-tools-agent-by-agentid","parameters":[{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: Tool[] }"}},"x-atendia-source":"apps/server/src/modules/tools/tool.route.ts","x-atendia-permission":"tools:read","x-atendia-ai-context":"GET /tools/agent/{agentId} Lista as ferramentas associadas a um agente. Finalidade: Utiliza esta operação para lista as ferramentas associadas a um agente. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista as ferramentas associadas a um agente.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/tools/{toolId}/attach/{agentId}":{"post":{"tags":["Ferramentas"],"summary":"Associa uma ferramenta a um agente.","description":"Endpoint selecionado: POST /tools/{toolId}/attach/{agentId}.\n\nO que faz: Associa uma ferramenta a um agente.\n\nQuando usar: Utiliza esta operação para associa uma ferramenta a um agente.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: tools:update.\n\nParâmetros do caminho: toolId: uuid; agentId: uuid.\n\nResposta: 200 { success, message, data: null }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /tools/{toolId}/attach/{agentId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /tools/{toolId}/attach/{agentId} Associa uma ferramenta a um agente. Finalidade: Utiliza esta operação para associa uma ferramenta a um agente. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/tools/tool.route.ts.","operationId":"post-tools-by-toolid-attach-by-agentid","parameters":[{"name":"toolId","in":"path","required":true,"description":"toolId: uuid","schema":{"type":"string"}},{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: null }"}},"x-atendia-source":"apps/server/src/modules/tools/tool.route.ts","x-atendia-permission":"tools:update","x-atendia-ai-context":"POST /tools/{toolId}/attach/{agentId} Associa uma ferramenta a um agente. Finalidade: Utiliza esta operação para associa uma ferramenta a um agente. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para associa uma ferramenta a um agente.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/tools/{toolId}/detach/{agentId}":{"delete":{"tags":["Ferramentas"],"summary":"Desassocia uma ferramenta de um agente.","description":"Endpoint selecionado: DELETE /tools/{toolId}/detach/{agentId}.\n\nO que faz: Desassocia uma ferramenta de um agente.\n\nQuando usar: Utiliza esta operação para desassocia uma ferramenta de um agente.\n\nEfeitos secundários e risco: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: tools:update.\n\nParâmetros do caminho: toolId: uuid; agentId: uuid.\n\nResposta: 200 { success, message, data: null }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre DELETE /tools/{toolId}/detach/{agentId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: DELETE /tools/{toolId}/detach/{agentId} Desassocia uma ferramenta de um agente. Finalidade: Utiliza esta operação para desassocia uma ferramenta de um agente. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nOrigem: apps/server/src/modules/tools/tool.route.ts.","operationId":"delete-tools-by-toolid-detach-by-agentid","parameters":[{"name":"toolId","in":"path","required":true,"description":"toolId: uuid","schema":{"type":"string"}},{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: null }"}},"x-atendia-source":"apps/server/src/modules/tools/tool.route.ts","x-atendia-permission":"tools:update","x-atendia-ai-context":"DELETE /tools/{toolId}/detach/{agentId} Desassocia uma ferramenta de um agente. Finalidade: Utiliza esta operação para desassocia uma ferramenta de um agente. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.","x-atendia-use-case":"Utiliza esta operação para desassocia uma ferramenta de um agente.","x-atendia-side-effects":"Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador."}},"/secrets":{"get":{"tags":["Segredos"],"summary":"Lista os metadados dos segredos. Os valores dos segredos são redigidos.","description":"Endpoint selecionado: GET /secrets.\n\nO que faz: Lista os metadados dos segredos. Os valores dos segredos são redigidos.\n\nQuando usar: Utiliza esta operação para lista os metadados dos segredos. os valores dos segredos são redigidos.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Apenas sessão.\n\nPermissão: secrets:read.\n\nResposta: 200 { success, message, data: SecretMetadata[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /secrets. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /secrets Lista os metadados dos segredos. Os valores dos segredos são redigidos. Finalidade: Utiliza esta operação para lista os metadados dos segredos. os valores dos segredos são redigidos. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/secrets/secret.route.ts.","operationId":"get-secrets","security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: SecretMetadata[] }"}},"x-atendia-source":"apps/server/src/modules/secrets/secret.route.ts","x-atendia-permission":"secrets:read","x-atendia-ai-context":"GET /secrets Lista os metadados dos segredos. Os valores dos segredos são redigidos. Finalidade: Utiliza esta operação para lista os metadados dos segredos. os valores dos segredos são redigidos. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista os metadados dos segredos. os valores dos segredos são redigidos.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."},"post":{"tags":["Segredos"],"summary":"Cria um valor secreto.","description":"Endpoint selecionado: POST /secrets.\n\nO que faz: Cria um valor secreto.\n\nQuando usar: Utiliza esta operação para cria um valor secreto.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: secrets:create.\n\nCorpo do pedido: name: letras, números, pontos, underscores, dois pontos e hífen; máximo 120; value: non-empty string.\n\nResposta: 201 { success, message, data: SecretMetadata }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /secrets. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /secrets Cria um valor secreto. Finalidade: Utiliza esta operação para cria um valor secreto. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/secrets/secret.route.ts.","operationId":"post-secrets","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"name: letras, números, pontos, underscores, dois pontos e hífen; máximo 120"},"value":{"type":"string","description":"value: non-empty string"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"201":{"description":"{ success, message, data: SecretMetadata }"}},"x-atendia-source":"apps/server/src/modules/secrets/secret.route.ts","x-atendia-permission":"secrets:create","x-atendia-ai-context":"POST /secrets Cria um valor secreto. Finalidade: Utiliza esta operação para cria um valor secreto. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para cria um valor secreto.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/secrets/{secretId}":{"delete":{"tags":["Segredos"],"summary":"Elimina um segredo.","description":"Endpoint selecionado: DELETE /secrets/{secretId}.\n\nO que faz: Elimina um segredo.\n\nQuando usar: Utiliza esta operação para elimina um segredo.\n\nEfeitos secundários e risco: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: secrets:delete.\n\nParâmetros do caminho: secretId: uuid.\n\nResposta: 200 { success, message, data: null }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre DELETE /secrets/{secretId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: DELETE /secrets/{secretId} Elimina um segredo. Finalidade: Utiliza esta operação para elimina um segredo. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nOrigem: apps/server/src/modules/secrets/secret.route.ts.","operationId":"delete-secrets-by-secretid","parameters":[{"name":"secretId","in":"path","required":true,"description":"secretId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: null }"}},"x-atendia-source":"apps/server/src/modules/secrets/secret.route.ts","x-atendia-permission":"secrets:delete","x-atendia-ai-context":"DELETE /secrets/{secretId} Elimina um segredo. Finalidade: Utiliza esta operação para elimina um segredo. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.","x-atendia-use-case":"Utiliza esta operação para elimina um segredo.","x-atendia-side-effects":"Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador."}},"/agents/{agentId}/widgets":{"get":{"tags":["Widgets de website"],"summary":"Lista os widgets de um agente.","description":"Endpoint selecionado: GET /agents/{agentId}/widgets.\n\nO que faz: Lista os widgets de um agente.\n\nQuando usar: Utiliza esta operação para lista os widgets de um agente.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: agentWidget:read.\n\nParâmetros do caminho: agentId: uuid.\n\nResposta: 200 { success, message, data: AgentWidget[] }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /agents/{agentId}/widgets. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /agents/{agentId}/widgets Lista os widgets de um agente. Finalidade: Utiliza esta operação para lista os widgets de um agente. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/widgets/widget.route.ts.","operationId":"get-agents-by-agentid-widgets","parameters":[{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: AgentWidget[] }"}},"x-atendia-source":"apps/server/src/modules/widgets/widget.route.ts","x-atendia-permission":"agentWidget:read","x-atendia-ai-context":"GET /agents/{agentId}/widgets Lista os widgets de um agente. Finalidade: Utiliza esta operação para lista os widgets de um agente. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista os widgets de um agente.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."},"post":{"tags":["Widgets de website"],"summary":"Cria um widget de website para um agente.","description":"Endpoint selecionado: POST /agents/{agentId}/widgets.\n\nO que faz: Cria um widget de website para um agente.\n\nQuando usar: Utiliza esta operação para cria um widget de website para um agente.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: agentWidget:create.\n\nParâmetros do caminho: agentId: uuid.\n\nCorpo do pedido: name: 2-80 chars; enabled?: boolean; allowedOrigins?: string[] máximo 20; theme: widget theme object; consentRequired?: boolean; consentText?: string max 240.\n\nResposta: 201 { success, message, data: AgentWidget }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /agents/{agentId}/widgets. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /agents/{agentId}/widgets Cria um widget de website para um agente. Finalidade: Utiliza esta operação para cria um widget de website para um agente. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/widgets/widget.route.ts.","operationId":"post-agents-by-agentid-widgets","parameters":[{"name":"agentId","in":"path","required":true,"description":"agentId: uuid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"name: 2-80 chars"},"enabled":{"type":"string","description":"enabled?: boolean"},"allowedOrigins":{"type":"string","description":"allowedOrigins?: string[] máximo 20"},"theme":{"type":"string","description":"theme: widget theme object"},"consentRequired":{"type":"string","description":"consentRequired?: boolean"},"consentText":{"type":"string","description":"consentText?: string max 240"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"201":{"description":"{ success, message, data: AgentWidget }"}},"x-atendia-source":"apps/server/src/modules/widgets/widget.route.ts","x-atendia-permission":"agentWidget:create","x-atendia-ai-context":"POST /agents/{agentId}/widgets Cria um widget de website para um agente. Finalidade: Utiliza esta operação para cria um widget de website para um agente. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para cria um widget de website para um agente.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."}},"/widgets/{widgetId}":{"get":{"tags":["Widgets de website"],"summary":"Consulta a configuração de um widget.","description":"Endpoint selecionado: GET /widgets/{widgetId}.\n\nO que faz: Consulta a configuração de um widget.\n\nQuando usar: Utiliza esta operação para consulta a configuração de um widget.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: agentWidget:read.\n\nParâmetros do caminho: widgetId: string (wgt_ + 24 caracteres).\n\nResposta: 200 { success, message, data: AgentWidget }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /widgets/{widgetId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /widgets/{widgetId} Consulta a configuração de um widget. Finalidade: Utiliza esta operação para consulta a configuração de um widget. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/widgets/widget.route.ts.","operationId":"get-widgets-by-widgetid","parameters":[{"name":"widgetId","in":"path","required":true,"description":"widgetId: string (wgt_ + 24 caracteres)","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: AgentWidget }"}},"x-atendia-source":"apps/server/src/modules/widgets/widget.route.ts","x-atendia-permission":"agentWidget:read","x-atendia-ai-context":"GET /widgets/{widgetId} Consulta a configuração de um widget. Finalidade: Utiliza esta operação para consulta a configuração de um widget. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta a configuração de um widget.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."},"patch":{"tags":["Widgets de website"],"summary":"Atualiza a configuração de um widget.","description":"Endpoint selecionado: PATCH /widgets/{widgetId}.\n\nO que faz: Atualiza a configuração de um widget.\n\nQuando usar: Utiliza esta operação para atualiza a configuração de um widget.\n\nEfeitos secundários e risco: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: agentWidget:update.\n\nParâmetros do caminho: widgetId: string (wgt_ + 24 caracteres).\n\nCorpo do pedido: Qualquer campo de create-widget; pelo menos um é obrigatório.\n\nResposta: 200 { success, message, data: AgentWidget }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre PATCH /widgets/{widgetId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: PATCH /widgets/{widgetId} Atualiza a configuração de um widget. Finalidade: Utiliza esta operação para atualiza a configuração de um widget. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.\n\nOrigem: apps/server/src/modules/widgets/widget.route.ts.","operationId":"patch-widgets-by-widgetid","parameters":[{"name":"widgetId","in":"path","required":true,"description":"widgetId: string (wgt_ + 24 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Qualquer campo de create-widget; pelo menos um é obrigatório":{"type":"string","description":"Qualquer campo de create-widget; pelo menos um é obrigatório"}}}}}},"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: AgentWidget }"}},"x-atendia-source":"apps/server/src/modules/widgets/widget.route.ts","x-atendia-permission":"agentWidget:update","x-atendia-ai-context":"PATCH /widgets/{widgetId} Atualiza a configuração de um widget. Finalidade: Utiliza esta operação para atualiza a configuração de um widget. Efeitos secundários: Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador.","x-atendia-use-case":"Utiliza esta operação para atualiza a configuração de um widget.","x-atendia-side-effects":"Escreve ou atualiza dados da Atendia; exige autorização adequada e intenção do utilizador."},"delete":{"tags":["Widgets de website"],"summary":"Elimina um widget de website.","description":"Endpoint selecionado: DELETE /widgets/{widgetId}.\n\nO que faz: Elimina um widget de website.\n\nQuando usar: Utiliza esta operação para elimina um widget de website.\n\nEfeitos secundários e risco: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nAutenticação: Apenas sessão.\n\nPermissão: agentWidget:delete.\n\nParâmetros do caminho: widgetId: string (wgt_ + 24 caracteres).\n\nResposta: 200 { success, message, data: null }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre DELETE /widgets/{widgetId}. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: DELETE /widgets/{widgetId} Elimina um widget de website. Finalidade: Utiliza esta operação para elimina um widget de website. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.\n\nOrigem: apps/server/src/modules/widgets/widget.route.ts.","operationId":"delete-widgets-by-widgetid","parameters":[{"name":"widgetId","in":"path","required":true,"description":"widgetId: string (wgt_ + 24 caracteres)","schema":{"type":"string"}}],"security":[{"sessionCookie":[]}],"responses":{"200":{"description":"{ success, message, data: null }"}},"x-atendia-source":"apps/server/src/modules/widgets/widget.route.ts","x-atendia-permission":"agentWidget:delete","x-atendia-ai-context":"DELETE /widgets/{widgetId} Elimina um widget de website. Finalidade: Utiliza esta operação para elimina um widget de website. Efeitos secundários: Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador.","x-atendia-use-case":"Utiliza esta operação para elimina um widget de website.","x-atendia-side-effects":"Destrutiva; remove ou desassocia dados e deve exigir confirmação do utilizador."}},"/public/widgets/{widgetId}/config":{"get":{"tags":["Widgets de website"],"summary":"Consulta a configuração pública usada pelo script do widget incorporável.","description":"Endpoint selecionado: GET /public/widgets/{widgetId}/config.\n\nO que faz: Consulta a configuração pública usada pelo script do widget incorporável.\n\nQuando usar: Utiliza esta operação para consulta a configuração pública usada pelo script do widget incorporável.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Lista de origens permitidas.\n\nParâmetros do caminho: widgetId: string (wgt_ + 24 caracteres).\n\nResposta: 200 { success, message, data: PublicWidgetConfig }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /public/widgets/{widgetId}/config. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /public/widgets/{widgetId}/config Consulta a configuração pública usada pelo script do widget incorporável. Finalidade: Utiliza esta operação para consulta a configuração pública usada pelo script do widget incorporável. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/widgets/widget.route.ts.","operationId":"get-public-widgets-by-widgetid-config","parameters":[{"name":"widgetId","in":"path","required":true,"description":"widgetId: string (wgt_ + 24 caracteres)","schema":{"type":"string"}}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: PublicWidgetConfig }"}},"x-atendia-source":"apps/server/src/modules/widgets/widget.route.ts","x-atendia-ai-context":"GET /public/widgets/{widgetId}/config Consulta a configuração pública usada pelo script do widget incorporável. Finalidade: Utiliza esta operação para consulta a configuração pública usada pelo script do widget incorporável. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta a configuração pública usada pelo script do widget incorporável.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/public/widgets/{widgetId}/sessions":{"post":{"tags":["Widgets de website"],"summary":"Cria uma sessão pública do widget de voz.","description":"Endpoint selecionado: POST /public/widgets/{widgetId}/sessions.\n\nO que faz: Cria uma sessão pública do widget de voz.\n\nQuando usar: Utiliza esta operação para cria uma sessão pública do widget de voz.\n\nEfeitos secundários e risco: Cria uma chamada ou sessão em tempo real; pode consumir minutos ou contactar uma pessoa, por isso confirma a intenção antes de usar.\n\nAutenticação: Lista de origens permitidas.\n\nParâmetros do caminho: widgetId: string (wgt_ + 24 caracteres).\n\nCorpo do pedido: visitorId?: string máximo 120; dynamicVariables?: Record<string, string>.\n\nResposta: 201 { success, message, data: PublicWidgetSession }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /public/widgets/{widgetId}/sessions. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /public/widgets/{widgetId}/sessions Cria uma sessão pública do widget de voz. Finalidade: Utiliza esta operação para cria uma sessão pública do widget de voz. Efeitos secundários: Cria uma chamada ou sessão em tempo real; pode consumir minutos ou contactar uma pessoa, por isso confirma a intenção antes de usar.\n\nOrigem: apps/server/src/modules/widgets/widget.route.ts.","operationId":"post-public-widgets-by-widgetid-sessions","parameters":[{"name":"widgetId","in":"path","required":true,"description":"widgetId: string (wgt_ + 24 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"visitorId":{"type":"string","description":"visitorId?: string máximo 120"},"dynamicVariables":{"type":"string","description":"dynamicVariables?: Record<string, string>"}}}}}},"security":[{"apiKey":[]}],"responses":{"201":{"description":"{ success, message, data: PublicWidgetSession }"}},"x-atendia-source":"apps/server/src/modules/widgets/widget.route.ts","x-atendia-ai-context":"POST /public/widgets/{widgetId}/sessions Cria uma sessão pública do widget de voz. Finalidade: Utiliza esta operação para cria uma sessão pública do widget de voz. Efeitos secundários: Cria uma chamada ou sessão em tempo real; pode consumir minutos ou contactar uma pessoa, por isso confirma a intenção antes de usar.","x-atendia-use-case":"Utiliza esta operação para cria uma sessão pública do widget de voz.","x-atendia-side-effects":"Cria uma chamada ou sessão em tempo real; pode consumir minutos ou contactar uma pessoa, por isso confirma a intenção antes de usar."}},"/public/widgets/{widgetId}/sessions/{sessionId}/end":{"post":{"tags":["Widgets de website"],"summary":"Termina uma sessão pública do widget.","description":"Endpoint selecionado: POST /public/widgets/{widgetId}/sessions/{sessionId}/end.\n\nO que faz: Termina uma sessão pública do widget.\n\nQuando usar: Utiliza esta operação para termina uma sessão pública do widget.\n\nEfeitos secundários e risco: Interrompe trabalho ativo ou agendado; confirma antes de usar.\n\nAutenticação: Lista de origens permitidas + endToken.\n\nParâmetros do caminho: widgetId: string (wgt_ + 24 caracteres); sessionId: string (wgs_ + 24 caracteres).\n\nCorpo do pedido: endToken: string, 20-256 chars.\n\nResposta: 200 { success, message, data: PublicWidgetEndResult }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre POST /public/widgets/{widgetId}/sessions/{sessionId}/end. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: POST /public/widgets/{widgetId}/sessions/{sessionId}/end Termina uma sessão pública do widget. Finalidade: Utiliza esta operação para termina uma sessão pública do widget. Efeitos secundários: Interrompe trabalho ativo ou agendado; confirma antes de usar.\n\nOrigem: apps/server/src/modules/widgets/widget.route.ts.","operationId":"post-public-widgets-by-widgetid-sessions-by-sessionid-end","parameters":[{"name":"widgetId","in":"path","required":true,"description":"widgetId: string (wgt_ + 24 caracteres)","schema":{"type":"string"}},{"name":"sessionId","in":"path","required":true,"description":"sessionId: string (wgs_ + 24 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"endToken":{"type":"string","description":"endToken: string, 20-256 chars"}}}}}},"security":[{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: PublicWidgetEndResult }"}},"x-atendia-source":"apps/server/src/modules/widgets/widget.route.ts","x-atendia-ai-context":"POST /public/widgets/{widgetId}/sessions/{sessionId}/end Termina uma sessão pública do widget. Finalidade: Utiliza esta operação para termina uma sessão pública do widget. Efeitos secundários: Interrompe trabalho ativo ou agendado; confirma antes de usar.","x-atendia-use-case":"Utiliza esta operação para termina uma sessão pública do widget.","x-atendia-side-effects":"Interrompe trabalho ativo ou agendado; confirma antes de usar."}},"/billing/summary":{"get":{"tags":["Faturação"],"summary":"Consulta a carteira: saldo, valores reservados, dívida, cartão guardado e carregamento automático.","description":"Endpoint selecionado: GET /billing/summary.\n\nO que faz: Consulta a carteira: saldo, valores reservados, dívida, cartão guardado e carregamento automático.\n\nQuando usar: Utiliza esta operação para consulta a carteira: saldo, valores reservados, dívida, cartão guardado e carregamento automático.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: billing:read.\n\nResposta: 200 { success, message, data: { billingMode (hosted or self_hosted), currency, paidBalanceMicros, promotionalBalanceMicros, paidAvailableMicros, promotionalAvailableMicros, reservedPaidMicros, reservedPromotionalMicros, debtMicros, availableBalanceMicros, canManage, canManageBilling, paymentMethod (null, { id } or { id, type, brand, last4, expMonth, expYear }), autoRecharge { enabled, thresholdMicros, amountMicros, monthlyCapMicros, capReached (null or { capMicros, resetsAt }) } } }. Amounts are strings in micros (millionths of the currency unit).\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /billing/summary. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /billing/summary Consulta a carteira: saldo, valores reservados, dívida, cartão guardado e carregamento automático. Finalidade: Utiliza esta operação para consulta a carteira: saldo, valores reservados, dívida, cartão guardado e carregamento automático. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/billing/billing.route.ts.","operationId":"get-billing-summary","security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: { billingMode (hosted or self_hosted), currency, paidBalanceMicros, promotionalBalanceMicros, paidAvailableMicros, promotionalAvailableMicros, reservedPaidMicros, reservedPromotionalMicros, debtMicros, availableBalanceMicros, canManage, canManageBilling, paymentMethod (null, { id } or { id, type, brand, last4, expMonth, expYear }), autoRecharge { enabled, thresholdMicros, amountMicros, monthlyCapMicros, capReached (null or { capMicros, resetsAt }) } } }. Amounts are strings in micros (millionths of the currency unit)"}},"x-atendia-source":"apps/server/src/modules/billing/billing.route.ts","x-atendia-permission":"billing:read","x-atendia-ai-context":"GET /billing/summary Consulta a carteira: saldo, valores reservados, dívida, cartão guardado e carregamento automático. Finalidade: Utiliza esta operação para consulta a carteira: saldo, valores reservados, dívida, cartão guardado e carregamento automático. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para consulta a carteira: saldo, valores reservados, dívida, cartão guardado e carregamento automático.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/billing/history":{"get":{"tags":["Faturação"],"summary":"Lista o histórico de faturação que uma pessoa reconhece: uma linha por chamada terminada com custo, mais carregamentos, compras e renovações de números, reembolsos, disputas, crédito promocional e acertos. Do mais recente para o mais antigo.","description":"Endpoint selecionado: GET /billing/history.\n\nO que faz: Lista o histórico de faturação que uma pessoa reconhece: uma linha por chamada terminada com custo, mais carregamentos, compras e renovações de números, reembolsos, disputas, crédito promocional e acertos. Do mais recente para o mais antigo.\n\nQuando usar: Utiliza esta operação para lista o histórico de faturação que uma pessoa reconhece: uma linha por chamada terminada com custo, mais carregamentos, compras e renovações de números, reembolsos, disputas, crédito promocional e acertos. do mais recente para o mais antigo.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: billing:read.\n\nParâmetros de query: limit?: 1-100, default 25; cursor?: the nextCursor of the previous page.\n\nResposta: 200 { success, message, data: [{ id, kind (call, top_up, number_purchase, number_renewal, refund, dispute, promotional_grant or adjustment), at, amountMicros (signed: in > 0, out < 0), currency, receiptUrl (top-ups only, otherwise null), and on call lines callId, durationSeconds, origin (inbound, outbound, widget, preview or null) }], nextCursor (null on the last page) }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /billing/history. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /billing/history Lista o histórico de faturação que uma pessoa reconhece: uma linha por chamada terminada com custo, mais carregamentos, compras e renovações de números, reembolsos, disputas, crédito promocional e acertos. Do mais recente para o mais antigo. Finalidade: Utiliza esta operação para lista o histórico de faturação que uma pessoa reconhece: uma linha por chamada terminada com custo, mais carregamentos, compras e renovações de números, reembolsos, disputas, crédito promocional e acertos. do mais recente para o mais antigo. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/billing/billing.route.ts.","operationId":"get-billing-history","parameters":[{"name":"limit","in":"query","required":false,"description":"limit?: 1-100, default 25","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"cursor?: the nextCursor of the previous page","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: [{ id, kind (call, top_up, number_purchase, number_renewal, refund, dispute, promotional_grant or adjustment), at, amountMicros (signed: in > 0, out < 0), currency, receiptUrl (top-ups only, otherwise null), and on call lines callId, durationSeconds, origin (inbound, outbound, widget, preview or null) }], nextCursor (null on the last page) }"}},"x-atendia-source":"apps/server/src/modules/billing/billing.route.ts","x-atendia-permission":"billing:read","x-atendia-ai-context":"GET /billing/history Lista o histórico de faturação que uma pessoa reconhece: uma linha por chamada terminada com custo, mais carregamentos, compras e renovações de números, reembolsos, disputas, crédito promocional e acertos. Do mais recente para o mais antigo. Finalidade: Utiliza esta operação para lista o histórico de faturação que uma pessoa reconhece: uma linha por chamada terminada com custo, mais carregamentos, compras e renovações de números, reembolsos, disputas, crédito promocional e acertos. do mais recente para o mais antigo. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista o histórico de faturação que uma pessoa reconhece: uma linha por chamada terminada com custo, mais carregamentos, compras e renovações de números, reembolsos, disputas, crédito promocional e acertos. do mais recente para o mais antigo.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}},"/billing/transactions":{"get":{"tags":["Faturação"],"summary":"Lista as linhas do registo da carteira, tal como estão guardadas, da mais recente para a mais antiga.","description":"Endpoint selecionado: GET /billing/transactions.\n\nO que faz: Lista as linhas do registo da carteira, tal como estão guardadas, da mais recente para a mais antiga.\n\nQuando usar: Utiliza esta operação para lista as linhas do registo da carteira, tal como estão guardadas, da mais recente para a mais antiga.\n\nEfeitos secundários e risco: Só de leitura; não deve alterar dados da Atendia.\n\nAutenticação: Sessão ou chave API.\n\nPermissão: billing:read.\n\nParâmetros de query: limit?: 1-100, default 50; cursor?: the nextCursor of the previous page.\n\nResposta: 200 { success, message, data: [{ billingTransactionId, billingAccountId, organizationId, currency, type, idempotencyKey, grossAmountMicros, paidBalanceDeltaMicros, promotionalBalanceDeltaMicros, reservedPaidDeltaMicros, reservedPromotionalDeltaMicros, debtDeltaMicros, paidBalanceAfterMicros, promotionalBalanceAfterMicros, reservedPaidAfterMicros, reservedPromotionalAfterMicros, debtAfterMicros, referenceType, referenceId, description, metadata, createdAt }], nextCursor (null on the last page) }.\n\nOrientação Perguntar à IA: se o utilizador perguntar o que esta API faz enquanto esta operação estiver selecionada, responde apenas sobre GET /billing/transactions. Não resumas todo o catálogo da API da Atendia, salvo pedido explícito.\n\nContexto de IA: GET /billing/transactions Lista as linhas do registo da carteira, tal como estão guardadas, da mais recente para a mais antiga. Finalidade: Utiliza esta operação para lista as linhas do registo da carteira, tal como estão guardadas, da mais recente para a mais antiga. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.\n\nOrigem: apps/server/src/modules/billing/billing.route.ts.","operationId":"get-billing-transactions","parameters":[{"name":"limit","in":"query","required":false,"description":"limit?: 1-100, default 50","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"cursor?: the nextCursor of the previous page","schema":{"type":"string"}}],"security":[{"sessionCookie":[]},{"apiKey":[]}],"responses":{"200":{"description":"{ success, message, data: [{ billingTransactionId, billingAccountId, organizationId, currency, type, idempotencyKey, grossAmountMicros, paidBalanceDeltaMicros, promotionalBalanceDeltaMicros, reservedPaidDeltaMicros, reservedPromotionalDeltaMicros, debtDeltaMicros, paidBalanceAfterMicros, promotionalBalanceAfterMicros, reservedPaidAfterMicros, reservedPromotionalAfterMicros, debtAfterMicros, referenceType, referenceId, description, metadata, createdAt }], nextCursor (null on the last page) }"}},"x-atendia-source":"apps/server/src/modules/billing/billing.route.ts","x-atendia-permission":"billing:read","x-atendia-ai-context":"GET /billing/transactions Lista as linhas do registo da carteira, tal como estão guardadas, da mais recente para a mais antiga. Finalidade: Utiliza esta operação para lista as linhas do registo da carteira, tal como estão guardadas, da mais recente para a mais antiga. Efeitos secundários: Só de leitura; não deve alterar dados da Atendia.","x-atendia-use-case":"Utiliza esta operação para lista as linhas do registo da carteira, tal como estão guardadas, da mais recente para a mais antiga.","x-atendia-side-effects":"Só de leitura; não deve alterar dados da Atendia."}}},"components":{"securitySchemes":{"sessionCookie":{"type":"apiKey","in":"cookie","name":"better-auth.session_token","description":"Cookie de sessão Better Auth da app da consola. Os browsers normalmente só o enviam quando a documentação e a API partilham uma origem compatível."},"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Chave API da Atendia com âmbito de organização. Envia a chave sem alterações no header x-api-key."}}}}