Skip to main content
POST
Fork a session

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Path Parameters

session_id
string
required

Session ID

Body

application/json
checkpoint_id
string | null

Checkpoint to fork from (default: take a fresh checkpoint first, which needs the session ready or paused).

count
integer<int32> | null

Children to start, 1..=4 (default 1). Every child needs a free slot under the workspace's concurrent-session cap; a fork that does not fit starts no child.

Required range: x >= 0
budget_usd
number<double> | null

Spend ceiling per child in USD (default: the parent's).

title
string | null

Title for the children (default: the parent's).

Response

The checkpoint used and the children

object
string
required
parent_session_id
string
required
checkpoint_id
string
required

The checkpoint every child started from.

sessions
object[]
required

The children, provisioning until each runtime reports ready; a child whose sandbox failed to start is listed as failed.