Complete reference documentation for all Knowledge Base platform APIs.
Use the API reference when you know the operation you want to implement and need the current endpoint, parameters, request and response schemas, and status information.
Open the API reference
Use the Swagger reference as the authoritative source for current endpoint definitions and implementation details.
What you can find in the API reference
The API reference provides implementation details for available operations, including:
- HTTP methods and endpoint paths.
- Request parameters.
- Request and response schemas.
- Response and status information.
Available APIs cover functional areas such as:
- Collections and collection access.
- Documents and document processing.
- AI inference.
- Attachments.
- Document tags.
- Users and organizations.
- Feedback.
- Settings.
- Analytics and reporting.
- Bot integrations.
Use Get started with the Knowledge Base API if you need an introduction to the API resource model, document-processing lifecycle, inference behavior, or typical request flow.
Troubleshoot API requests
API responses include an X-Request-ID response header that identifies the request across Knowledge Base services.
Capture the X-Request-ID when troubleshooting a failed request or contacting Support. Also, retain the HTTP status, response details, endpoint, and approximate time of the request.
