Status codes

A status code will be returned after you perform an API or SDK call to AI Search Open Platform. This code indicates the result of the call. You can locate the details of the call result based on the code and status parameters.

The following table describes the general status codes of AI Search Open Platform.

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 frequency of calls triggers throttling, 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 specific period of time triggers throttling, such as the number of tokens generated per minute.
	429	Throttling.AllocationQuota	Free allocated quota exceeded.	The free quota is exhausted, and billable access of the model is not enabled.
Server error	500	InternalServerError	An internal error has occured, please try again later or contact service support.	An internal error occurs.

Sample response

If a call to AI Search Open Platform fails, a message that contains the details of the error is returned together with an HTTP status code. Sample response:

{
    "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	The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. If the request failed, the corresponding error code and error message are returned for the code and message parameters.
request_id	string	The request ID. To troubleshoot a request failure, you can locate the request based on the value of the request_id parameter.
code	string	The error code returned in case of failure. For more information, see the Error code column of the preceding table.
message	string	The message returned in case of failure. For more information, see the Error message column of the preceding table. Take note that the message may vary based on the actual scenario and may contain more specific information that is different from the preceding table.