# Create a checkpoint

> Create a checkpoint of memory, writable overlay and `/data`, pausing a running computer.

> Nevia is in beta and open to selected teams. Public launch in Dec 2026. The CLI installs with `curl -fsSL https://get.nevia.cloud | sh`, and the MCP server is at https://api.nevia.cloud/mcp. A person signs in once in the browser.
> Setup, sign-in and requesting access: [SKILL.md](https://nevia.cloud/SKILL.md). When Nevia fits and when it doesn't: [why.md](https://nevia.cloud/why.md).

> For the complete documentation index, see [llms.txt](https://nevia.cloud/llms.txt). This page's HTML version: https://nevia.cloud/docs/reference/api/checkpoints/createComputerCheckpoint

`POST https://api.nevia.cloud/v1/computers/{cmp}/checkpoints`

## Authorization

- `bearerAuth`: HTTP bearer in the Authorization header

Send the token in the `Authorization: Bearer <token>` header. See [Authenticate](https://nevia.cloud/docs/reference/api.md#authenticate).

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `cmp` | path | string | yes | Computer id: 27 lowercase letters and digits. Match `^[A-Za-z0-9_-]{1,64}$`. |
| `Idempotency-Key` | header | string | yes | Retry key. A retry with the same key and body replays the first response. Length `1 <= length <= 255`. |

## Request body

Content type: `application/json`

Schema: `CheckpointCreateRequest`

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | no | Label (not unique). Length `1 <= length <= 100`. |
| `consistency` | string | no | Capture mode, computers only. Default `"crash"`. |

## Behavior

A running computer pauses for milliseconds. A sleeping computer stays asleep. The computer is not disturbed otherwise.

Poll the `checkpoint.create` operation, or the checkpoint, until `state` is `ready` or `failed`.

## Example request

### cURL

```bash
curl -X POST "https://api.nevia.cloud/v1/computers/01d4cnjk3xg90y576w8y6t4gdwm/checkpoints" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: 8f1c2a7e-3b4d-4c5e-9f0a-1b2c3d4e5f60" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "before-migration"
  }'
```

### JavaScript

```js
const body = JSON.stringify({
  "name": "before-migration"
})

fetch("https://api.nevia.cloud/v1/computers/01d4cnjk3xg90y576w8y6t4gdwm/checkpoints", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.TOKEN}`,
    "Idempotency-Key": "8f1c2a7e-3b4d-4c5e-9f0a-1b2c3d4e5f60"
  },
  body
})
```

### Python

```python
import os
import requests

url = "https://api.nevia.cloud/v1/computers/01d4cnjk3xg90y576w8y6t4gdwm/checkpoints"
body = """{
  "name": "before-migration"
}"""
response = requests.request("POST", url, data = body, headers = {
  "Content-Type": "application/json", 
  "Authorization": f"Bearer {os.environ['TOKEN']}", 
  "Idempotency-Key": "8f1c2a7e-3b4d-4c5e-9f0a-1b2c3d4e5f60"
})

print(response.text)
```

## Responses

### 201

The checkpoint in `creating`, when the create is accepted, with a `checkpoint.create` operation.

Content type: `application/json`

Schema: `CheckpointResponse`

| Field | Type | Required | Description |
|---|---|---|---|
| `checkpoint` | Checkpoint | yes | Point-in-time capture of a computer. |
| `operations` | array<OperationId> | yes | Operations this request started. |

Example:

```json
{
  "checkpoint": {
    "id": "01d4cnjkwhftngfp8vkmp723mhv",
    "workspace": "01d4cnjjq40hnnh0nwmkg35nv2h",
    "source_type": "computer",
    "source": "01d4cnjk3xg90y576w8y6t4gdwm",
    "name": "before-migration",
    "consistency": "crash",
    "state": "ready",
    "generation": 1,
    "image_digest": "string",
    "size_bytes": 5368709120,
    "parent": null,
    "error": null,
    "created_at": "2026-09-10T12:34:56Z",
    "deleted_at": null
  },
  "operations": [
    "01d4cnjm89yk0r3xtv80dy0x7by"
  ]
}
```

### 400

`validation_failed`: malformed body, unknown field, or invalid id or name. Fix `details.field` and retry. `validation_failed`: `consistency` is neither `crash` nor `fs_frozen`.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `validation_failed: malformed body, unknown field, or invalid id or name. Fix \`details.field\` and retry`:

