Agent sandbox auto run settings
The Agent sandbox auto run settings endpoints of the Kenso API.
Get the automatic run settings
/v1/agent-sandbox/auto-run-settingsagent-sandbox-auto-run-settings.getNeeds 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.
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.
Parameters
YYYY-MM-DD form. 1.1 is another name for the first dated version. 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 date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.400 workspace_required. A workspace you are not a member of answers 404 not_found.Response 200
data is a AgentSandboxAutoRunSettings.
curl -X GET "https://api.ken.so/v1/agent-sandbox/auto-run-settings" \ -H "Authorization: Bearer $KEN_API_KEY" \ -H "Ken-Version: 1.1" \ -H "X-Ken-Workspace-Id: $KEN_WORKSPACE_ID"
{
"success": true,
"data": {
"enabled": true,
"agent": "string",
"monthlyCapCredits": 1,
"waitMinutes": 1
}
}Turn your own automatic runs on or off
/v1/agent-sandbox/auto-run-settingsagent-sandbox-auto-run-settings.updateNeeds 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.
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.
Parameters
YYYY-MM-DD form. 1.1 is another name for the first dated version. 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 date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.400 workspace_required. A workspace you are not a member of answers 404 not_found.Request body
application/json, optional.
Response 200
data is a AgentSandboxAutoRunSettings.
curl -X PATCH "https://api.ken.so/v1/agent-sandbox/auto-run-settings" \
-H "Authorization: Bearer $KEN_API_KEY" \
-H "Ken-Version: 1.1" \
-H "X-Ken-Workspace-Id: $KEN_WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"agent": "string"
}'{
"success": true,
"data": {
"enabled": true,
"agent": "string",
"monthlyCapCredits": 1,
"waitMinutes": 1
}
}Set the workspace's monthly cap and wait
/v1/agent-sandbox/auto-run-settings/workspaceagent-sandbox-auto-run-settings.update-workspaceNeeds 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.
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.
Parameters
YYYY-MM-DD form. 1.1 is another name for the first dated version. 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 date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.400 workspace_required. A workspace you are not a member of answers 404 not_found.Request body
application/json, optional.
Response 200
data is a AgentSandboxAutoRunSettings.
curl -X PATCH "https://api.ken.so/v1/agent-sandbox/auto-run-settings/workspace" \
-H "Authorization: Bearer $KEN_API_KEY" \
-H "Ken-Version: 1.1" \
-H "X-Ken-Workspace-Id: $KEN_WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"monthlyCapCredits": 1,
"waitMinutes": 1
}'{
"success": true,
"data": {
"enabled": true,
"agent": "string",
"monthlyCapCredits": 1,
"waitMinutes": 1
}
}