Claude Platform Docs

Shared

Models
APIErrorObject object{ type: "api_error", message }
type: "api_error"

The broad category of the error.

defaultapi_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultInternal server error
AuthenticationError object{ type: "authentication_error", message }
type: "authentication_error"

The broad category of the error.

defaultauthentication_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultAuthentication error
BillingError object{ type: "billing_error", message }
type: "billing_error"

The broad category of the error.

defaultbilling_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultBilling error
ClaudeCodeKeyCreatorNotMemberErrorDetails object{ error_code }

The API key belongs to the Claude Code workspace, and the user who created it is no longer a member of the organization or of that workspace.

error_code: "claude_code_key_creator_not_member"
ClaudeCodeVersionTooOldErrorDetails object{ error_code }

The request comes from a Claude Code version older than the minimum that the requested model or the organization requires. Update Claude Code, then retry.

error_code: "claude_code_version_too_old"
CMEKContextUnavailableErrorDetails object{ error_code }

The workspace's encryption settings could not be read, so the request was refused. Retry in a few minutes.

error_code: "cmek_context_unavailable"
CMEKKeyDisabledErrorDetails object{ error_code }

The workspace's customer-managed encryption key is disabled or revoked. Re-enable the key, then retry.

error_code: "cmek_key_disabled"
CMEKKeyNetworkBlockedErrorDetails object{ error_code }

The key management service's network access controls blocked the request to the workspace's customer-managed encryption key. The key itself may be healthy.

error_code: "cmek_key_network_blocked"
CMEKKeyUnreachableErrorDetails object{ error_code }

The workspace's customer-managed encryption key could not be reached. Retry the request; if this continues, check that the key is available in your key management service, or contact Anthropic support.

error_code: "cmek_key_unreachable"
EnforcedSpendLimitReachedErrorDetails object{ error_code }

The organization has crossed the monthly API usage threshold of its API tier.

error_code: "enforced_spend_limit_reached"
One of the following:
ErrorResponse object{ type: "error", error, request_id }
type: "error"
defaulterror
One of the following:
request_id: string or null
ErrorType = "invalid_request_error" or "authentication_error" or "billing_error" or 9 more
One of the following:
"invalid_request_error"
"authentication_error"
"billing_error"
"permission_error"
"not_found_error"
"rate_limit_error"
"timeout_error"
"api_error"
"overloaded_error"
"memory_precondition_failed_error"
"memory_path_conflict_error"
"conflict_error"
GatewayTimeoutError object{ type: "timeout_error", message }
type: "timeout_error"

The broad category of the error.

defaulttimeout_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultRequest timeout
InvalidRequestError object{ type: "invalid_request_error", message }
type: "invalid_request_error"

The broad category of the error.

defaultinvalid_request_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultInvalid request
NotFoundError object{ type: "not_found_error", message }
type: "not_found_error"

The broad category of the error.

defaultnot_found_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultNot found
OrganizationOnHoldErrorDetails object{ error_code, appeal_url }

Anthropic has disabled the organization for trust and safety reasons. An organization disabled for any other reason, such as billing, does not get this code. appeal_url, when present, is where the organization can appeal.

error_code: "organization_on_hold"
appeal_url: optional string or null
OrganizationTypeNotSupportedErrorDetails object{ error_code }

The endpoint does not support the organization's type. Each endpoint's description says which organization types it supports.

error_code: "organization_type_not_supported"
OverloadedError object{ type: "overloaded_error", message }
type: "overloaded_error"

The broad category of the error.

defaultoverloaded_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultOverloaded
ParentOrganizationRequiredErrorDetails object{ error_code }

The endpoint serves only organizations that belong to a parent organization, and this organization belongs to none.

error_code: "parent_organization_required"
PermissionError object{ type: "permission_error", message }
type: "permission_error"

The broad category of the error.

defaultpermission_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultPermission denied
RampLimitExceededErrorDetails object{ error_code }

The request would exceed a ramp limit, which caps how fast usage can grow. Retry after the time in the retry-after header.

error_code: "ramp_limit_exceeded"
RateLimitError object{ type: "rate_limit_error", message }
type: "rate_limit_error"

The broad category of the error.

defaultrate_limit_error
message: string

A human-readable explanation of the error. Its wording can change, so don't match on it.

defaultRate limited
RequestBodyEncodingInvalidErrorDetails object{ error_code }

The request body is not valid for its Content-Encoding.

error_code: "request_body_encoding_invalid"
RequestBodyEncodingUnsupportedErrorDetails object{ error_code }

The request's Content-Encoding is not supported.

error_code: "request_body_encoding_unsupported"
RequestBodyTooLargeAfterDecodingErrorDetails object{ error_code }

The compressed request body exceeds the request size limit once decoded.

error_code: "request_body_too_large_after_decoding"
SandboxEgressRestrictedErrorDetails object{ error_code }

The request came from a Claude sandbox with restricted network access, which is not allowed to make this change. Send it from outside the sandbox, or from a sandbox with unrestricted network access.

error_code: "sandbox_egress_restricted"