AgentKit Studio
Reference

Control protocol

All 139 operation ids grouped into 25 domains, each with its Host handler location.

Transport rules

The control channel is fixed at /agentkit: 139 operation ids across 25 domains.

RuleValueSource
Control channel/agentkitsrc/contracts/operations.mjs:144
Request envelope{ operationId, payload }; the payload must be serializable JSONsrc/contracts/wire.mjs
Response envelope{ ok: true, value } or { ok: false, error }src/contracts/wire.mjs
CancellationFourth argument is an AbortSignal; one terminal envelope, no retry of unknown effectssrc/contracts/definitions.mjs:8
Idempotencylist / get / status / *.history are read-only; everything else follows its operation semantics—

Domain summary

25 domains, largest first. sessions and agents carry most of the interaction surface.

DomainSizeSummary
host2Host discovery and computer-control entry points.
templates6Expert template catalog, preparation, export and summon.
platform1Platform resource view shared across templates.
template-resources3List, prepare and install resources declared by a template.
template-workflows6Template workflow start, status, cancel and cache.
teams8Team save, start, status, history and stop.
team-templates2Team template list and detail.
sessions24Session export, native recovery, child tasks, A2A, approvals and command output. The largest domain.
agents11Local and cloud Agent lifecycle, execution policy and conversation surface.
models5Model catalog, credential sync and Codex model catalog.
resources2Resource catalog list and delete.
mcp4MCP server create, update, probe and delete.
credentials1Credential write.
settings2Global settings read and update.
skills5Skill discovery, preview, commit and installed preview.
plugins12DSH and Codex plugin install, enable, disable and remove.
star-harness5Local Star Harness install, enable and workspace binding. Callable by the Studio host owner only.
builds4Build create, list, download and portable export.
operations2Long operation list and cancel.
schedules8Schedule CRUD, manual run and delivery targets.
traces4Trace overview, list, detail and OTLP ingest.
evaluations6Evaluation create, read, targets, eval sets and import.
channels4Channel connection, update and action.
server1Server action entry point.
deployments11Deployment prepare, create, update, reconcile, logs and remove.

Full list

The handler column points at the Host dispatch entry; the parenthetical marks a prefix-dispatched domain or a retired id.

