Skip to main content
POST
Create a session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
description
string
required
Required string length: 1 - 1000000
agent
string
Required string length: 1 - 500
baseBranch
string | null
Required string length: 1 - 500
mcpServers
string[]
Maximum array length: 100
Required string length: 1 - 500
projectId
string | null
sandboxSize
enum<string>
Available options:
nano,
micro,
small,
medium,
large,
xl,
xxl,
ultra
targetBranch
string | null
Required string length: 1 - 500
visibility
enum<string>
Available options:
private,
public
agentOptions
object
autoDetectRepositories
boolean
branchName
string | null
Required string length: 1 - 500
codeRepositoryIds
string<uuid>[]
Maximum array length: 100
id
string<uuid>
jsonContent
object
pullRequestId
string<uuid>
queueRightAway
boolean
sessionMode
enum<string>
Available options:
chat,
terminal
startupAgent
enum<string>
Available options:
claudeCode,
codex,
opencode,
pi,
amp,
cursor

Response

Create a session

agent
string | null
required
agentId
string<uuid> | null
required
artifactType
enum<string> | null
required
Available options:
PullRequest,
ToolCall,
Plan,
Response,
File,
Service,
Source,
null
baseBranch
string | null
required
branchName
string | null
required
createdAt
string<date-time>
required
externalId
string | null
required
externalUrl
string | null
required
id
string<uuid>
required
kind
string
required
lastQueuedAt
string<date-time> | null
required
lastSeenAt
string<date-time>
required
level
integer
required
mode
enum<string>
default:normal
required
Available options:
normal,
planning
projectId
string | null
required
sandboxSize
enum<string> | null
required
Available options:
nano,
micro,
small,
medium,
large,
xl,
xxl,
ultra,
null
sessionType
enum<string>
default:Chat
required
Available options:
Chat,
Terminal
targetBranch
string | null
required
title
string
required
updatedAt
string<date-time>
required
visibility
enum<string>
default:public
required
Available options:
public,
private
artifacts
object[]
required
description
string | null
required
diffSummary
object | null
required
htmlUrl
string<uri>
required
isPinned
boolean
required
project
object | null
required
sessionSource
object
required
sourcePullRequest
object | null
required
state
object
required