Errors
Every error is an RFC 9457 application/problem+json document. Its code names the problem, and each code is sent with exactly one status.
A client branches on code. For a code it does not recognise, it falls
back on the HTTP status, because new codes are added without a version
change.
| Code | Status | Title |
|---|---|---|
invalid_json | 400 | The request body is not valid JSON |
validation_failed | 400 | The request is invalid |
unauthenticated | 401 | Authentication is required |
insufficient_scope | 403 | The API key lacks the required scope |
session_required | 403 | This action requires a signed-in session |
account_not_provisioned | 403 | The account has no workspace |
not_found | 404 | The resource was not found |
no_active_value_model | 404 | The client has no active value model |
method_not_allowed | 405 | The method is not allowed on this path |
idempotency_key_in_use | 409 | A request with this idempotency key is in progress |
client_key_in_use | 409 | The client key is in use |
agent_key_in_use | 409 | The agent key is in use |
client_has_events | 409 | The client has events |
client_has_calculations | 409 | The client has validated or published calculations |
agent_has_events | 409 | The agent has events |
client_key_has_events | 409 | Events reference this client key |
value_model_exists | 409 | The client already has an active value model |
value_model_version_stale | 409 | The value model changed since it was read |
calculation_transition_invalid | 409 | The calculation's state does not allow this action |
calculation_not_draft | 409 | The calculation is not a draft |
calculation_not_published | 409 | The calculation is not published |
report_shared | 409 | The report has been shared |
report_not_shared | 409 | The report has no active link |
api_key_revoked | 409 | The API key is already revoked |
payload_too_large | 413 | The request is too large |
uri_too_long | 414 | The request URI is too long |
unsupported_media_type | 415 | The content type is not supported |
idempotency_key_reused | 422 | The idempotency key was used with a different request |
rate_limited | 429 | Too many requests |
internal_error | 500 | An internal error occurred |
A problem with a single field, parameter or row carries a field-level code instead. Those are listed on Field-level error codes.