Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Error response

All errors return a flat JSON object with every field always present:
​
category
string
required
Broad error classification. One of: api_error, authentication_error, idempotency_error, invalid_request_error, rate_limit_error.
​
code
string
required
Machine-readable error code for programmatic handling. Use this to branch on specific error conditions. Never parse the message field.
​
message
string
required
Human-readable description of the error. Not a stable contract. Do not parse or branch on message content.
​
param
string | null
required
The request parameter that caused the error, or null if not parameter-specific.
​
doc_url
string
required
Link to documentation explaining the error.
​
correlation_id
string
required
Unique request identifier for tracing and support. Also returned as a Correlation-Id response header on all responses.

​
Categories

CategoryMeaning
api_errorServer-side failure. You did nothing wrong. Retry may help.
authentication_errorMissing or invalid API key.
idempotency_errorIdempotency key conflict (reuse with different params).
invalid_request_errorClient-side problem: bad parameters, not found, state conflict.
rate_limit_errorToo many requests. Back off and retry.

​
Error codes

​
Structural codes

CodeCategoryHTTPWhen
parameter_invalidinvalid_request_error400Request parameter fails validation
parameter_missinginvalid_request_error400Required parameter not provided
validation_errorinvalid_request_error400Request body fails schema validation
api_version_errorinvalid_request_error400Unknown or unsupported api-version header value
invalid_cursorinvalid_request_error400Pagination cursor is malformed or could not be read
cursor_mismatchinvalid_request_error400Pagination cursor was issued for different filters
authentication_requiredauthentication_error401Missing or invalid API key
permission_deniedinvalid_request_error403Valid key, but the request is forbidden by a non-scope check (feature flag, enabled surface, beneficiary allowlist)
insufficient_scopeinvalid_request_error403Valid key, but missing one or more scopes the endpoint requires. Carries an additional required_scopes array
resource_not_foundinvalid_request_error404Resource does not exist
method_not_allowedinvalid_request_error405HTTP method not supported on this endpoint
conflictinvalid_request_error409Business state conflict
idempotency_key_already_usedidempotency_error409Key reuse with different parameters
request_in_progressidempotency_error409Concurrent request with same key
payload_too_largeinvalid_request_error413Request body exceeds the maximum size
rate_limit_exceededrate_limit_error429Too many requests
internal_errorapi_error500Unexpected server failure
upstream_errorapi_error500A required upstream service returned an error

​
Domain codes

These codes refine invalid_request_error for specific resources. They allow finer-grained handling than the generic parameter_invalid or validation_error.
CodeHTTPWhen
payout_validation_failed400Payout request fails business validation
conversion_validation_failed400Conversion request fails business validation
quote_validation_failed400Quote request fails business validation
invalid_currency400Currency is not supported for the requested action

​
Examples

{
  "category": "invalid_request_error",
  "code": "parameter_missing",
  "message": "The amount parameter is required.",
  "param": "amount",
  "doc_url": "https://docs.augustus.com/v1/errors",
  "correlation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}