API reference
AI Hub API references provide technical details on endpoint usage, requests, and responses.
- Conversations endpoint
Create conversations and query documents.
- Batches endpoint
Manipulate batches for running apps.
- App runs endpoint
Run AI Hub apps and get results.
- Legacy APIs
Legacy APIs are supported but deprecated.
API response statuses
AI Hub v2 API endpoints use HTTP status codes to communicate response statuses. Responses are grouped in the following classes:
| Range | Response class | Notes |
|---|---|---|
| 100-199 | Informational responses | |
| 200-299 | Successful responses | |
| 300-399 | Redirects | |
| 400-499 | Client errors | - A 401 code indicates an authorization error. This can be caused by an invalid API token, an invalid IB-Context header, or by calling an API that requires permissions you don’t have. - A 403 code indicates insufficient consumption units to complete the call. For commercial organizations on a free trial of AI Hub Commercial, a 403 code can indicate that your trial has ended. |
| 500-599 | Server errors |