Status codes and error messages

This page provides additional information you need to configure and troubleshoot Conversational AI Engine RESTful APIs.

When calling the Conversational AI Engine RESTful API, you receive an HTTP status code.

• If the status code is 200, it means the request is successful.

• If the status code is not 200, the request failed. The response body contains detail and reason fields, that describe the specific reason for the failure.

Following is a sample response:

_5

// Status code 400: Request parameters are incorrect

_5

{

_5

"detail": "create agent failed, code: 400, msg: properties: channel not found",

_5

"reason": "InvalidRequest"

_5

}

Response status code	Description	Suggested action
200	OK	The request was successful.
400	Invalid request parameters	Check the detail field for specific information.
403	Unauthorized access	Contact technical support to activate the service.
404	Agent not found or has exited	Check whether the task has been started successfully or has stopped.
409	Agent conflict	Use the already-started agent_id for subsequent update, query, and delete operations.
422	Access limit exceeded	Contact technical support to raise your quota.
502	Gateway error	Contact technical support.
503	Agent startup failure	Retry using a backoff strategy.
504	Request timeout	Retry using a backoff strategy.

The following table shows the possible reason values and descriptions. Use the reason and detail fields to troubleshoot the problem.

reason	Description
InternalError	Internal error on the server.
InvalidPermission	The service is not activated.
InvalidRequest	The request parameters are invalid.
ResourceQuotaLimitExceeded	Too many concurrent requests, exceeding the quota limit.
ServiceUnavailable	Internal error on the server.
TaskConflict	An agent with the same name already exists.
TaskNotFound	The task was not started successfully, was aborted after starting, or has been destroyed.
TaskOperationTimeout	Internal error on the server.
NotImplemented	Internal error on the server.