<@U04UQ68083H> In case of an API error, what’s the...
# ory-copilotb
brave-memory-91176
03/14/2025, 3:37 PM@chilly-king-10285 In case of an API error, what’s the expected error structure returned by the API? Can we assume it’s always and consistently the same? Which fields of the error object are required and which ones are optional?
b
brief-egg-61061
03/14/2025, 3:37 PMA message from kapa.ai
brief-egg-61061
03/14/2025, 3:37 PMBased on the knowledge sources, I can provide information about the error structure returned by Ory APIs. Ory uses a standard JSON API error format across its services, but there are actually two slightly different error structures depending on which API you're using: ## Kratos API Error Structure For the Ory Kratos API (identities frontend), the error structure includes:
Copy code
json { "error": { "code": 404, "debug": "SQL field \"foo\" is not a bool.", "details": {}, "id": "error_id", "message": "The resource could not be found", "reason": "User with ID 1234 does not exist.", "request": "d7ef54b1-ec15-46e6-bccb-524b82c035e6", "status": "Not Found" } }error.messageerror.codeerror.debugerror.detailserror.iderror.reasonerror.requesterror.status Copy code
json { "error": { "debug": "The database adapter was unable to find the element", "error": "The requested resource could not be found", "error_description": "Object with ID 12345 does not exist", "message": "Error message content", "status_code": 404 } }errorerror.debugerror.errorerror.error_descriptionerror.messageerror.status_codeerrorb
brave-memory-91176
03/14/2025, 3:48 PM@chilly-king-10285 In the TS SDK there is a
GenericErrorGenericErrorContentb
brief-egg-61061
03/14/2025, 3:48 PMA message from kapa.ai
brief-egg-61061
03/14/2025, 3:48 PMBased on the knowledge sources provided, I don't have specific information about the TypeScript SDK's
GenericErrorGenericErrorContent Copy code
{
"error": {
"debug": "...",
"error": "...",
"error_description": "...",
"message": "...",
"status_code": 404
}
} Copy code
{
"code": 404,
"debug": "...",
"details": {},
"id": "...",
"message": "...",
"reason": "...",
"request": "...",
"status": "..."
}GenericErrorGenericErrorContentb
brave-memory-91176
03/14/2025, 3:50 PM@chilly-king-10285 Here are the type declarations:
Copy code
/**
* Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.
* @export
* @interface GenericError
*/
export interface GenericError {
/**
* The status code
* @type {number}
* @memberof GenericError
*/
'code'?: number;
/**
* Debug information This field is often not exposed to protect against leaking sensitive information.
* @type {string}
* @memberof GenericError
*/
'debug'?: string;
/**
* Further error details
* @type {any}
* @memberof GenericError
*/
'details'?: any;
/**
*
* @type {GenericErrorContent}
* @memberof GenericError
*/
'error'?: GenericErrorContent;
/**
* The error ID Useful when trying to identify various errors in application logic.
* @type {string}
* @memberof GenericError
*/
'id'?: string;
/**
* Error message The error\'s message.
* @type {string}
* @memberof GenericError
*/
'message': string;
/**
* A human-readable reason for the error
* @type {string}
* @memberof GenericError
*/
'reason'?: string;
/**
* The request ID The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID.
* @type {string}
* @memberof GenericError
*/
'request'?: string;
/**
* The status description
* @type {string}
* @memberof GenericError
*/
'status'?: string;
}
/**
* Error response
* @export
* @interface GenericErrorContent
*/
export interface GenericErrorContent {
/**
* Debug contains debug information. This is usually not available and has to be enabled.
* @type {string}
* @memberof GenericErrorContent
*/
'debug'?: string;
/**
* Name is the error name.
* @type {string}
* @memberof GenericErrorContent
*/
'error'?: string;
/**
* Description contains further information on the nature of the error.
* @type {string}
* @memberof GenericErrorContent
*/
'error_description'?: string;
/**
* Message contains the error message.
* @type {string}
* @memberof GenericErrorContent
*/
'message'?: string;
/**
* Code represents the error status code (404, 403, 401, ...).
* @type {number}
* @memberof GenericErrorContent
*/
'status_code'?: number;
}b
brief-egg-61061
03/14/2025, 3:50 PMA message from kapa.ai
brief-egg-61061
03/14/2025, 3:50 PMBased on the type declarations you've shared, I can now explain the difference between
GenericErrorGenericErrorContentGenericErrorGenericErrorContentGenericErrorContenterrorGenericErrorGenericErrorerrorGenericErrorContentb
brave-memory-91176
03/14/2025, 3:52 PM@chilly-king-10285 Which error type should I rely on in my application?
b
brief-egg-61061
03/14/2025, 3:52 PMA message from kapa.ai
brief-egg-61061
03/14/2025, 3:52 PMBased on the information in the knowledge sources and our previous discussion about Ory's error structures, I can provide guidance on which error type to rely on in your application. When handling errors from Ory APIs in your application, you should rely on the
GenericErrorGenericErrorGenericErrorerrorGenericErrorContentGenericErrormessage Copy code
typescript try { // API call using Ory SDK } catch (err) { // Cast to GenericError if using TypeScript const error = err as GenericError; // Always available console.log(error.message); // Check for nested error content if (error.error) { console.log(error.error.error_description); } // Other optional fields if (error.reason) { console.log(error.reason); } }