Error Codes

Response format when a request fails and the error codes of each API

When a request fails, the response carries an HTTP status code and a JSON body in the format below. Error codes differ by API group.

{
  "error_code": "COURSE_NOT_FOUND",
  "message": "Course does not exist.",
  "status_code": 404
}

AI Tutor API

HTTPError CodeDescriptionSolution
400INVALID_COURSE_DATAInvalid course dataCheck request data format
400InvalidFileFormatInvalid file formatCheck supported file formats
400InvalidJsonFormatInvalid JSON formatCheck JSON syntax
400ValidationErrorData validation failedCheck required fields and format
401NotAuthorizedAuthentication failedCheck API key
401InvalidAuthHeaderInvalid auth headerCheck API key format
404COURSE_NOT_FOUNDCourse not foundCheck course_id
404SECTION_NOT_FOUNDSection not foundCheck section_id
404CLIP_NOT_FOUNDClip not foundCheck clip_id
404MATERIAL_NOT_FOUNDMaterial not foundCheck material_id
422InvalidParameterInvalid parameterCheck query/path parameters
500InternalServerErrorInternal server errorContact support

EduAlign OpsAPI

HTTPError CodeDescriptionSolution
400NotExistMemberClient member email does not existCheck the email
400MismatchedPasswordPassword does not matchCheck the password
400NotActivatedClientMemberInactive member or inactive clientContact your Coxwave contact
400SigninFailedTemporary failure while signing inRetry with the same request
400RefreshFailedTemporary failure while refreshing tokensRetry with the same request
400NotExistClientClient does not existCheck the client identifier
400InvalidClientClient of the signed-in account not foundContact your Coxwave contact
401NotAuthorizedBearer token missing, expired, or invalidatedRefresh the token and retry
401InvalidAuthHeader`Authorization` header does not start with `Bearer `Use the `Authorization: Bearer {access_token}` format
401InvalidRefreshTokenRefresh token is invalid or expiredSign in again to get new tokens
403OuterClientScopeForbidden`client_identity` is not under the signed-in client or does not existCheck `client_identity` with List Child Clients
404NotExistSessionSession does not exist or belongs to another clientCheck the session_id
422RequestValidationErrorMalformed query parameterCheck the date format (YYYY-MM-DD) and parameters