> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/agent-sandbox-auto-run-settings/openapi.json](/docs/api/agent-sandbox-auto-run-settings/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Agent sandbox automatic runs

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

Automatic Kenso sandbox runs: Kenso starts an opted-in person's sandbox when the workspace's work for its own agent has waited long enough, one sandbox at a time per workspace, the person whose sandbox ran longest ago first, within the workspace's monthly cap. Each person opts in per workspace; the cap and the wait are the workspace's. Behind the `agent_work` and `agent_sandboxes` features, never open to a Client seat or a scoped API key.

AI. 3 endpoints under `https://api.ken.so`. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`: see [Authentication](/docs/authentication.md), [Workspaces](/docs/workspaces.md) and [Errors](/docs/errors.md). OpenAPI for this resource only: [/docs/api/agent-sandbox-auto-run-settings/openapi.json](/docs/api/agent-sandbox-auto-run-settings/openapi.json).

- `GET /v1/agent-sandbox/auto-run-settings` - Get the automatic run settings (`agent-sandbox-auto-run-settings.get`): [/docs/api/agent-sandbox-auto-run-settings/get.md](/docs/api/agent-sandbox-auto-run-settings/get.md)
- `PATCH /v1/agent-sandbox/auto-run-settings` - Turn your own automatic runs on or off (`agent-sandbox-auto-run-settings.update`): [/docs/api/agent-sandbox-auto-run-settings/update.md](/docs/api/agent-sandbox-auto-run-settings/update.md)
- `PATCH /v1/agent-sandbox/auto-run-settings/workspace` - Set the workspace's monthly cap and wait (`agent-sandbox-auto-run-settings.update-workspace`): [/docs/api/agent-sandbox-auto-run-settings/update-workspace.md](/docs/api/agent-sandbox-auto-run-settings/update-workspace.md)

## Get the automatic run settings

`GET /v1/agent-sandbox/auto-run-settings` - operationId `agent-sandbox-auto-run-settings.get`

| Permission | Rate limit |
| --- | --- |
| Any workspace member except a Network member | 12,000 requests a minute per API key |

Your own switch and agent in this workspace, and the workspace's monthly cap and wait. Nothing saved reads as
`enabled` false, `agent` null, `monthlyCapCredits` 0 (no automatic run starts) and
`waitMinutes` 60.

Errors:

- `404 not_found`: a feature is off, or the credential is not a person's.

Open to any workspace member except a Client seat, and never to an API key held to a permission template.

Needs the `agent_sandboxes` feature on your workspace. Until it is on, calls answer 404. Needs the `agent_work` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/agent-sandbox-auto-run-settings/GET/v1/agent-sandbox/auto-run-settings)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `AgentSandboxAutoRunSettings`.

| Field | Type | Description |
| --- | --- | --- |
| `enabled` | boolean | Whether Kenso may start the caller's sandbox for this workspace. |
| `agent` | string | The agent Kenso starts: claude, codex, antigravity, opencode, grok or cursor. Null until one is picked. |
| `monthlyCapCredits` | integer (int32) | The most the workspace's automatic runs may charge in a calendar month (UTC), in credits. 0: none start. |
| `waitMinutes` | integer (int32) | How long work waits for the workspace's agent before Kenso starts a sandbox, in minutes. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/agent-sandbox/auto-run-settings" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "enabled": true,
    "agent": "string",
    "monthlyCapCredits": 1,
    "waitMinutes": 1
  }
}
```

## Turn your own automatic runs on or off

`PATCH /v1/agent-sandbox/auto-run-settings` - operationId `agent-sandbox-auto-run-settings.update`

| Permission | Rate limit |
| --- | --- |
| Any workspace member except a Network member | 4,800 requests a minute per API key |

Body: `{ "enabled": true, "agent": "codex" }`, either or both. `agent` is `claude`, `codex`,
`antigravity`, `opencode`, `grok` or `cursor`. Turning on, or changing the agent while on, needs
that agent connected in your Kenso sandbox; turning off always succeeds. Automatic runs spend the workspace's
credits within its monthly cap. Returns the settings as the GET does.

Errors:

- `400 validation_failed`: an empty body, an unknown agent, or on with no agent picked.
- `404 not_found`: a feature is off, or the credential is not a person's.
- `409 agent_not_connected`: connect the agent in your Kenso sandbox first.

Open to any workspace member except a Client seat, and never to an API key held to a permission template.

Needs the `agent_sandboxes` feature on your workspace. Until it is on, calls answer 404. Needs the `agent_work` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/agent-sandbox-auto-run-settings/PATCH/v1/agent-sandbox/auto-run-settings)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `enabled` | boolean | no | Turn your automatic runs in this workspace on or off. |
| `agent` | string | no | The agent Kenso starts: claude, codex, antigravity, opencode, grok or cursor. It must be connected to turn on. |