DomainOperation idActionHandler
hosthost/compatibilityRead compatibilitysrc/host/routes/host.mjs:7
hosthost/computerDrive computersrc/host/routes/host.mjs:9
templatestemplates/listListsrc/host/routes/templates.mjs:8
templatestemplates/preparePreparesrc/host/routes/templates.mjs:12
templatestemplates/exportExportsrc/host/routes/templates.mjs:15
templatestemplates/avatarRead avatarsrc/host/routes/templates.mjs:11
templatestemplates/summon-planBuild summon plansrc/host/routes/templates.mjs:13
templatestemplates/summonSummonsrc/host/routes/templates.mjs:14
platformplatform/resourcesList resourcessrc/host/routes/templates.mjs:19
template-resourcestemplate-resources/listListsrc/host/routes/templates.mjs:10 (prefix dispatch)
template-resourcestemplate-resources/preparePreparesrc/host/routes/templates.mjs:10 (prefix dispatch)
template-resourcestemplate-resources/installInstallsrc/host/routes/templates.mjs:10 (prefix dispatch)
template-workflowstemplate-workflows/startStartsrc/host/routes/templates.mjs:9 (prefix dispatch)
template-workflowstemplate-workflows/statusRead statussrc/host/routes/templates.mjs:9 (prefix dispatch)
template-workflowstemplate-workflows/cancelCancelsrc/host/routes/templates.mjs:9 (prefix dispatch)
template-workflowstemplate-workflows/detailRead detailsrc/host/routes/templates.mjs:9 (prefix dispatch)
template-workflowstemplate-workflows/cacheRead cachesrc/host/routes/templates.mjs:9 (prefix dispatch)
template-workflowstemplate-workflows/clearCacheClear cachesrc/host/routes/templates.mjs:9 (prefix dispatch)
teamsteams/listListsrc/host/routes/templates.mjs:7 (prefix dispatch)
teamsteams/saveSavesrc/host/routes/templates.mjs:7 (prefix dispatch)
teamsteams/removeRemovesrc/host/routes/templates.mjs:7 (prefix dispatch)
teamsteams/startStartsrc/host/routes/templates.mjs:7 (prefix dispatch)
teamsteams/statusRead statussrc/host/routes/templates.mjs:7 (prefix dispatch)
teamsteams/historyRead historysrc/host/routes/templates.mjs:7 (prefix dispatch)
teamsteams/resumeResumesrc/host/routes/templates.mjs:7 (prefix dispatch)
teamsteams/stopStopsrc/host/routes/templates.mjs:7 (prefix dispatch)
team-templatesteam-templates/listListsrc/host/routes/templates.mjs:6 (prefix dispatch)
team-templatesteam-templates/detailRead detailsrc/host/routes/templates.mjs:6 (prefix dispatch)
sessionssessions/export-logExport transcriptsrc/host/routes/sessions.mjs:16
sessionssessions/native-injectInject native eventsrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-recovery-statusRead recovery statussrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-recovery-resumeResume native sessionsrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-recovery-reconcileReconcile native recoverysrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-background-reviewReview in backgroundsrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-resource-retireRetire native resourcesrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-workspace-repairRepair workspacesrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-conversation-statusRead conversation statussrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-conversation-rewindRewind conversationsrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-conversation-workspace-previewPreview workspacesrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-a2a-controlControl A2Asrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/dsh-a2a-historyRead A2A historysrc/host/routes/sessions.mjs:9
sessionssessions/dsh-a2a-controlControl DSH A2Asrc/host/routes/sessions.mjs:9
sessionssessions/native-child-tasksList child taskssrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-child-promotePromote child tasksrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-child-sendSend to child tasksrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-child-cancelCancel child tasksrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-child-historyRead child task historysrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-child-resultRead child task resultsrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-child-fileRead child task filesrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-command-outputRead command outputsrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-approval-statusRead approval statussrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
sessionssessions/native-approval-decisionSubmit approval decisionsrc/host/routes/sessions.mjs:7 (retired, throws STUDIO_LEGACY_HARNESS_RETIRED)
agentsagents/listListsrc/host/routes/agents.mjs:94
agentsagents/create-localCreate localsrc/host/routes/agents.mjs:21
agentsagents/update-cloudUpdate cloudsrc/host/routes/agents.mjs:49
agentsagents/ensure-presetEnsure presetsrc/host/routes/agents.mjs:123
agentsagents/managed-deleteDelete managed resourcesrc/host/routes/agents.mjs:67
agentsagents/execution-policyRead execution policysrc/host/routes/agents.mjs:97
agentsagents/execution-policy-setSet execution policysrc/host/routes/agents.mjs:107
agentsagents/conversation-surfaceRead conversation surfacesrc/host/routes/agents.mjs:146
agentsagents/local-getRead localsrc/host/routes/agents.mjs:21
agentsagents/update-localUpdate localsrc/host/routes/agents.mjs:21
agentsagents/local-deleteDelete localsrc/host/routes/agents.mjs:8
modelsmodels/sync-credentialSync credentialsrc/host/routes/models.mjs:4
modelsmodels/credential-statusRead credential statussrc/host/routes/models.mjs:6
modelsmodels/createCreatesrc/host/routes/models.mjs:8
modelsmodels/catalogRead catalogsrc/host/routes/models.mjs:14
modelsmodels/codexRead Codex catalogsrc/host/routes/models.mjs:18
resourcesresources/listListsrc/host/routes/resources.mjs:8
resourcesresources/deleteDeletesrc/host/routes/resources.mjs:36
mcpmcp/createCreatesrc/host/routes/resources.mjs:23
mcpmcp/updateUpdatesrc/host/routes/resources.mjs:27
mcpmcp/probeProbesrc/host/routes/resources.mjs:32
mcpmcp/deleteDeletesrc/host/routes/resources.mjs:36
credentialscredentials/putWritesrc/host/routes/credentials.mjs:2
settingssettings/getReadsrc/host/routes/models.mjs:10
settingssettings/updateUpdatesrc/host/routes/models.mjs:12
skillsskills/discoverDiscoversrc/host/routes/skills.mjs:4
skillsskills/preview-discoveredPreview discoveredsrc/host/routes/skills.mjs:4
skillsskills/commit-discoveredCommit discoveredsrc/host/routes/skills.mjs:4
skillsskills/listListsrc/host/routes/skills.mjs:4
skillsskills/preview-installedPreview installedsrc/host/routes/skills.mjs:4
pluginsplugins/dsh-listList DSH pluginssrc/host/routes/plugins.mjs:7
pluginsplugins/dsh-discoverDiscover DSH pluginssrc/host/routes/plugins.mjs:9
pluginsplugins/dsh-index-refreshRefresh remote indexsrc/host/routes/plugins.mjs:11
pluginsplugins/dsh-installInstall DSH pluginsrc/host/routes/plugins.mjs:13
pluginsplugins/dsh-removeRemove DSH pluginsrc/host/routes/plugins.mjs:15
pluginsplugins/dsh-enableEnable DSH pluginsrc/host/routes/plugins.mjs:17
pluginsplugins/dsh-disableDisable DSH pluginsrc/host/routes/plugins.mjs:17
pluginsplugins/dsh-updateUpdate DSH pluginsrc/host/routes/plugins.mjs:21
pluginsplugins/codex-listList Codex pluginssrc/host/routes/plugins.mjs:32
pluginsplugins/codex-inspectInspect Codex pluginsrc/host/routes/plugins.mjs:32
pluginsplugins/codex-installInstall Codex pluginsrc/host/routes/plugins.mjs:25
pluginsplugins/codex-removeRemove Codex pluginsrc/host/routes/plugins.mjs:25
star-harnessstar-harness/statusRead statussrc/host/routes/star-harness.mjs:4
star-harnessstar-harness/installInstallsrc/host/routes/star-harness.mjs:8
star-harnessstar-harness/enableEnablesrc/host/routes/star-harness.mjs:9
star-harnessstar-harness/bindBind workspacesrc/host/routes/star-harness.mjs:10
star-harnessstar-harness/unbindUnbind workspacesrc/host/routes/star-harness.mjs:11
buildsbuilds/createCreatesrc/host/routes/builds.mjs:5
buildsbuilds/listListsrc/host/routes/builds.mjs:5
buildsbuilds/downloadDownloadsrc/host/routes/builds.mjs:5
buildsbuilds/export-portableExport portable bundlesrc/host/routes/builds.mjs:5
operationsoperations/listListsrc/host/routes/builds.mjs:5
operationsoperations/cancelCancelsrc/host/routes/builds.mjs:5
schedulesschedules/listListsrc/host/routes/schedules.mjs:15
schedulesschedules/createCreatesrc/host/routes/schedules.mjs:19
schedulesschedules/getReadsrc/host/routes/schedules.mjs:21
schedulesschedules/updateUpdatesrc/host/routes/schedules.mjs:23
schedulesschedules/deleteDeletesrc/host/routes/schedules.mjs:25
schedulesschedules/runRunsrc/host/routes/schedules.mjs:27
schedulesschedules/occurrencesRead occurrencessrc/host/routes/schedules.mjs:29
schedulesschedules/delivery-targetsList delivery targetssrc/host/routes/schedules.mjs:6
tracestraces/overviewRead overviewsrc/host/routes/traces.mjs:10
tracestraces/listListsrc/host/routes/traces.mjs:21
tracestraces/getReadsrc/host/routes/traces.mjs:23
tracestraces/otlpIngest OTLPsrc/host/routes/traces.mjs:25
evaluationsevaluations/listListsrc/host/routes/evaluations.mjs:9
evaluationsevaluations/createCreatesrc/host/routes/evaluations.mjs:19
evaluationsevaluations/getReadsrc/host/routes/evaluations.mjs:11
evaluationsevaluations/targetsList targetssrc/host/routes/evaluations.mjs:13
evaluationsevaluations/evalsetsRead eval setssrc/host/routes/evaluations.mjs:15
evaluationsevaluations/importImportsrc/host/routes/evaluations.mjs:17
channelschannels/connectionRead connectionsrc/host/routes/channels.mjs:9
channelschannels/updateUpdatesrc/host/routes/channels.mjs:11
channelschannels/agent-updateUpdate agent linksrc/host/routes/channels.mjs:13
channelschannels/actionRun actionsrc/host/routes/channels.mjs:15
serverserver/actionRun actionsrc/host/routes/server.mjs:5
deploymentsdeployments/preparePreparesrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/createCreatesrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/prepareUpdatePreflight updatesrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/applyUpdateApply updatesrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/listListsrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/getReadsrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/refreshRefreshsrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/repairAccessRepair accesssrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/reconcileReconcilesrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/logsRead logssrc/host/routes/deployments.mjs:4 (prefix dispatch)
deploymentsdeployments/removeRemovesrc/host/routes/deployments.mjs:4 (prefix dispatch)

