Alta API Documentation

When a request fails, the API returns a JSON error object with a machine-readable error type and a human-readable message. See Error handling for a full list of error codes and troubleshooting guidance.

Fields

string

required

Machine-readable error type (e.g. Unauthorized, NotFound, ValidationError, TooManyRequests).

string

required

Human-readable description of what went wrong.

Examples

{
  "error": "Unauthorized",
  "message": "Invalid API token"
}

{
  "error": "NotFound",
  "message": "Resource not found"
}

{
  "error": "ValidationError",
  "message": "Invalid request body"
}

{
  "error": "TooManyRequests",
  "message": "Rate limit exceeded. Please retry after 60 seconds."
}

Getting started

Endpoints

Objects & Definitions

Error

Fields

Examples

​Fields

​Examples

Fields

Examples