Documentation Index
Fetch the complete documentation index at: https://docs.nomos.energy/llms.txt
Use this file to discover all available pages before exploring further.
Every error response uses the same JSON envelope, with a status code that follows standard HTTP semantics.
{
"code": "BAD_REQUEST",
"message": "invalid_type in 'customer.email': Required",
"requestId": "37a04f8f-e791-491c-81e1-86cd304649bb",
"docs": "https://docs.nomos.energy/api-references/errors/BAD_REQUEST"
}
| Field | Description |
|---|
code | Machine-readable error code. Switch on this in your handler. |
message | Human-readable description of what went wrong. |
requestId | Unique request identifier. Include it when contacting support. |
docs | Link to the reference page for this code. |
Always log the requestId alongside the request that caused the error. It’s
the fastest way for support to find the corresponding trace.
Retrying
Retry only when retrying could plausibly succeed. Use exponential backoff with jitter and cap the attempts.
| Status | Retry |
|---|
4xx (except 429) | No. Fix the request before retrying. |
429 TOO_MANY_REQUESTS | Yes, after backing off. |
5xx | Yes, with exponential backoff. |
Error reference
| Status | Code | Description |
|---|
400 | BAD_REQUEST | Schema validation failed: missing fields, wrong types, or unparseable
JSON. Check message for the field path. |
401 | UNAUTHORIZED | No credentials, or the access token is invalid or expired. Refresh and
retry. See Authentication. |
403 | FORBIDDEN | Valid token, but the caller doesn’t have permission for this resource.
Confirm the resource belongs to your organization and your Auth Client’s
scope. |
404 | NOT_FOUND | The resource doesn’t exist, or your token can’t see it. Double-check the
ID and your organization. |
405 | METHOD_NOT_ALLOWED | The endpoint doesn’t support the HTTP method you used. |
409 | CONFLICT | Another resource already uses this value (for example, a globally unique
email). Reuse it or change the value before retrying. |
422 | UNPROCESSABLE_ENTITY | Well-formed request that breaks a business rule (for example, cancelling
an already-cancelled subscription). Read message for the
specific rule. |
429 | TOO_MANY_REQUESTS | Rate limit exceeded. Back off and retry with exponential delays. |
500 | INTERNAL_SERVER_ERROR | Unexpected error on Nomos’s side. Retry with backoff. If it persists,
email support@nomos.energy with the
requestId. |
