Status codes and error messages

Updated

HTTP status codes and error reasons for Conversational AI REST API requests.

Use HTTP status codes together with the reason and detail fields in error responses to troubleshoot failed Conversational AI REST API requests.

HTTP status codes

Status codeDescriptionSuggested action
200OKThe request was successful.
400Invalid request parametersCheck the detail field for specific information.
401Authentication failedCheck the Authorization header, credentials, or token and retry.
403Unauthorized accessResolve account or billing issues, or contact technical support to activate the service.
404Agent not found or has exitedCheck whether the agent started successfully or has already stopped.
409Agent conflictUse the task information returned by the server to continue, or retry with a different agent name.
422Access limit exceededContact technical support to raise your quota.
429Request rate limit exceededRetry using a backoff strategy.
500Internal server errorIf the problem persists, contact technical support.
502Gateway errorContact technical support.
503Agent startup failureRetry using a backoff strategy.
504Request timeoutRetry using a backoff strategy.

Error reasons

ReasonDescription
ServiceNotEnabledThe service is not enabled for the current project.
AccountSuspendedThe account has been suspended and the service is unavailable.
InternalErrorInternal error on the server.
InvalidPermissionThe service is not activated.
InvalidRequestBodyThe request body is not valid JSON.
MissingRequiredFieldA required field is missing from the request.
InvalidFieldValueA request field contains an invalid value.
ResourceQuotaLimitExceededToo many concurrent requests, exceeding the quota limit.
ConcurrencyLimitExceededToo many concurrent requests, exceeding the quota limit.
ServiceUnavailableThe service is temporarily unavailable.
ResourceAllocationFailedThe required resources cannot be allocated at this time.
TaskConflictAn agent with the same name already exists, or a conflicting task is already running.
TaskNotFoundThe task was not started successfully, was aborted after starting, or has been destroyed.
TaskOperationTimeoutInternal error on the server.
NotImplementedInternal error on the server.