# Lotaí

> Documentação e página de ajuda técnica da Lotaí.

## Docs

- [Integrações de API](https://docs.lotai.com.br/agent-builder/api-integrations.md): Utilize integrações de API para expandir as funcionalidades do seu agente com seus sistemas externos de forma facilitada.
- [Uso de Áudios](https://docs.lotai.com.br/agent-builder/audio.md): Descubra como configurar o uso de Envio e Escuta de áudio no seu agente Converza.
- [Gerar Token de Acesso](https://docs.lotai.com.br/api-reference/autenticação/gerar-token-de-acesso.md): Gera um token de acesso JWT a partir das credenciais da chave API. O token é válido por 24 horas.
- [Autenticação](https://docs.lotai.com.br/api-reference/authentication.md): Saiba como obter e autenticar a API da Lotaí.
- [Atualizar Bot](https://docs.lotai.com.br/api-reference/bots/atualizar-bot.md): Atualiza a configuração do bot. Todos os campos são opcionais. O bot será marcado como não publicado e requer publicação para aplicar as alterações no OpenAI.
- [Criar Bot](https://docs.lotai.com.br/api-reference/bots/criar-bot.md): Cria um novo bot com instruções, perguntas/respostas e configuração. Cria automaticamente o assistente OpenAI e o vector store se documentos forem fornecidos.
- [Deletar Bot](https://docs.lotai.com.br/api-reference/bots/deletar-bot.md): Deleta permanentemente um bot. Isso remove o bot do banco de dados, OpenAI e todos os relacionamentos de documentos. Não é possível deletar bots vinculados a dispositivos.
- [Listar Bots](https://docs.lotai.com.br/api-reference/bots/listar-bots.md): Lista todos os bots com filtragem opcional por equipe e nome. Suporta paginação.
- [Obter Bot](https://docs.lotai.com.br/api-reference/bots/obter-bot.md): Obtém informações detalhadas sobre um bot específico incluindo configuração, documentos e status
- [Publicar Bot](https://docs.lotai.com.br/api-reference/bots/publicar-bot.md): Publica as alterações do bot no OpenAI. Isso atualiza a configuração do assistente, ferramentas, instruções e marca o bot como publicado. Também atualiza o cache para todos os dispositivos conectados.
- [Criar Chave API](https://docs.lotai.com.br/api-reference/chaves-api/criar-chave-api.md): Cria uma nova chave API. O segredo é mostrado apenas uma vez - salve-o com segurança!
- [Deletar Chave API](https://docs.lotai.com.br/api-reference/chaves-api/deletar-chave-api.md): Deleta permanentemente uma chave API. Você não pode deletar a chave que está sendo usada para autenticação.
- [Listar Chaves API](https://docs.lotai.com.br/api-reference/chaves-api/listar-chaves-api.md): Lista todas as chaves API. Os segredos nunca são retornados nas respostas.
- [Obter Chave API](https://docs.lotai.com.br/api-reference/chaves-api/obter-chave-api.md): Obtém detalhes de uma chave API específica por ID
- [Conectar Dispositivo](https://docs.lotai.com.br/api-reference/dispositivos/conectar-dispositivo.md): Inicia/conecta um dispositivo. Isso inicia a conexão WhatsApp e gera um código QR. Após chamar isso, use o endpoint 'Obter Status do Dispositivo' para recuperar o código QR.
- [Criar Dispositivo](https://docs.lotai.com.br/api-reference/dispositivos/criar-dispositivo.md): Cria um novo dispositivo (instância WhatsApp) para uma equipe. O dispositivo será criado no estado parado e precisa ser conectado para começar a receber mensagens.
- [Deletar Dispositivo](https://docs.lotai.com.br/api-reference/dispositivos/deletar-dispositivo.md): Deleta permanentemente um dispositivo. O dispositivo deve estar parado antes da exclusão. Isso remove o dispositivo do banco de dados, provedor e libera a cota do pool.
- [Desconectar Dispositivo](https://docs.lotai.com.br/api-reference/dispositivos/desconectar-dispositivo.md): Para/desconecta um dispositivo. Isso para a instância WhatsApp e a desconecta da plataforma.
- [Enviar Mensagem Ativa](https://docs.lotai.com.br/api-reference/dispositivos/enviar-mensagem-ativa.md): Envia uma mensagem para um número de WhatsApp através de um dispositivo conectado. O dispositivo deve estar iniciado e conectado para enviar mensagens.
- [Listar Dispositivos](https://docs.lotai.com.br/api-reference/dispositivos/listar-dispositivos.md): Lista todos os dispositivos (instâncias WhatsApp) com filtragem opcional por equipe, nome, status e estado de conexão. Suporta paginação.
- [Obter Dispositivo](https://docs.lotai.com.br/api-reference/dispositivos/obter-dispositivo.md): Obtém informações detalhadas sobre um dispositivo específico incluindo sua configuração, status e estado de conexão
- [Obter Status do Dispositivo](https://docs.lotai.com.br/api-reference/dispositivos/obter-status-do-dispositivo.md): Obtém o status de conexão atual e detalhes. Retorna o código QR se o dispositivo não estiver conectado (como imagem PNG em base64), ou o número de telefone se conectado. Use isso para monitorar o estado de conexão e recuperar códigos QR.
- [Atualizar Documento](https://docs.lotai.com.br/api-reference/documentos/atualizar-documento.md): Atualiza o nome do documento. O arquivo em si não pode ser alterado.
- [Deletar Documento](https://docs.lotai.com.br/api-reference/documentos/deletar-documento.md): Deleta permanentemente um documento. Isso remove o arquivo do armazenamento e o registro do banco de dados.
- [Fazer Upload de Documento](https://docs.lotai.com.br/api-reference/documentos/fazer-upload-de-documento.md): Faz upload de um novo documento para uma equipe específica
- [Listar Documentos](https://docs.lotai.com.br/api-reference/documentos/listar-documentos.md): Lista todos os documentos de todas as equipes com paginação e filtros opcionais
- [Obter Documento](https://docs.lotai.com.br/api-reference/documentos/obter-documento.md): Obtém detalhes de um documento específico por ID
- [Atualizar Equipe](https://docs.lotai.com.br/api-reference/equipes/atualizar-equipe.md): Atualiza detalhes da equipe. Todos os campos são opcionais - forneça apenas os campos que deseja alterar.
- [Criar Equipe](https://docs.lotai.com.br/api-reference/equipes/criar-equipe.md): Cria uma nova equipe com um usuário administrador. A operação é atômica - se qualquer etapa falhar, nada é criado.
- [Deletar Equipe](https://docs.lotai.com.br/api-reference/equipes/deletar-equipe.md): Deleta permanentemente uma equipe. Isso cascateia para todos os dados relacionados (bots, dispositivos, documentos, etc.)
- [Listar Equipes](https://docs.lotai.com.br/api-reference/equipes/listar-equipes.md): Lista todas as equipes com paginação e filtros opcionais
- [Obter Equipe](https://docs.lotai.com.br/api-reference/equipes/obter-equipe.md): Obtém detalhes de uma equipe específica por ID
- [Boas-Vindas a Lotaí](https://docs.lotai.com.br/welcome.md): Comece a usar a Lotaí e descubra como criar agentes inteligentes treinados com os dados do seu negócio, com suas integrações e com suas instruções para criar um fluxo de atendimento automático e lotar sua agenda!

## OpenAPI Specs

- [openapi](https://docs.lotai.com.br/api-reference/openapi.yaml)