Error codes

Every API error follows the same envelope. message carries an uppercase machine code, messageDetail a readable sentence, and the x-request-id header comes with every response: quote it to support.

Codes are grouped by subject, in roughly the order you are likely to meet them.

{
  "status": "error",
  "message": "CREDITS_EXHAUSTED",
  "messageDetail": "Not enough credits."
}

API keys

API_KEY_INVALID · API_KEY_EXPIRED · API_KEY_NOT_FOUND · ADMIN_KEY_REQUIRED · ADMIN_KEY_CANNOT_PREDICT · ALREADY_ROTATED

Web session and tokens

AUTH_REQUIRED · JWT_SESSION_REQUIRED · TOKEN_INVALID · REFRESH_TOKEN_EXPIRED · REFRESH_TOKEN_INVALID · REFRESH_TOKEN_REVOKED · USER_INACTIVE

Sign-in link

MAGIC_LINK_INPUT_MISSING · MAGIC_LINK_INVALID · OTP_INVALID · OTP_TOO_MANY_ATTEMPTS

OAuth sign-in

OAUTH_ALREADY_LINKED · OAUTH_CODE_INVALID · OAUTH_FAILED · OAUTH_LINK_REQUIRED · OAUTH_STATE_INVALID · PROVIDER_MISMATCH · PROVIDER_UNKNOWN · GOOGLE_EMAIL_UNVERIFIED · GOOGLE_PROFILE_INCOMPLETE

Accounts, workspaces and invitations

ACCOUNT_NOT_FOUND · NO_WORKSPACE · WORKSPACE_NOT_FOUND · WORKSPACE_ACCESS_DENIED · INVITATION_INVALID · INVITATION_NOT_FOUND · LINKED_USER_MISSING · CONFIRMATION_MISMATCH

Data and target

DATA_REQUIRED · NO_ROWS · TOO_MANY_ROWS · DATASET_TOO_LARGE · FILE_TOO_LARGE · CSV_UNREADABLE · UPLOAD_INVALID · COLUMN_MISMATCH · SCHEMA_MISMATCH · TARGET_REQUIRED · TARGET_COLUMN_MISSING · TARGET_TASK_FROZEN · TIMESTAMP_COLUMN_MISSING · TIMESTAMP_COLUMN_NOT_FOUND · HORIZON_REQUIRED · INPUT_REQUIRED

Models and engines

MODEL_NOT_FOUND · MODEL_NOT_TRAINED · MODEL_NOT_REFRESHABLE · NO_PENDING_OUTCOMES · REFRESH_IN_PROGRESS · ENGINE_REQUIRED · ENGINE_MISMATCH · UNKNOWN_ENGINE · ENGINE_NO_MODEL · ENGINE_UNAVAILABLE · UNKNOWN_TASK · FORECAST_FAILED · MODEL_ARCHIVED · MODEL_DELETED · ENGINE_NOT_FOUND · ENGINE_PLAN_REQUIRED · ENGINE_CATALOGUE_MISMATCH · ENGINE_ERROR

Credits and billing

CREDITS_EXHAUSTED · CREDITS_NOT_PURCHASABLE · NO_BILLING_ACCOUNT · NO_ACTIVE_SUBSCRIPTION · PLAN_NOT_FOUND · QUOTA_MODELS_EXCEEDED · PURCHASE_NOT_FOUND · REFUND_EXCEEDS_BALANCE · REFUND_EXCEEDS_PURCHASE · STRIPE_ERROR · STRIPE_SIGNATURE_INVALID · LEDGER_WRITE_FAILED

Webhooks

WEBHOOK_NOT_FOUND · WEBHOOK_URL_EXISTS · TOO_MANY_WEBHOOKS

Request shape

VALIDATION_ERROR · VALIDATION_FAILED · INVALID_INPUT · BAD_REQUEST · INVALID_DATE · INVALID_RANGE · RANGE_TOO_WIDE · MALFORMED_PATH · ROUTE_NOT_FOUND · IDEMPOTENCY_KEY_REUSED · IDEMPOTENCY_KEY_TOO_LONG · REQUEST_IN_PROGRESS · TOO_MANY_REQUESTS

Data encryption

MODEL_KEY_MISSING · DATA_KEK_INVALID · DATA_KEK_MISSING · DATA_KEY_MALFORMED · DATA_KEY_MISMATCH · DATA_KEY_NOT_SENT · DATA_KEY_UNREADABLE · DATA_KEY_VERSION_UNKNOWN

Logs and metrics

USAGE_UNAVAILABLE · REQUEST_LOG_UNAVAILABLE · PREDICTION_HISTORY_UNAVAILABLE · PERFORMANCE_UNAVAILABLE · GEOIP_UNAVAILABLE · GEOIP_UNREACHABLE · PRIVATE_IP · GEOIP_LOOKUP_FAILED

Administration

STAFF_ONLY · STAFF_NOT_FOUND · STAFF_ALREADY_EXISTS · STAFF_EMAIL_DOMAIN · STAFF_LOGIN_INVALID · STAFF_SELF_REVOKE · INTERNAL_ONLY · STAFF_LOGIN_REQUIRED

Internal error

INTERNAL_ERROR