Every API or SDK call to AI Search Open Platform returns an HTTP status code. Codes in the 2xx range indicate success. Codes in the 4xx range indicate a problem with your request. Codes in the 5xx range indicate a server-side issue.
Use the code and status fields in the response to identify the specific error.
Status code reference
| Category | HTTP status code | Error code | Error message | Description |
|---|---|---|---|---|
| Request error | 400 | InvalidParameter | Required parameter(s) missing or invalid, please check the request parameters. | One or more request parameters are invalid. |
| 400 | ServiceIdNotExist | service_id is not exist. | The service ID does not exist. | |
| 429 | Throttling | Requests throttling triggered. | The API call triggers throttling. | |
| 429 | Throttling.RateQuota | Requests rate limit exceeded, please try again later. | The request rate exceeds the limit, such as the number of requests per second. | |
| 429 | Throttling.AllocationQuota | Allocated quota exceeded, please increase your quota limit. | The number of calls within a period exceeds your allocated quota, such as the number of tokens generated per minute. | |
| 429 | Throttling.AllocationQuota | Free allocated quota exceeded. | Your free quota is exhausted. Enable billable access to continue. | |
| Server error | 500 | InternalServerError | An internal error has occured, please try again later or contact service support. | An internal error occurred. |
Error response
When a request fails, the response includes an HTTP status code and a JSON body with error details. For example:
{
"request_id": "817964CD-1B84-4AE1-9B63-4FB99734DD41",
"latency": 0,
"code": "InvalidParameter",
"message": "JSON parse error: Invalid UTF-8 start byte 0xbc; nested exception is com.fasterxml.jackson.core.JsonParseException: Invalid UTF-8 start byte 0xbc\n at line: 2, column: 19]"
}Response parameters
| Parameter | Type | Description |
|---|---|---|
| HTTP status code | integer | 200 indicates success. Any other code indicates failure. On failure, the code and message parameters contain the error details. |
| request_id | string | The unique ID for this request. Use this value to locate the request when troubleshooting failures. |
| code | string | The error code. See the Error code column in the status code reference table. |
| message | string | The error message. See the Error message column in the status code reference table. The actual message may contain more specific details than shown in the table. |