### Response 200

`data` is a `AgentSandboxAutoRunSettings`.

| Field | Type | Description |
| --- | --- | --- |
| `enabled` | boolean | Whether Kenso may start the caller's sandbox for this workspace. |
| `agent` | string | The agent Kenso starts: claude, codex, antigravity, opencode, grok or cursor. Null until one is picked. |
| `monthlyCapCredits` | integer (int32) | The most the workspace's automatic runs may charge in a calendar month (UTC), in credits. 0: none start. |
| `waitMinutes` | integer (int32) | How long work waits for the workspace's agent before Kenso starts a sandbox, in minutes. |

### Request

```bash
curl -X PATCH "https://api.ken.so/v1/agent-sandbox/auto-run-settings" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "agent": "string"
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "enabled": true,
    "agent": "string",
    "monthlyCapCredits": 1,
    "waitMinutes": 1
  }
}
```

## Set the workspace's monthly cap and wait

`PATCH /v1/agent-sandbox/auto-run-settings/workspace` - operationId `agent-sandbox-auto-run-settings.update-workspace`

| Permission | Rate limit |
| --- | --- |
| The `workspace_settings` permission | 4,800 requests a minute per API key |

Body: `{ "monthlyCapCredits": 2000, "waitMinutes": 30 }`, either or both. The cap counts what automatic runs
charged in the calendar month (UTC); a manual run does not count. 0 starts none. The wait is how long work waits
for the workspace's own agent before Kenso starts a sandbox. Returns the settings as the GET does.

Errors:

- `400 validation_failed`: an empty body, `monthlyCapCredits` outside 0 to 100000, or
`waitMinutes` outside 15 to 1440.
- `403 forbidden`: the `workspace_settings` permission is missing.
- `404 not_found`: a feature is off, or the credential is not a person's.

Requires the `workspace_settings` permission. Never open to a Client seat or an API key held to a permission
template.

Needs the `agent_sandboxes` feature on your workspace. Until it is on, calls answer 404. Needs the `agent_work` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/agent-sandbox-auto-run-settings/PATCH/v1/agent-sandbox/auto-run-settings/workspace)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `monthlyCapCredits` | integer (int32) | no | Credits automatic runs may charge in a calendar month (UTC), 0 to 100000. 0: none start. |
| `waitMinutes` | integer (int32) | no | Minutes work waits before Kenso starts a sandbox, 15 to 1440. |

### Response 200

`data` is a `AgentSandboxAutoRunSettings`.

| Field | Type | Description |
| --- | --- | --- |
| `enabled` | boolean | Whether Kenso may start the caller's sandbox for this workspace. |
| `agent` | string | The agent Kenso starts: claude, codex, antigravity, opencode, grok or cursor. Null until one is picked. |
| `monthlyCapCredits` | integer (int32) | The most the workspace's automatic runs may charge in a calendar month (UTC), in credits. 0: none start. |
| `waitMinutes` | integer (int32) | How long work waits for the workspace's agent before Kenso starts a sandbox, in minutes. |

### Request

```bash
curl -X PATCH "https://api.ken.so/v1/agent-sandbox/auto-run-settings/workspace" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "monthlyCapCredits": 1,
  "waitMinutes": 1
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "enabled": true,
    "agent": "string",
    "monthlyCapCredits": 1,
    "waitMinutes": 1
  }
}
```

All resources: [/docs.md](/docs.md).
