Skip to main content
POST
Plan a workspace switch

Authorizations

Authorization
string
header
required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Body

application/json
repo
string
required

owner/name of a repository a connected GitHub installation can access.

branch
string
required
create
boolean

Create the branch when it does not exist.

from
string

Base branch for a created branch.

Response

The plan.

read_only
boolean
required
ready
boolean
required
repo
string
required
branch
string
required
create
boolean
required
workspace_identity
string
required
predicted_slug
string
required
action
string
required
reason
string
required
target_branch
object
required
permission_preflight
object
required
pull_requests
object
required
actions
object[] | null
required
existing_computer
object
base_branch
object