Skip to main content
AlphaEngine public errors use problem details.

Typed handling

Clients branch on HTTP status, code, and fieldErrors, not free-form strings.

Traceable failures

requestId stays with the failure so beta users and operators can debug the same event.

​
Error envelope

Errors use: 
content-type: application/problem+json
Base fields:
type, title, status, detail, and instance when useful.
code, family, requestId, and fieldErrors when relevant.

​
Validation failures

Public request bodies are strict in v1 unless a field is explicitly modeled as an open record. Unsupported top-level or nested request fields return 400 with:
Validation failures use code = REQUEST_VALIDATION_FAILED.
Use fieldErrors to point users to invalid or unsupported fields.

​
Client rule

Clients should never parse arbitrary strings for control flow.

Status

Use the HTTP status class for broad handling.

Code

Use code for stable AlphaEngine-specific branching.

Field errors

Use fieldErrors to highlight invalid request fields.

Request id

Keep requestId in client logs and support messages.

​
Common statuses

The request shape, field value, or unsupported property violated the public v1 contract.
The request did not include a usable x-api-key value.
The key exists but is inactive or does not carry the scope required for the route.
The key exceeded its compute-unit budget or in-flight request cap.
Auth resolution or an upstream service could not complete the request.

Authentication

Scopes, compute budget, and rate-limit behavior.

API overview

The implemented public route surface.