Switch the caller's worktree to another branch (or create one)

POST

/api/workspaces/{workspaceId}/apps-v2/{id}/checkout

• Configured API base URL

The same thing git checkout (or git checkout -b with create) in the terminal does, offered as a button — and it goes through the sandbox, so both agree afterwards. Refuses with uncommitted work rather than choosing between carrying it across and discarding it.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

id

required

string

Request Body ^required

object

branch

required

string

>= 1 characters <= 200 characters

create

boolean

Responses

2XX

Successful response

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

Example

Operation completed

error

string

Example

Error message

4XX

Invalid request

object

success

boolean

error

string

Example

Error message

5XX

Internal server error

object

success

boolean

error

string

Example

Error message