> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ns.rocks/llms.txt
> Use this file to discover all available pages before exploring further.

# API Error Catalog

> Machine-readable error codes from the ErrorResponse schema in specs/openapi.yaml.

Every non-2xx API response carries an `ErrorResponse` body with a
human-readable `error` message and a stable machine-readable `code`
from the catalog below. Responses may also include `error_detail`,
a `request_id` for support correlation, and `build_id` for
template-build failures.

<Note>
  The spec does not yet maintain per-code descriptions, so the
  descriptions below are auto-generated summaries derived from the
  code identifiers. The code list itself is the contract.
</Note>

## Authentication And Accounts

| Code                                   | Description                                                            |
| -------------------------------------- | ---------------------------------------------------------------------- |
| `unauthorized`                         | Unauthorized.                                                          |
| `auth_failed`                          | The auth operation failed.                                             |
| `auth_locked`                          | Auth locked.                                                           |
| `auth_proxy_error`                     | An auth proxy error occurred.                                          |
| `auth_proxy_unavailable`               | The auth proxy is currently unavailable; retry later.                  |
| `invalid_auth_redirect`                | Invalid auth redirect.                                                 |
| `invalid_oauth_provider`               | Invalid oauth provider.                                                |
| `captcha_required`                     | Captcha required.                                                      |
| `captcha_failed`                       | The captcha operation failed.                                          |
| `captcha_unavailable`                  | The captcha is currently unavailable; retry later.                     |
| `disposable_email`                     | Disposable email.                                                      |
| `signup_rate_limited`                  | Too many signup attempts; retry after the rate-limit window.           |
| `oauth_rate_limited`                   | Too many oauth attempts; retry after the rate-limit window.            |
| `email_action_rate_limited`            | Too many email action attempts; retry after the rate-limit window.     |
| `email_not_verified`                   | Email not verified.                                                    |
| `account_deleted`                      | Account deleted.                                                       |
| `operator_required`                    | Operator required.                                                     |
| `account_not_found`                    | The referenced account does not exist or is not visible to the caller. |
| `account_not_soft_deleted`             | Account not soft deleted.                                              |
| `account_hard_delete_active_resources` | Account hard delete active resources.                                  |

## Machines And Scheduling

| Code                       | Description                                                            |
| -------------------------- | ---------------------------------------------------------------------- |
| `machine_not_found`        | The referenced machine does not exist or is not visible to the caller. |
| `machine_not_ready`        | Machine not ready.                                                     |
| `capacity_exceeded`        | The request exceeds the capacity limit.                                |
| `no_eligible_runtime_host` | No eligible runtime host.                                              |
| `same_host_required`       | Same host required.                                                    |
| `transition_in_progress`   | Transition in progress.                                                |
| `transition_conflict`      | The request conflicts with the current transition state.               |

## Snapshots

| Code                    | Description                                                             |
| ----------------------- | ----------------------------------------------------------------------- |
| `snapshot_not_found`    | The referenced snapshot does not exist or is not visible to the caller. |
| `snapshot_in_use`       | Snapshot in use.                                                        |
| `incompatible_snapshot` | Incompatible snapshot.                                                  |
| `rebuild_required`      | Rebuild required.                                                       |

## Templates And Builds

| Code                            | Description                                                                        |
| ------------------------------- | ---------------------------------------------------------------------------------- |
| `template_not_found`            | The referenced template does not exist or is not visible to the caller.            |
| `template_build_not_found`      | The referenced template build does not exist or is not visible to the caller.      |
| `template_name_claim_not_found` | The referenced template name claim does not exist or is not visible to the caller. |
| `build_error`                   | A build error occurred.                                                            |

## Agent Deployments

| Code                                    | Description                                                                             |
| --------------------------------------- | --------------------------------------------------------------------------------------- |
| `agent_deployment_not_found`            | The referenced agent deployment does not exist or is not visible to the caller.         |
| `agent_deployment_version_not_found`    | The referenced agent deployment version does not exist or is not visible to the caller. |
| `agent_run_not_found`                   | The referenced agent run does not exist or is not visible to the caller.                |
| `agent_service_instance_not_found`      | The referenced agent service instance does not exist or is not visible to the caller.   |
| `agent_deployment_name_conflict`        | The request conflicts with the current agent deployment name state.                     |
| `agent_deployment_idempotency_mismatch` | Agent deployment idempotency mismatch.                                                  |
| `agent_deployment_invalid_config`       | Agent deployment invalid config.                                                        |
| `agent_deployment_invalid_state`        | Agent deployment invalid state.                                                         |

## Volumes

| Code                                    | Description                                               |
| --------------------------------------- | --------------------------------------------------------- |
| `volume_beta_restriction`               | Volume beta restriction.                                  |
| `volume_invalid_mount_path`             | Volume invalid mount path.                                |
| `volume_overlapping_mounts`             | Volume overlapping mounts.                                |
| `volume_backend_capability_unsupported` | Volume backend capability unsupported.                    |
| `volume_quota_exceeded`                 | The request exceeds the volume quota limit.               |
| `volume_mount_credential_issue_failed`  | The volume mount credential issue operation failed.       |
| `volume_backend_unavailable`            | The volume backend is currently unavailable; retry later. |
| `volume_stale_revision`                 | Volume stale revision.                                    |
| `volume_busy`                           | Volume busy.                                              |
| `volume_read_only`                      | Volume read only.                                         |
| `volume_limit_exceeded`                 | The request exceeds the volume limit.                     |

## Execution And Files

| Code                | Description                   |
| ------------------- | ----------------------------- |
| `file_upload_error` | A file upload error occurred. |
| `exec_timeout`      | The exec operation timed out. |
| `exec_failed`       | The exec operation failed.    |
| `file_error`        | A file error occurred.        |

## Quotas And Rate Limits

| Code                  | Description                                                          |
| --------------------- | -------------------------------------------------------------------- |
| `QUOTA_EXCEEDED`      | The request exceeds the quota limit.                                 |
| `rate_limit_exceeded` | The request hit a rate limit; respect `Retry-After` before retrying. |

## General

| Code                  | Description                                        |
| --------------------- | -------------------------------------------------- |
| `invalid_request`     | Invalid request.                                   |
| `database_error`      | A database error occurred.                         |
| `not_implemented`     | Not implemented.                                   |
| `feature_unavailable` | The feature is currently unavailable; retry later. |
| `internal_error`      | An internal error occurred.                        |

## Related

* [Error Codes](/error-codes) - CLI exit codes, the CLI JSON error
  envelope, and edge/preview error anchors.
* [REST API Reference](/api-reference) - per-endpoint error responses,
  rendered from the same `specs/openapi.yaml`.
