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

# Check computer health

> Run health checks on a computer without changing anything. Each check says which part works and which does not.

Runs health checks on a computer and says which part works and which does not. It never wakes, resumes or restarts anything. A computer that is not running reports `overall: "stopped"`, and the live checks are skipped.

To act on what it finds, call [Heal a computer](https://docs.orgo.ai/api-reference/computers/heal.md).

## Path parameters

**id** `string` *required*

Computer ID (UUID). An `instance_id` is not accepted here.

## Example

```bash theme={null}
curl https://www.orgo.ai/api/computers/$COMPUTER_ID/health \
  -H "Authorization: Bearer $ORGO_API_KEY"
```

## Response

**computer\_id** `string`

The computer UUID.

**overall** `string`

`healthy` when every check that ran passed, `degraded` when one failed, or `stopped` when the computer is not running.

**checks** `object[]`

One entry per check, each with `check`, `ok` and `detail`. `ok` is `true`, `false`, or `null` when the check did not run. `detail` is a sentence for a person to read.

| `check` | What it tests |
| - | - |
| `status` | The computer is running. |
| `agent` | The Desktop API inside the computer answers. |
| `exec` | A command runs. |
| `display` | The screen gives a real picture. |
| `vnc` | The VNC stream answers. |

```json theme={null}
{
  "computer_id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "overall": "healthy",
  "checks": [
    { "check": "status", "ok": true, "detail": "The computer is running." },
    { "check": "agent", "ok": true, "detail": "…" },
    { "check": "exec", "ok": true, "detail": "…" },
    { "check": "display", "ok": true, "detail": "…" },
    { "check": "vnc", "ok": true, "detail": "…" }
  ]
}
```

## Errors

| Status | Body | When |
| - | - | - |
| `401` | `{ "error": "Invalid API key" }` | The Bearer token starts with `sk_` but is not a known Orgo key. |
| `401` | `{ "error": "Authentication required" }` | No `Authorization` header, or a Bearer token that is not an `sk_` key. |
| `403` | `{ "error": "You do not have access to this workspace." }` | You are not a member of the computer's workspace. |
| `403` | `{ "error": "This API key cannot access this workspace (workspace_scope_mismatch).", "code": "workspace_scope_mismatch" }` | The API key is scoped to a different workspace. |
| `404` | `{ "error": "Computer not found (computer_not_found).", "code": "computer_not_found" }` | No computer matches the id. Signed in with a session instead of a key, the body is `{ "error": "Desktop not found" }`. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.