Retired and contract-only ids

21 ids stay in the contract, but Host dispatch throws STUDIO_LEGACY_HARNESS_RETIRED (src/host/routes/sessions.mjs:8). This is intentional: old clients get a recognizable code instead of a 404.

Do not depend on retired ids

sessions/native-* belongs to the removed in-process Harness. New integrations should use the native session API of the matching runtime; see Session events.

Version and compatibility

ItemValueNotes
Operation ids139Adding or removing one is a breaking change
Domains25A new domain must land here and in the router
Channel/agentkitHardcoded in the client, not configurable

Developer entry points

ItemSource
Operation listsrc/contracts/operations.mjs
Wire codecsrc/contracts/wire.mjs
Operation definitionssrc/contracts/definitions.mjs
Host routessrc/host/routes/index.mjs
Client bridgesrc/remote/control-client.mjs

Related tests:

Test fileLocation
host-compatibility.test.mjstests/host-compatibility.test.mjs
host-route-contracts.test.mjstests/host-route-contracts.test.mjs
studio-wire-contracts.test.mjstests/studio-wire-contracts.test.mjs
host-dispatcher.test.mjstests/host-dispatcher.test.mjs
host-route-contracts.test.mjstests/host-route-contracts.test.mjs
local-agent-edit-conflicts.test.mjstests/local-agent-edit-conflicts.test.mjs

On this page