```json
{
  "error": {
    "code": "validation_failed",
    "message": "Unknown field `colour` in the request body. Remove it; request bodies are strict.",
    "details": {
      "field": "colour",
      "in": "body"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

Example `validation_failed: \`consistency\` is neither \`crash\` nor \`fs_frozen\``:

```json
{
  "error": {
    "code": "validation_failed",
    "message": "Invalid `consistency` in the request body: expected `crash` or `fs_frozen`, got xfs.",
    "details": {
      "field": "consistency",
      "in": "body"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 401

`unauthorized`: the credential is missing, malformed, expired, or revoked. Send a valid bearer token.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `unauthorized`:

```json
{
  "error": {
    "code": "unauthorized",
    "message": "Missing credential. Send `Authorization: Bearer <token>` with an access token.",
    "details": {},
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 403

`forbidden`: the token is read-only or scoped elsewhere, or the role cannot do this. Use a token or role that allows it.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `forbidden`:

```json
{
  "error": {
    "code": "forbidden",
    "message": "You can view computer 01d4cnjk3xg90y576w8y6t4gdwm but your role does not allow computer#edit. Ask a workspace admin to change your role (PATCH /v1/workspaces/{ws}/access/{principal}).",
    "details": {
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "permission": "computer#edit"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 404

`not_found`: the computer does not exist, or you cannot see it. Both return the same response.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `not_found`:

```json
{
  "error": {
    "code": "not_found",
    "message": "Computer 01d4cnjk3xg90y576w8y6t4gdwm was not found. List the computers you can access with GET /v1/computers?workspace=<ws>.",
    "details": {
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 409

`invalid_state`: the computer is not `ready` or `sleeping`. `invalid_state`: a transition is pending on the computer. `invalid_state`: the platform refuses the snapshot in its current state. `invalid_state`: the platform no longer has the computer's machine. `idempotency_conflict`: the `Idempotency-Key` was already used with a different body.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `invalid_state: the computer is not \`ready\` or \`sleeping\``:

```json
{
  "error": {
    "code": "invalid_state",
    "message": "Computer 01d4cnjk3xg90y576w8y6t4gdwm is failed and cannot be checkpointed. Only a ready or sleeping computer can be checkpointed.",
    "details": {
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "workspace": "01d4cnjjq40hnnh0nwmkg35nv2h",
      "state": "failed",
      "pending": null
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

Example `invalid_state: a transition is pending on the computer`:

```json
{
  "error": {
    "code": "invalid_state",
    "message": "Computer 01d4cnjk3xg90y576w8y6t4gdwm is ready with a sleep transition pending. Wait for the pending transition (GET /v1/computers/01d4cnjk3xg90y576w8y6t4gdwm shows `pending: null` once it ends), then retry.",
    "details": {
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "workspace": "01d4cnjjq40hnnh0nwmkg35nv2h",
      "state": "ready",
      "pending": "sleep"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

Example `invalid_state: the platform refuses the snapshot in its current state`:

```json
{
  "error": {
    "code": "invalid_state",
    "message": "Checkpoint 01d4cnjkwhftngfp8vkmp723mhv cannot be checkpointed right now. Check its state with its computer's checkpoints and retry.",
    "details": {
      "checkpoint": "01d4cnjkwhftngfp8vkmp723mhv",
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "workspace": "01d4cnjjq40hnnh0nwmkg35nv2h"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

Example `invalid_state: the platform no longer has the computer's machine`:

```json
{
  "error": {
    "code": "invalid_state",
    "message": "Checkpoint 01d4cnjkwhftngfp8vkmp723mhv is no longer running and cannot be checkpointed. Check its state with GET /v1/checkpoints/01d4cnjkwhftngfp8vkmp723mhv and retry.",
    "details": {
      "checkpoint": "01d4cnjkwhftngfp8vkmp723mhv",
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "workspace": "01d4cnjjq40hnnh0nwmkg35nv2h"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

Example `idempotency_conflict`:

```json
{
  "error": {
    "code": "idempotency_conflict",
    "message": "Idempotency-Key 8f1c2a7e-3b4d-4c5e-9f0a-1b2c3d4e5f60 was already used for a different POST /v1/computers/{cmp}/checkpoints request. Use a new key for a new request.",
    "details": {
      "idempotency_key": "8f1c2a7e-3b4d-4c5e-9f0a-1b2c3d4e5f60"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 422

`not_supported`: `consistency` is `fs_frozen`, which this build does not offer. `not_supported`: the platform does not support the snapshot. `not_supported`: the workspace has no capacity left for the snapshot.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `not_supported: \`consistency\` is \`fs_frozen\`, which this build does not offer`:

```json
{
  "error": {
    "code": "not_supported",
    "message": "`consistency: fs_frozen` needs the guest agent (CLO-283) and is not available in this build. Take a `crash` checkpoint.",
    "details": {
      "field": "consistency",
      "consistency": "fs_frozen"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

Example `not_supported: the platform does not support the snapshot`:

```json
{
  "error": {
    "code": "not_supported",
    "message": "This request is not supported for checkpoint 01d4cnjkwhftngfp8vkmp723mhv. Quote request_id when reporting.",
    "details": {
      "checkpoint": "01d4cnjkwhftngfp8vkmp723mhv",
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "workspace": "01d4cnjjq40hnnh0nwmkg35nv2h"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

Example `not_supported: the workspace has no capacity left for the snapshot`:

```json
{
  "error": {
    "code": "not_supported",
    "message": "Workspace 01d4cnjjq40hnnh0nwmkg35nv2h has no capacity left for checkpoint 01d4cnjkwhftngfp8vkmp723mhv. Quote request_id when reporting.",
    "details": {
      "checkpoint": "01d4cnjkwhftngfp8vkmp723mhv",
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "workspace": "01d4cnjjq40hnnh0nwmkg35nv2h"
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 423

`operation_in_progress`: a conflicting operation runs. Retry after `Retry-After`, or poll `details.operation_id` for completion.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `operation_in_progress`:

```json
{
  "error": {
    "code": "operation_in_progress",
    "message": "Computer 01d4cnjk3xg90y576w8y6t4gdwm has an operation in progress. Poll GET /v1/operations/01d4cnjm89yk0r3xtv80dy0x7by until it finishes, then retry.",
    "details": {
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "operation_id": "01d4cnjm89yk0r3xtv80dy0x7by",
      "retry_after_seconds": 2
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 429

`rate_limited`: slow down. Retry after `Retry-After`.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `rate_limited`:

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after 2 seconds.",
    "details": {
      "retry_after_seconds": 2
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 500

`request_failed`, or the failed action's own code, such as `creation_failed`, `authorization_failed` or `command_execution_failed`. Quote `request_id` when reporting. The diagnostic stays in server logs.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `request_failed`:

```json
{
  "error": {
    "code": "request_failed",
    "message": "request failed",
    "details": {},
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

### 503

`creation_failed`: The action is temporarily unavailable, named by its code (`creation_failed`, `wake_failed`, ...). Wait at least `Retry-After` seconds (60 by default). `details.retryable` says whether repeating the request is safe. Keep the original `Idempotency-Key`. Signing in again does not help. `checkpoint_failed`: the platform is unreachable, or refuses the API, while the snapshot is taken.

Content type: `application/json`

Schema: `ErrorEnvelope`

Body of every error response

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | Error | yes |  |

Example `creation_failed`:

```json
{
  "error": {
    "code": "creation_failed",
    "message": "The computer could not be created. Try again later, and quote request_id if it persists.",
    "details": {
      "retryable": true
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```

Example `checkpoint_failed`:

```json
{
  "error": {
    "code": "checkpoint_failed",
    "message": "Checkpoint 01d4cnjkwhftngfp8vkmp723mhv could not be created.",
    "details": {
      "checkpoint": "01d4cnjkwhftngfp8vkmp723mhv",
      "computer": "01d4cnjk3xg90y576w8y6t4gdwm",
      "workspace": "01d4cnjjq40hnnh0nwmkg35nv2h",
      "retryable": false
    },
    "request_id": "req_01j9k3m2p7q4r8s1"
  }
}
```