Claude Platform Docs

Shared

Models
APIErrorObject object{ message, type }
message: string
defaultInternal server error
type: "api_error"
defaultapi_error
AuthenticationError object{ message, type }
message: string
defaultAuthentication error
type: "authentication_error"
defaultauthentication_error
BillingError object{ message, type }
message: string
defaultBilling error
type: "billing_error"
defaultbilling_error
ErrorObject = InvalidRequestError { message, type } or AuthenticationError { message, type } or BillingError { message, type } or 6 more
One of the following:
ErrorResponse object{ error, request_id, type }
One of the following:
request_id: string or null
type: "error"
defaulterror
ErrorType = "invalid_request_error" or "authentication_error" or "permission_error" or 6 more
One of the following:
"invalid_request_error"
"authentication_error"
"permission_error"
"not_found_error"
"rate_limit_error"
"timeout_error"
"overloaded_error"
"api_error"
"billing_error"
GatewayTimeoutError object{ message, type }
message: string
defaultRequest timeout
type: "timeout_error"
defaulttimeout_error
InvalidRequestError object{ message, type }
message: string
defaultInvalid request
type: "invalid_request_error"
defaultinvalid_request_error
NotFoundError object{ message, type }
message: string
defaultNot found
type: "not_found_error"
defaultnot_found_error
OverloadedError object{ message, type }
message: string
defaultOverloaded
type: "overloaded_error"
defaultoverloaded_error
PermissionError object{ message, type }
message: string
defaultPermission denied
type: "permission_error"
defaultpermission_error
RateLimitError object{ message, type }
message: string
defaultRate limited
type: "rate_limit_error"
defaultrate_limit_error
APIKey object{ id, created_at, created_by, 7 more }
Workspace object{ id, archived_at, compartment_id, 7 more }