API ReferenceError Codes Dictionary

Error Dictionary

Due to the strict Zero-PII cryptographic mandates, debugging API failures can be complex. We return deterministic, canonical error codes so your middleware can automate retry logic or halt the ingestion pipeline.

HTTP Status Protocols

Marigold adheres to strict HTTP semantic conventions. Before parsing the JSON response body for a canonical error string, your HTTP client should respect the standard transport codes.

4xx Client Errors

The payload you sent is cryptographically invalid, violates JSON schema, or originates from a blocked IP. Do not retry these requests without modifying the payload or configuration.

429 Rate Limits

Your server is dispatching requests faster than your SLA tier allows. Implement exponential backoff and retry after the specified cool-down window.

5xx Server Errors

The algorithmic cluster encountered a math overflow (e.g. Z-Score matrix bounds exceeded). Highly anomalous but transient. Safe to retry with exponential backoff.

Canonical Error Codes

When a request fails, the response body will contain a code and a message field. Use the code for programmatic branching.

Status
Canonical Code
Resolution Guide
400 Bad Request
ERR_AUTH_TAG_MISMATCH

The AES-GCM authentication tag failed verification.

  • Ensure your IV (Nonce) is exactly 12 bytes.
  • Ensure your master key is exactly 32 bytes (256-bit).
  • Ensure you appended the exact 16-byte Auth Tag to the end of the ciphertext before Base64 encoding.
400 Bad Request
ERR_SCHEMA_VALIDATION
The JSON payload does not match the OpenAPI 3.1 specification. Check the details array in the response for the exact missing field (e.g. session_fingerprint is missing).
400 Bad Request
ERR_UNSUPPORTED_MODULE
The anomaly_type string requested does not exist or has been deprecated. Call the /modules/list endpoint to view active modules.
401 Unauthorized
ERR_TOKEN_EXPIRED
The mg_live_ Bearer token has exceeded its 30-day lifecycle limit. Trigger your rotation cron job to fetch a new token via the /tokens/rotate endpoint using your administrative credential.
403 Forbidden
ERR_IP_RESTRICTED
Your server's egress IP address is not on the institutional Network ACL whitelist. Contact the architecture desk immediately. Do not automate retries for this error.
429 Too Many Requests
ERR_RATE_LIMIT_EXCEEDED
You have exceeded the API calls per minute threshold for your SLA tier. Parse the Retry-After HTTP header (returns seconds) and implement a sleep/backoff loop before transmitting the next chunk.
500 Server Error
ERR_Z_SCORE_OVERFLOW
The standard deviation mathematical matrix calculation resulted in a 64-bit float overflow. This almost exclusively occurs when you fail to partition your payload. Ensure you are sending no more than 10,000 records per API call.