Documentação de referência completa para todas as APIs da plataforma Knowledge Base.
Use a referência da API quando souber a operação que deseja implementar e precisar do ponto de acesso, parâmetros, esquemas de solicitação e resposta e informações de status atuais.
Abrir a referência da API
Use a referência do Swagger como a fonte autoritativa para definições de ponto de acesso atuais e detalhes de implementação.
O que você pode encontrar na referência da API
A referência da API fornece detalhes de implementação para operações disponíveis, incluindo:
- Métodos HTTP e caminhos de ponto de acesso.
- Parâmetros de solicitação.
- Esquemas de solicitação e resposta.
- Informações de resposta e status.
As APIs disponíveis abrangem áreas funcionais como:
- Coleções e acesso a coleções.
- Documentos e processamento de documentos.
- Inferência de IA.
- Anexos.
- Tags de documentos.
- Usuários e organizações.
- Feedback.
- Configurações.
- Analytics e relatórios.
- Integrações de bot.
Use Começar com a API da Knowledge Base se precisar de uma introdução ao modelo de recursos da API, ciclo de vida de processamento de documentos, comportamento de inferência ou fluxo típico de solicitação.
Solucionar problemas de solicitações da API
As respostas da API incluem um cabeçalho de resposta X-Request-ID que identifica a solicitação nos serviços da Knowledge Base.
Capture o cabeçalho X-Request-ID ao solucionar uma solicitação com falha ou entrar em contato com o suporte. Além disso, retenha o status HTTP, detalhes da resposta, ponto de acesso e horário aproximado da solicitação.
