client API reference
Generated from OpenAPI by
go -C cli generate ./internal/daemon. Audience grouping does not grant or
restrict access.
On this page: getAuth, patchAccount, deleteAccount, putKeyAccount, getLogin, createLogin, answerLogin, cancelLogin, getEvents, listHosts, probeHost, listModels, getServer, shutdownServer, listSessions, getSession, createSession, deleteSession, attachACPSession, releaseACPSession, renewACPSession, getActiveOutputContent, getCatalog, getSessionChanges, getCompaction, putCompaction, getSessionConfiguration, patchSession, getContext, getContextWindow, getContextSection, watchSession, getFastMode, patchFastMode, getSessionFile, getHistory, getHistoryContentBatch, getHistoryContent, getHistoryImage, getInput, putInput, cancelInput, editInput, holdInput, releaseInput, interruptSession, restartKernel, upgradeKernel, moveSessionToDaemon, reloadSession, getSessionRequests, rewindSession, getShellCommand, putShellCommand, getShellCommandOutput, stopShellCommand, putSideQuestion, patchSideQuestion, cancelSideQuestion, getSessionStatus, generateSessionTitle, recordVisit, moveSessionWorkspace, getSettings, getCapabilitySettings, patchCapabilitySettings, getDeclaredSettings, patchDeclaredSettings, getExtensionSettings, patchExtensionSettings, getMCPSettings, patchMCPSettings, getModelSettings, patchModelSettings, getProviderSettings, patchProviderSettings, getUISettings, patchUISettings, getStorage, attachTerminal, closeTerminal, getUsage, and getWorkspaces.
See API workflows for conditional edits and recovery.
getAuth
GET /auth
Recovery: safe-read.
patchAccount
PATCH /auth/accounts/{account_id}
Recovery: refresh-before-edit.
deleteAccount
DELETE /auth/accounts/{account_id}
Recovery: no-automatic-replay.
putKeyAccount
PUT /auth/keys/{account_id}
Recovery: no-automatic-replay.
getLogin
GET /auth/logins/{login_id}
Recovery: safe-read.
createLogin
PUT /auth/logins/{login_id}
Recovery: no-automatic-replay.
answerLogin
PATCH /auth/logins/{login_id}
Recovery: refresh-before-edit.
cancelLogin
DELETE /auth/logins/{login_id}
Recovery: no-automatic-replay.
getEvents
GET /events
Recovery: safe-read.
listHosts
GET /hosts
Recovery: safe-read.
probeHost
POST /hosts/{host}/probe
Recovery: no-automatic-replay.
listModels
GET /models
Recovery: safe-read.
getServer
GET /server
Recovery: safe-read.
shutdownServer
POST /server/shutdown
Recovery: no-automatic-replay.
listSessions
GET /sessions
Recovery: safe-read.
getSession
GET /sessions/{session_id}
Recovery: safe-read.
createSession
PUT /sessions/{session_id}
Recovery: repeat-identical-intent.
deleteSession
DELETE /sessions/{session_id}
Recovery: no-automatic-replay.
attachACPSession
PUT /sessions/{session_id}/acp-attachment
Recovery: no-automatic-replay.
releaseACPSession
DELETE /sessions/{session_id}/acp-attachment
Recovery: no-automatic-replay.
renewACPSession
POST /sessions/{session_id}/acp-attachment/renew
Recovery: no-automatic-replay.
getActiveOutputContent
GET /sessions/{session_id}/active-output/{content_id}
Recovery: safe-read.
getCatalog
GET /sessions/{session_id}/catalog
Recovery: safe-read.
getSessionChanges
GET /sessions/{session_id}/changes
Recovery: safe-read.
getCompaction
GET /sessions/{session_id}/compactions/{action_id}
Recovery: safe-read.
Documented HTTP problem codes:
invalid_requestacp_ownedattachment_lostidentity_expiredidentity_invalidcompaction_unknownrequest_unavailable
putCompaction
PUT /sessions/{session_id}/compactions/{action_id}
Recovery: repeat-identical-intent.
Documented HTTP problem codes:
invalid_requestacp_ownedattachment_lostidentity_invalidid_conflictidentity_expiredsession_busysession_not_foundrequest_unavailable
getSessionConfiguration
GET /sessions/{session_id}/configuration
Recovery: safe-read.
Documented HTTP problem codes:
invalid_requestsession_not_foundrequest_unavailable
patchSession
PATCH /sessions/{session_id}/configuration
Recovery: refresh-before-edit.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failedconfiguration_changedcatalog_changedsession_busysession_not_foundrequest_unavailable
getContext
GET /sessions/{session_id}/context
Recovery: safe-read.
getContextWindow
GET /sessions/{session_id}/context-window
Recovery: safe-read.
getContextSection
GET /sessions/{session_id}/context/{snapshot_id}/sections/{section_id}
Recovery: safe-read.
watchSession
GET /sessions/{session_id}/events
Recovery: safe-read.
getFastMode
GET /sessions/{session_id}/fast-mode
Recovery: safe-read.
patchFastMode
PATCH /sessions/{session_id}/fast-mode
Recovery: refresh-before-edit.
getSessionFile
GET /sessions/{session_id}/files
Recovery: safe-read.
getHistory
GET /sessions/{session_id}/history
Recovery: safe-read.
getHistoryContentBatch
GET /sessions/{session_id}/history/content
Recovery: safe-read.
getHistoryContent
GET /sessions/{session_id}/history/{entry_id}
Recovery: safe-read.
getHistoryImage
GET /sessions/{session_id}/history/{entry_id}/{field}
Recovery: safe-read.
getInput
GET /sessions/{session_id}/inputs/{input_id}
Recovery: safe-read.
Documented HTTP problem codes:
invalid_requestinput_unknowninput_conflictrequest_unavailable
putInput
PUT /sessions/{session_id}/inputs/{input_id}
Recovery: repeat-identical-intent.
Documented HTTP problem codes:
invalid_requestidentity_invalidid_conflictinput_conflictidentity_expiredsession_busysession_not_foundrequest_unavailable
cancelInput
POST /sessions/{session_id}/inputs/{input_id}/cancel
Recovery: no-automatic-replay.
editInput
POST /sessions/{session_id}/inputs/{input_id}/edit
Recovery: no-automatic-replay.
holdInput
POST /sessions/{session_id}/inputs/{input_id}/hold
Recovery: no-automatic-replay.
releaseInput
DELETE /sessions/{session_id}/inputs/{input_id}/hold
Recovery: no-automatic-replay.
interruptSession
POST /sessions/{session_id}/interrupt
Recovery: no-automatic-replay.
restartKernel
POST /sessions/{session_id}/kernel/restart
Recovery: no-automatic-replay.
Documented HTTP problem codes:
invalid_requestsession_not_foundrequest_unavailable
upgradeKernel
POST /sessions/{session_id}/kernel/upgrade
Recovery: no-automatic-replay.
Documented HTTP problem codes:
invalid_requestsession_not_foundrequest_unavailable
moveSessionToDaemon
POST /sessions/{session_id}/move
Recovery: no-automatic-replay.
reloadSession
POST /sessions/{session_id}/reload
Recovery: no-automatic-replay.
Documented HTTP problem codes:
invalid_requestsession_not_foundrequest_unavailable
getSessionRequests
GET /sessions/{session_id}/requests
Recovery: safe-read.
rewindSession
POST /sessions/{session_id}/rewind
Recovery: no-automatic-replay.
getShellCommand
GET /sessions/{session_id}/shell-commands/{command_id}
Recovery: safe-read.
putShellCommand
PUT /sessions/{session_id}/shell-commands/{command_id}
Recovery: no-automatic-replay.
getShellCommandOutput
GET /sessions/{session_id}/shell-commands/{command_id}/output
Recovery: safe-read.
stopShellCommand
POST /sessions/{session_id}/shell-commands/{command_id}/stop
Recovery: no-automatic-replay.
putSideQuestion
PUT /sessions/{session_id}/side-questions/{question_id}
Recovery: no-automatic-replay.
patchSideQuestion
PATCH /sessions/{session_id}/side-questions/{question_id}
Recovery: refresh-before-edit.
cancelSideQuestion
POST /sessions/{session_id}/side-questions/{question_id}/cancel
Recovery: no-automatic-replay.
getSessionStatus
GET /sessions/{session_id}/status
Recovery: safe-read.
generateSessionTitle
POST /sessions/{session_id}/title-generation
Recovery: no-automatic-replay.
recordVisit
PUT /sessions/{session_id}/visits/{visit_id}
Recovery: no-automatic-replay.
moveSessionWorkspace
POST /sessions/{session_id}/workspace
Recovery: no-automatic-replay.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failedconfiguration_changedfamily_changedworkspace_invalidworkspace_unavailablesession_busysession_not_foundrequest_unavailable
getSettings
GET /settings
Recovery: safe-read.
getCapabilitySettings
GET /settings/capabilities
Recovery: safe-read.
Documented HTTP problem codes:
invalid_request
patchCapabilitySettings
PATCH /settings/capabilities
Recovery: refresh-before-edit.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failed
getDeclaredSettings
GET /settings/extension_settings
Recovery: safe-read.
Documented HTTP problem codes:
invalid_request
patchDeclaredSettings
PATCH /settings/extension_settings
Recovery: refresh-before-edit.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failed
getExtensionSettings
GET /settings/extensions
Recovery: safe-read.
Documented HTTP problem codes:
invalid_request
patchExtensionSettings
PATCH /settings/extensions
Recovery: refresh-before-edit.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failed
getMCPSettings
GET /settings/mcp
Recovery: safe-read.
Documented HTTP problem codes:
invalid_request
patchMCPSettings
PATCH /settings/mcp
Recovery: refresh-before-edit.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failed
getModelSettings
GET /settings/models
Recovery: safe-read.
Documented HTTP problem codes:
invalid_request
patchModelSettings
PATCH /settings/models
Recovery: refresh-before-edit.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failed
getProviderSettings
GET /settings/providers
Recovery: safe-read.
Documented HTTP problem codes:
invalid_request
patchProviderSettings
PATCH /settings/providers
Recovery: refresh-before-edit.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failed
getUISettings
GET /settings/ui
Recovery: safe-read.
Documented HTTP problem codes:
invalid_request
patchUISettings
PATCH /settings/ui
Recovery: refresh-before-edit.
Documented HTTP problem codes:
invalid_requestprecondition_requiredprecondition_failed
getStorage
GET /storage
Recovery: safe-read.
attachTerminal
GET /terminals/{terminal_id}
Recovery: safe-read.
closeTerminal
DELETE /terminals/{terminal_id}
Recovery: no-automatic-replay.
getUsage
GET /usage
Recovery: safe-read.
getWorkspaces
GET /workspaces
Recovery: safe-read.
Previous change the api Next extension reference