Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
agents
40
automations
6
browser
2
conversations
65
cues
6
dev
1
events
1
fs
1
github
4
identity
3
import
4
link-preview
1
mobile
13
notifications
6
projects
15
prs
2
push
3
reports
2
reviews
10
sessions
75
get
/api/v1/desktop/sessions/{sessionId}/artifacts
Resolve a session artifact directory for the loopback desktop supervisor
get
/api/v1/desktop/sessions/{sessionId}/workspace
Resolve a session workspace for the loopback desktop supervisor
get
/api/v1/orchestrators
List orchestrator sessions across projects
post
/api/v1/orchestrators
Spawn an orchestrator session
get
/api/v1/orchestrators/{id}
Fetch one orchestrator session
post
/api/v1/orchestrators/delegate
Start a worker task and refine its title in the background
get
/api/v1/sessions
List sessions
post
/api/v1/sessions
Spawn a new agent session
get
/api/v1/sessions/{sessionId}
Fetch one session
patch
/api/v1/sessions/{sessionId}
Rename a session display name
post
/api/v1/sessions/{sessionId}/activity
Report an agent activity-state signal for a session
post
/api/v1/sessions/{sessionId}/activity/codewhale
Record a Codewhale lifecycle outbox event
get
/api/v1/sessions/{sessionId}/agent-browser/*
Proxy the host's agent browser stream viewer (page, stream socket, downloads)
post
/api/v1/sessions/{sessionId}/agent-browser/*
Upload a file into the host's agent browser
head
/api/v1/sessions/{sessionId}/agent-browser/*
Read headers from the host's agent browser stream viewer
put
/api/v1/sessions/{sessionId}/artifact-files
Replace the text content of one file in a session's artifact directory
delete
/api/v1/sessions/{sessionId}/artifact-files
Delete one file from a session's artifact directory and return the session with its refreshed artifact list
get
/api/v1/sessions/{sessionId}/artifact-files/*
Serve a session artifact file sandboxed, an HTML page with the render theme bootstrap
get
/api/v1/sessions/{sessionId}/artifact-versions
List the saved versions of one file in a session's artifact directory
get
/api/v1/sessions/{sessionId}/artifact-versions/{version}
Read one saved version of an artifact file
post
/api/v1/sessions/{sessionId}/artifact-versions/restore
Restore an artifact file to an earlier saved version
post
/api/v1/sessions/{sessionId}/artifact-versions/sync
Record an artifact file's unrecorded edit, then list its saved versions
post
/api/v1/sessions/{sessionId}/attachments
Write images into a running session's worktree and return their paths
patch
/api/v1/sessions/{sessionId}/auto-inject-ci
Set automatic CI-failure injection for a session and its PRs
patch
/api/v1/sessions/{sessionId}/auto-inject-review
Set the auto-inject review setting for a session
put
/api/v1/sessions/{sessionId}/auto-review
Enable or disable automatic review for a session
post
/api/v1/sessions/{sessionId}/exit-agent
Exit the agent while preserving its AO session
get
/api/v1/sessions/{sessionId}/interface-transition
Inspect TUI and Chat interface handoff support and progress
post
/api/v1/sessions/{sessionId}/interface-transition
Switch a live session between its TUI and Chat controllers
delete
/api/v1/sessions/{sessionId}/interface-transition
Cancel an interface handoff before its source controller stops
put
/api/v1/sessions/{sessionId}/interface-transition/{transitionId}/notice-acknowledgement
Acknowledge a failed or recovered interface handoff notice
post
/api/v1/sessions/{sessionId}/kill
Mark a session terminated and tear down runtime/workspace resources
patch
/api/v1/sessions/{sessionId}/merge-policy
Configure whether PR completion terminates the session
post
/api/v1/sessions/{sessionId}/pin
Pin a session
delete
/api/v1/sessions/{sessionId}/pin
Unpin a session
get
/api/v1/sessions/{sessionId}/pr
List pull requests owned by a session
get
/api/v1/sessions/{sessionId}/pr/{prNumber}/file
Read one file from an associated pull request base-to-head diff
get
/api/v1/sessions/{sessionId}/pr/{prNumber}/file/revision
Read one text-capable side of a pull request comparison
get
/api/v1/sessions/{sessionId}/pr/{prNumber}/files
List the exact base-to-head changed files for an associated pull request
post
/api/v1/sessions/{sessionId}/pr/claim
Claim an existing pull request for a session
get
/api/v1/sessions/{sessionId}/preview
Discover a browser preview URL for a session workspace
post
/api/v1/sessions/{sessionId}/preview
Set (or autodetect) the browser preview URL for a session
delete
/api/v1/sessions/{sessionId}/preview
Clear the browser preview URL for a session
get
/api/v1/sessions/{sessionId}/preview/app/*
Proxy the running session-owned application preview
put
/api/v1/sessions/{sessionId}/preview/app/*
Send a request to the running session-owned application preview
post
/api/v1/sessions/{sessionId}/preview/app/*
Send a request to the running session-owned application preview
delete
/api/v1/sessions/{sessionId}/preview/app/*
Send a request to the running session-owned application preview
head
/api/v1/sessions/{sessionId}/preview/app/*
Read headers from the running session-owned application preview
patch
/api/v1/sessions/{sessionId}/preview/app/*
Send a request to the running session-owned application preview
get
/api/v1/sessions/{sessionId}/preview/artifacts/*
Serve a selected static browser preview file from the session artifact directory
get
/api/v1/sessions/{sessionId}/preview/files/*
Serve a static browser preview file from a session workspace or artifact directory
get
/api/v1/sessions/{sessionId}/preview/server
Get the managed preview server status for a session
post
/api/v1/sessions/{sessionId}/preview/server
Start a session-owned server from .ao/launch.json and open its application preview
delete
/api/v1/sessions/{sessionId}/preview/server
Stop the managed preview server for a session
post
/api/v1/sessions/{sessionId}/restore
Restore a terminated session
post
/api/v1/sessions/{sessionId}/resume-agent
Resume an exited agent in its existing session
put
/api/v1/sessions/{sessionId}/reviewer
Set the reviewer harness for a session
post
/api/v1/sessions/{sessionId}/rollback
Undo a partially-completed spawn (delete seed row, or kill if spawn output exists)
post
/api/v1/sessions/{sessionId}/send
Send a message to a running session's agent
get
/api/v1/sessions/{sessionId}/workspace/branches
List the local branches and pull requests a workspace review can read, checked-out branch first
post
/api/v1/sessions/{sessionId}/workspace/diffs
Read grouped unified patches for a bounded set of workspace files
get
/api/v1/sessions/{sessionId}/workspace/events
Stream session workspace file changes
get
/api/v1/sessions/{sessionId}/workspace/file
Read one session workspace file and its git diff
put
/api/v1/sessions/{sessionId}/workspace/file
Replace one existing text file in a session workspace
get
/api/v1/sessions/{sessionId}/workspace/file/blob
Read one side of a session workspace image file
get
/api/v1/sessions/{sessionId}/workspace/file/revision
Read one text-capable side of a workspace comparison
get
/api/v1/sessions/{sessionId}/workspace/files
List files in a session workspace with git change status
get
/api/v1/sessions/{sessionId}/workspace/history
Get lazy commit and upstream metadata for a workspace review
post
/api/v1/sessions/{sessionId}/workspace/history/selection
Resolve ticked commits, or a view's whole range, to their combined changed files
get
/api/v1/sessions/{sessionId}/workspace/manifest
Get the compact changed-file manifest for the initial workspace review paint
get
/api/v1/sessions/{sessionId}/workspace/resolve
Classify a path as a workspace file, a session artifact, or neither
get
/api/v1/sessions/{sessionId}/workspace/search
Search visible workspace file paths
get
/api/v1/sessions/{sessionId}/workspace/search/content
Search the contents of visible workspace files
get
/api/v1/sessions/{sessionId}/workspace/tree
List one directory level of a session workspace's full file tree, git-status decorated
post
/api/v1/sessions/cleanup
Clean up terminated session workspaces
settings
20
shellTerminals
4
system
5
usage
4
sessions
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Generate code
Spawn a new agent session
post
/api/v1/sessions
Request
Base URL
http://127.0.0.1:3001
URL
http://127.0.0.1:3001/api/v1/sessions
Auth
none declared
Request body
Spawn
Session
Request
required
approvalMode
'default'
|
'accept-edits'
|
'auto'
|
'bypass-permissions'
attachments
Attachment
Input[]
branch
string
clientRequestId
string
displayName
string
effort
string
harness
'claude-code'
|
'codex'
|
'aider'
|
'opencode'
|
'opencode-v2'
|
'grok'
|
'droid'
|
'amp'
|
'agy'
|
'crush'
|
'cursor'
|
'qwen'
|
'gemini'
|
'copilot'
|
'goose'
|
'auggie'
|
'continue'
|
'devin'
|
'cline'
|
'kimi'
|
'muse'
|
'kiro'
|
'kilocode'
|
'vibe'
|
'pi'
|
'kimchi'
|
'omp'
|
'fx'
|
'prime-agent'
|
'autohand'
|
'unreal-agent'
|
'codewhale'
|
'mimo-code'
|
'deepseek-harness'
|
'openhands'
|
'command-code'
|
'memcode'
|
'hermes'
issueId
string
kind
'worker'
|
'orchestrator'
mode
'chat'
|
'tui'
model
string
parentSessionId
string
projectId
string
prompt
string
requestedOutput
'artifact'
trackerProvider
'github'
|
'gitlab'
Response
201
Created
Created
Spawn
Session
Response
required
promptBytes
integer
required
session
Controllers
Session
View
required
systemPromptBytes
integer
required
Changes