Errors and tracing

Approved developer operations use a stable safe error envelope.

{
  "error": {
    "code": "example_error",
    "message": "Safe developer-facing message.",
    "status": 400,
    "request_id": "req_...",
    "correlation_id": "cor_...",
    "retryable": false,
    "details": {}
  }
}

Validation errors describe safe public field locations and validation types. They do not echo submitted secret values or expose server internals.

Request and correlation identifiers

Approved responses preserve:

X-Request-Id
X-Correlation-Id

Use the request ID when discussing one HTTP request. Use a correlation ID to group related calls in the same workflow. The official SDK convenience layers expose these values in their detailed response forms.

Unhandled developer-route failures return a safe generic response while internal diagnostics remain on the server side.