方法目录

从 daemon 权威注册表生成。完整方法列表看本页；叙述性说明见 概览 与 JSON-RPC 参考。

版本通道请用顶栏 0.8.x / next 切换；下方提供过滤、作用域筛选和分组跳转。Live 请求使用经过认证的 WebSocket Gateway（首帧为 gateway.hello）；未标记为 remote 的方法仅提供 Mock 与本地 CLI。

保持同步

在 apps/docs 下协议变更后执行 pnpm sync-protocol，并提交更新后的 src/data/rpc-catalog.json。

完整注册表

Protocol 1.7.0· 169 个方法· protocol/jsonrpc/methods.json· channel 0.8.x

过滤方法

read72write59admin29worker7stream2

跳转到分组全部分组Runtime (4)Gateway (4)Daemon (6)Usage (1)Model (1)Agent (8)Session (23)Checkpoint (5)Execution (13)Governance (3)Question (2)History (1)Memory (12)Schedule (5)Goal (7)Workflow (8)Channel (5)Extension (6)Telemetry (1)Artifact (3)Context (5)Workspace (18)Mcp (1)Command (2)Audit (3)Profile (2)Product Control (3)Secret (2)Plugin (2)Worker (4)Backpressure (2)Work (5)Debug (2)显示 169 个方法

Runtime4

#runtime.initializeread远程

参数

字段	类型
protocol_version	semver?
schema_version	semver? compatible major
projection_version	semver? exact reducer match
client_name	string?
client_version	semver?
expected_workspace_id	string?
expected_runtime_id	string?
expected_epoch	string?

返回值

RuntimeInitializeResult

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "runtime.initialize",
  "params": {}
}

// scope: read
const result = await client.request("runtime.initialize", {});

# JSON-RPC over the local socket
carina call runtime.initialize

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"runtime.initialize","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "runtime.initialize", "params": { "expected_workspace_id": "/repo" } }

复制 JSON复制本地 CLI发送

#runtime.describeread

参数

{}

返回值

RuntimeDescription

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "runtime.describe",
  "params": {}
}

// scope: read
const result = await client.request("runtime.describe", {});

# JSON-RPC over the local socket
carina call runtime.describe

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"runtime.describe","params":{}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "runtime.describe", "params": {} }

复制 JSON复制本地 CLI发送

#runtime.capabilitiesread远程

参数

{}

返回值

{ runtime_version: semver, protocol_version: semver, capabilities: object }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "runtime.capabilities",
  "params": {}
}

// scope: read
const result = await client.request("runtime.capabilities", {});

# JSON-RPC over the local socket
carina call runtime.capabilities

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"runtime.capabilities","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "runtime.capabilities", "params": {} }

复制 JSON复制本地 CLI发送

#runtime.registry_schemaread远程

参数

{}

返回值

JSON Schema Draft 2020-12

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "runtime.registry_schema",
  "params": {}
}

// scope: read
const result = await client.request("runtime.registry_schema", {});

# JSON-RPC over the local socket
carina call runtime.registry_schema

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"runtime.registry_schema","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "runtime.registry_schema", "params": {} }

复制 JSON复制本地 CLI发送

Gateway4

#gateway.helloread远程

参数

字段	类型
protocol_version	number?
client_id	string?
role	operator|observer|worker|node?
scopes	Scope[]?
token	string?

返回值

GatewayHello

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "gateway.hello",
  "params": {
    "protocol_version": 1,
    "scopes": []
  }
}

// scope: read
const result = await client.request("gateway.hello", {
  "protocol_version": 1,
  "scopes": []
});

# JSON-RPC over the local socket
carina call gateway.hello

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"gateway.hello","params":{"protocol_version":1,"scopes":[]}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "gateway.hello", "params": { "protocol_version": 1 } }

复制 JSON复制本地 CLI发送

#gateway.methodsread远程

参数

{}

返回值

{ version: string, methods: MethodDescriptor[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "gateway.methods",
  "params": {}
}

// scope: read
const result = await client.request("gateway.methods", {});

# JSON-RPC over the local socket
carina call gateway.methods

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"gateway.methods","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "gateway.methods", "params": {} }

复制 JSON复制本地 CLI发送

#gateway.resolve_scoperead

参数

字段	类型
method	string
params	object?

返回值

{ method: string, scope: Scope, dynamic_scope: boolean }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "gateway.resolve_scope",
  "params": {
    "method": "<method>"
  }
}

// scope: read
const result = await client.request("gateway.resolve_scope", {
  "method": "<method>"
});

# JSON-RPC over the local socket
carina call gateway.resolve_scope

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"gateway.resolve_scope","params":{"method":"<method>"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "gateway.resolve_scope", "params": { "method": "<method>" } }

复制 JSON复制本地 CLI发送

#gateway.token.issueadmin控制面

参数

字段	类型
subject	string?
role	operator|observer|worker|node?
scopes	Scope[]
routes	string[]?
ttl_seconds	number?
transport	ws|http|plugin?

返回值

{ token: string, claims: GatewayTokenClaims }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "gateway.token.issue",
  "params": {
    "scopes": [],
    "routes": [],
    "ttl_seconds": 1
  }
}

// scope: admin
const result = await client.request("gateway.token.issue", {
  "scopes": [],
  "routes": [],
  "ttl_seconds": 1
});

# JSON-RPC over the local socket
carina call gateway.token.issue

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"gateway.token.issue","params":{"scopes":[],"routes":[],"ttl_seconds":1}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "gateway.token.issue", "params": { "scopes": "<scopes>", "ttl_seconds": 1 } }

复制 JSON复制本地 CLI发送

Daemon6

#daemon.statusread远程

参数

{}

返回值

DaemonStatus

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "daemon.status",
  "params": {}
}

// scope: read
const result = await client.request("daemon.status", {});

# JSON-RPC over the local socket
carina call daemon.status

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"daemon.status","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "daemon.status", "params": {} }

复制 JSON复制本地 CLI发送

#daemon.metricsread远程

参数

{}

返回值

DaemonMetrics

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "daemon.metrics",
  "params": {}
}

// scope: read
const result = await client.request("daemon.metrics", {});

# JSON-RPC over the local socket
carina call daemon.metrics

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"daemon.metrics","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "daemon.metrics", "params": {} }

复制 JSON复制本地 CLI发送

#daemon.doctorread远程

参数

{}

返回值

DoctorReport

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "daemon.doctor",
  "params": {}
}

// scope: read
const result = await client.request("daemon.doctor", {});

# JSON-RPC over the local socket
carina call daemon.doctor

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"daemon.doctor","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "daemon.doctor", "params": {} }

复制 JSON复制本地 CLI发送

#daemon.remote.disableadmin控制面

参数

字段	类型
on	boolean

返回值

{ remote_disabled: boolean }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "daemon.remote.disable",
  "params": {
    "on": true
  }
}

// scope: admin
const result = await client.request("daemon.remote.disable", {
  "on": true
});

# JSON-RPC over the local socket
carina call daemon.remote.disable

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"daemon.remote.disable","params":{"on":true}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "daemon.remote.disable", "params": { "on": true } }

复制 JSON复制本地 CLI发送

#daemon.reloadadmin控制面

参数

{}

返回值

{ reloaded: boolean }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "daemon.reload",
  "params": {}
}

// scope: admin
const result = await client.request("daemon.reload", {});

# JSON-RPC over the local socket
carina call daemon.reload

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"daemon.reload","params":{}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "daemon.reload", "params": {} }

复制 JSON复制本地 CLI发送

#daemon.set_interactive_approvalwrite控制面

参数

字段	类型
on	boolean?
mode	ask|always-approve|dont-ask|accept-edits?
session_id	string?

返回值

{ interactive_approval: boolean, approval_mode: ask|always-approve|dont-ask|accept-edits, previous_mode: string, disable_always_approve: boolean, warning: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "daemon.set_interactive_approval",
  "params": {
    "on": true,
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("daemon.set_interactive_approval", {
  "on": true,
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call daemon.set_interactive_approval

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"daemon.set_interactive_approval","params":{"on":true,"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "daemon.set_interactive_approval", "params": { "on": true, "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

Usage1

#usage.costread远程

参数

字段	类型
session_id	string?
task_id	string?

返回值

UsageCostReport

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "usage.cost",
  "params": {
    "session_id": "sess_01J...",
    "task_id": "Summarize module boundaries"
  }
}

// scope: read
const result = await client.request("usage.cost", {
  "session_id": "sess_01J...",
  "task_id": "Summarize module boundaries"
});

# JSON-RPC over the local socket
carina call usage.cost

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"usage.cost","params":{"session_id":"sess_01J...","task_id":"Summarize module boundaries"}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "usage.cost", "params": { "session_id": "sess_01J...", "task_id": "Summarize module boundaries" } }

复制 JSON复制本地 CLI发送

Model1

#model.listread远程

参数

字段	类型
session_id	string?
model_id	string?
locale	string?

返回值

{ default_model: string, providers: ModelProvider[], reasoner: ModelReasoner, readiness: { step, blockers[], route_kind, model_id, locale, can_submit, epoch, generation } }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "model.list",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("model.list", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call model.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"model.list","params":{"session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "model.list", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

Agent8

#agent.listread远程

参数

字段	类型
session_id	string?
workspace_root	string?
include_hidden	boolean?

返回值

{ agents: Agent[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "agent.list",
  "params": {
    "session_id": "sess_01J...",
    "workspace_root": "/repo",
    "include_hidden": true
  }
}

// scope: read
const result = await client.request("agent.list", {
  "session_id": "sess_01J...",
  "workspace_root": "/repo",
  "include_hidden": true
});

# JSON-RPC over the local socket
carina call agent.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"agent.list","params":{"session_id":"sess_01J...","workspace_root":"/repo","include_hidden":true}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "agent.list", "params": { "session_id": "sess_01J...", "workspace_root": "/repo", "include_hidden": true } }

复制 JSON复制本地 CLI发送

#agent.viewread远程

参数

{}

返回值

{ needs_input: AgentViewEntry[], working: AgentViewEntry[], completed: AgentViewEntry[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "agent.view",
  "params": {}
}

// scope: read
const result = await client.request("agent.view", {});

# JSON-RPC over the local socket
carina call agent.view

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"agent.view","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "agent.view", "params": {} }

复制 JSON复制本地 CLI发送

#agent.peekread远程

参数

字段	类型
task_id	string

返回值

AgentViewEntry

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "agent.peek",
  "params": {
    "task_id": "Summarize module boundaries"
  }
}

// scope: read
const result = await client.request("agent.peek", {
  "task_id": "Summarize module boundaries"
});

# JSON-RPC over the local socket
carina call agent.peek

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"agent.peek","params":{"task_id":"Summarize module boundaries"}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "agent.peek", "params": { "task_id": "Summarize module boundaries" } }

复制 JSON复制本地 CLI发送

#agent.recapread远程

参数

字段	类型
task_id	string

返回值

{ agent: AgentViewEntry, recent_events: Event[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "agent.recap",
  "params": {
    "task_id": "Summarize module boundaries"
  }
}

// scope: read
const result = await client.request("agent.recap", {
  "task_id": "Summarize module boundaries"
});

# JSON-RPC over the local socket
carina call agent.recap

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"agent.recap","params":{"task_id":"Summarize module boundaries"}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "agent.recap", "params": { "task_id": "Summarize module boundaries" } }

复制 JSON复制本地 CLI发送

#agent.dispatchwrite控制面

参数

字段	类型
workspace_root	string
prompt	string
profile	string?
approval_mode	string?
agent	string?
model	string?
isolate	boolean?
base_ref	string?
branch	string?
title	string?

返回值

{ session: Session, task: Task, worktree_id: string? }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "agent.dispatch",
  "params": {
    "workspace_root": "/repo",
    "prompt": "Summarize module boundaries",
    "profile": "safe-edit",
    "isolate": true
  }
}

// scope: write
const result = await client.request("agent.dispatch", {
  "workspace_root": "/repo",
  "prompt": "Summarize module boundaries",
  "profile": "safe-edit",
  "isolate": true
});

# JSON-RPC over the local socket
carina call agent.dispatch

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"agent.dispatch","params":{"workspace_root":"/repo","prompt":"Summarize module boundaries","profile":"safe-edit","isolate":true}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "agent.dispatch", "params": { "workspace_root": "/repo", "prompt": "Summarize module boundaries", "profile": "safe-edit", "isolate": true } }

复制 JSON复制本地 CLI发送

#agent.stopwrite

参数

字段	类型
task_id	string

返回值

Task

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "agent.stop",
  "params": {
    "task_id": "Summarize module boundaries"
  }
}

// scope: write
const result = await client.request("agent.stop", {
  "task_id": "Summarize module boundaries"
});

# JSON-RPC over the local socket
carina call agent.stop

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"agent.stop","params":{"task_id":"Summarize module boundaries"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "agent.stop", "params": { "task_id": "Summarize module boundaries" } }

复制 JSON复制本地 CLI发送

#agent.removewrite

参数

字段	类型
task_id	string

返回值

{ removed: boolean, task_id: string, session_id: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "agent.remove",
  "params": {
    "task_id": "Summarize module boundaries"
  }
}

// scope: write
const result = await client.request("agent.remove", {
  "task_id": "Summarize module boundaries"
});

# JSON-RPC over the local socket
carina call agent.remove

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"agent.remove","params":{"task_id":"Summarize module boundaries"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "agent.remove", "params": { "task_id": "Summarize module boundaries" } }

复制 JSON复制本地 CLI发送

#agent.metadata.setwrite

参数

字段	类型
session_id	string
title	string?
pull_request	string?
branch	string?
worktree_id	string?

返回值

AgentViewMetadata

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "agent.metadata.set",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("agent.metadata.set", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call agent.metadata.set

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"agent.metadata.set","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "agent.metadata.set", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

Session23

#session.createwrite

参数

字段	类型
workspace_root	string
profile	string?
approval_mode	string?

返回值

Session

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.create",
  "params": {
    "workspace_root": "/repo",
    "profile": "safe-edit"
  }
}

// scope: write
const result = await client.request("session.create", {
  "workspace_root": "/repo",
  "profile": "safe-edit"
});

# JSON-RPC over the local socket
carina call session.create

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.create","params":{"workspace_root":"/repo","profile":"safe-edit"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.create", "params": { "workspace_root": "/repo", "profile": "safe-edit" } }

复制 JSON复制本地 CLI发送

#session.getread远程

参数

字段	类型
session_id	string

返回值

Session

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.get",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("session.get", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.get

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.get","params":{"session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.get", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.listread远程

参数

字段	类型
archived	boolean? (false active/non-closed only; true closed only; omitted all)

返回值

Session[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.list",
  "params": {
    "archived": true
  }
}

// scope: read
const result = await client.request("session.list", {
  "archived": true
});

# JSON-RPC over the local socket
carina call session.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.list","params":{"archived":true}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.list", "params": { "archived": true } }

复制 JSON复制本地 CLI发送

#session.renamewrite

参数

字段	类型
session_id	string
name	string 1..80

返回值

Session

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.rename",
  "params": {
    "session_id": "sess_01J...",
    "name": "<name>"
  }
}

// scope: write
const result = await client.request("session.rename", {
  "session_id": "sess_01J...",
  "name": "<name>"
});

# JSON-RPC over the local socket
carina call session.rename

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.rename","params":{"session_id":"sess_01J...","name":"<name>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.rename", "params": { "session_id": "sess_01J...", "name": "<name>" } }

复制 JSON复制本地 CLI发送

#session.archivewrite

参数

字段	类型
session_id	string

返回值

Session(status=closed); rejects every non-terminal task

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.archive",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("session.archive", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.archive

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.archive","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.archive", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.unarchivewrite

参数

字段	类型
session_id	string

返回值

Session(status=active)

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.unarchive",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("session.unarchive", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.unarchive

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.unarchive","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.unarchive", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.pausewrite

参数

字段	类型
session_id	string

返回值

Session

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.pause",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("session.pause", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.pause

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.pause","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.pause", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.resumewrite

参数

字段	类型
session_id	string

返回值

Session

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.resume",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("session.resume", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.resume

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.resume","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.resume", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.closewrite

参数

字段	类型
session_id	string

返回值

Session

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.close",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("session.close", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.close

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.close","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.close", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.replayread远程

参数

字段	类型
session_id	string

返回值

Event[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.replay",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("session.replay", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.replay

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.replay","params":{"session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.replay", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.itemsread远程

参数

字段	类型
session_id	string
cursor	signed opaque exclusive cursor?
limit	integer 1..200?

返回值

SessionItemEvent[] when pagination omitted; otherwise { data: SessionItemEvent[], next_cursor: string?, projection_version: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.items",
  "params": {
    "session_id": "sess_01J...",
    "limit": 1
  }
}

// scope: read
const result = await client.request("session.items", {
  "session_id": "sess_01J...",
  "limit": 1
});

# JSON-RPC over the local socket
carina call session.items

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.items","params":{"session_id":"sess_01J...","limit":1}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.items", "params": { "session_id": "sess_01J...", "limit": 1 } }

复制 JSON复制本地 CLI发送

#conversation.import.discoverread

参数

字段	类型
sources	(claude-code|codex)[]?
source_root	string?
workspace_root	string?
all_workspaces	boolean?

返回值

{ conversations: ImportCandidate[], warnings: string[], copy_semantics: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "conversation.import.discover",
  "params": {
    "sources": [],
    "source_root": "/repo",
    "workspace_root": "/repo",
    "all_workspaces": true
  }
}

// scope: read
const result = await client.request("conversation.import.discover", {
  "sources": [],
  "source_root": "/repo",
  "workspace_root": "/repo",
  "all_workspaces": true
});

# JSON-RPC over the local socket
carina call conversation.import.discover

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"conversation.import.discover","params":{"sources":[],"source_root":"/repo","workspace_root":"/repo","all_workspaces":true}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "conversation.import.discover", "params": { "source_root": "/repo", "workspace_root": "/repo", "all_workspaces": "/repo" } }

复制 JSON复制本地 CLI发送

#conversation.import.applywrite

参数

字段	类型
selections	{ source, source_root?, path, conversation_id, target_workspace? }[]

返回值

{ results: ImportReceipt[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "conversation.import.apply",
  "params": {
    "selections": []
  }
}

// scope: write
const result = await client.request("conversation.import.apply", {
  "selections": []
});

# JSON-RPC over the local socket
carina call conversation.import.apply

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"conversation.import.apply","params":{"selections":[]}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "conversation.import.apply", "params": {} }

复制 JSON复制本地 CLI发送

#session.reviewread远程

参数

字段	类型
session_id	string

返回值

SessionReview

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.review",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("session.review", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.review

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.review","params":{"session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.review", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.attachread远程

参数

字段	类型
session_id	string
since	number?
event_mode	compat|canonical? (default compat)

返回值

{ events: Event[], from: number, cursor: number, event_mode: compat|canonical }; cursor always advances over raw audit positions

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.attach",
  "params": {
    "session_id": "sess_01J...",
    "since": 1
  }
}

// scope: read
const result = await client.request("session.attach", {
  "session_id": "sess_01J...",
  "since": 1
});

# JSON-RPC over the local socket
carina call session.attach

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.attach","params":{"session_id":"sess_01J...","since":1}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.attach", "params": { "session_id": "sess_01J...", "since": 1 } }

复制 JSON复制本地 CLI发送

#session.forkwrite

参数

字段	类型
session_id	string
last_task_id	string?
through_turn	integer? >= 1
before_first	boolean?
client_fork_id	ASCII token? 1-128

返回值

Source-preserving Session with fork lineage; client_fork_id retries are idempotent

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.fork",
  "params": {
    "session_id": "sess_01J...",
    "last_task_id": "Summarize module boundaries",
    "through_turn": 1,
    "before_first": true
  }
}

// scope: write
const result = await client.request("session.fork", {
  "session_id": "sess_01J...",
  "last_task_id": "Summarize module boundaries",
  "through_turn": 1,
  "before_first": true
});

# JSON-RPC over the local socket
carina call session.fork

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.fork","params":{"session_id":"sess_01J...","last_task_id":"Summarize module boundaries","through_turn":1,"before_first":true}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.fork", "params": { "session_id": "sess_01J...", "last_task_id": "Summarize module boundaries", "through_turn": 1, "before_first": true } }

复制 JSON复制本地 CLI发送

#session.plan_modewrite

参数

字段	类型
session_id	string
on	boolean

返回值

{ session_id: string, plan_mode: boolean }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.plan_mode",
  "params": {
    "session_id": "sess_01J...",
    "on": true
  }
}

// scope: write
const result = await client.request("session.plan_mode", {
  "session_id": "sess_01J...",
  "on": true
});

# JSON-RPC over the local socket
carina call session.plan_mode

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.plan_mode","params":{"session_id":"sess_01J...","on":true}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.plan_mode", "params": { "session_id": "sess_01J...", "on": true } }

复制 JSON复制本地 CLI发送

#session.model.getread

参数

字段	类型
session_id	string

返回值

{ session_id: string, next_model: string, next_reasoning_effort: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.model.get",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("session.model.get", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.model.get

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.model.get","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.model.get", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.model.setwrite控制面

参数

字段	类型
session_id	string
model	string
reasoning_effort	string?

返回值

{ session_id: string, next_model: string, next_reasoning_effort: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.model.set",
  "params": {
    "session_id": "sess_01J...",
    "model": "<model>"
  }
}

// scope: write
const result = await client.request("session.model.set", {
  "session_id": "sess_01J...",
  "model": "<model>"
});

# JSON-RPC over the local socket
carina call session.model.set

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.model.set","params":{"session_id":"sess_01J...","model":"<model>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.model.set", "params": { "session_id": "sess_01J...", "model": "<model>" } }

复制 JSON复制本地 CLI发送

#session.approve_planwrite

参数

字段	类型
session_id	string
run_id	string? (expected latest completed typed Plan run)

返回值

{ session_id: string, plan_mode: false, approved: true, task: Task? }; a matching completed plan queues exactly one build task; omitted run_id preserves compatibility

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.approve_plan",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("session.approve_plan", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.approve_plan

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.approve_plan","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.approve_plan", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.add_diradmin控制面

参数

字段	类型
session_id	string
path	string

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.add_dir",
  "params": {
    "session_id": "sess_01J...",
    "path": "/repo"
  }
}

// scope: admin
const result = await client.request("session.add_dir", {
  "session_id": "sess_01J...",
  "path": "/repo"
});

# JSON-RPC over the local socket
carina call session.add_dir

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.add_dir","params":{"session_id":"sess_01J...","path":"/repo"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.add_dir", "params": { "session_id": "sess_01J...", "path": "/repo" } }

复制 JSON复制本地 CLI发送

#session.events.streamstream远程

参数

字段	类型
session_id	string
since	integer? >= 0
event_mode	compat|canonical? (default compat)

返回值

{ subscription_id: string, cursor: integer, replayed: integer, event_mode: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.events.stream",
  "params": {
    "session_id": "sess_01J...",
    "since": 1
  }
}

// scope: stream
const result = await client.request("session.events.stream", {
  "session_id": "sess_01J...",
  "since": 1
});

# JSON-RPC over the local socket
carina call session.events.stream

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.events.stream","params":{"session_id":"sess_01J...","since":1}}

请求演练

stream

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.events.stream", "params": { "session_id": "sess_01J...", "since": 1 } }

复制 JSON复制本地 CLI发送

#session.events.unsubscribestream远程

参数

字段	类型
subscription_id	string

返回值

{ unsubscribed: boolean }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.events.unsubscribe",
  "params": {
    "subscription_id": "<subscription_id>"
  }
}

// scope: stream
const result = await client.request("session.events.unsubscribe", {
  "subscription_id": "<subscription_id>"
});

# JSON-RPC over the local socket
carina call session.events.unsubscribe

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.events.unsubscribe","params":{"subscription_id":"<subscription_id>"}}

请求演练

stream

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.events.unsubscribe", "params": { "subscription_id": "<subscription_id>" } }

复制 JSON复制本地 CLI发送

Checkpoint5

#session.checkpoint.listread

参数

字段	类型
session_id	string

返回值

Checkpoint[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.checkpoint.list",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("session.checkpoint.list", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call session.checkpoint.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.checkpoint.list","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.checkpoint.list", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#session.checkpoint.previewread

参数

字段	类型
session_id	string
checkpoint_id	string

返回值

CheckpointPreview

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.checkpoint.preview",
  "params": {
    "session_id": "sess_01J...",
    "checkpoint_id": "<checkpoint_id>"
  }
}

// scope: read
const result = await client.request("session.checkpoint.preview", {
  "session_id": "sess_01J...",
  "checkpoint_id": "<checkpoint_id>"
});

# JSON-RPC over the local socket
carina call session.checkpoint.preview

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.checkpoint.preview","params":{"session_id":"sess_01J...","checkpoint_id":"<checkpoint_id>"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.checkpoint.preview", "params": { "session_id": "sess_01J...", "checkpoint_id": "<checkpoint_id>" } }

复制 JSON复制本地 CLI发送

#session.checkpoint.summarizeread

参数

字段	类型
session_id	string
checkpoint_id	string

返回值

CheckpointSummary

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.checkpoint.summarize",
  "params": {
    "session_id": "sess_01J...",
    "checkpoint_id": "<checkpoint_id>"
  }
}

// scope: read
const result = await client.request("session.checkpoint.summarize", {
  "session_id": "sess_01J...",
  "checkpoint_id": "<checkpoint_id>"
});

# JSON-RPC over the local socket
carina call session.checkpoint.summarize

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.checkpoint.summarize","params":{"session_id":"sess_01J...","checkpoint_id":"<checkpoint_id>"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.checkpoint.summarize", "params": { "session_id": "sess_01J...", "checkpoint_id": "<checkpoint_id>" } }

复制 JSON复制本地 CLI发送

#session.checkpoint.restorewrite控制面

参数

字段	类型
session_id	string
checkpoint_id	string
confirmed	boolean

返回值

CheckpointRestoreResult

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.checkpoint.restore",
  "params": {
    "session_id": "sess_01J...",
    "checkpoint_id": "<checkpoint_id>",
    "confirmed": true
  }
}

// scope: write
const result = await client.request("session.checkpoint.restore", {
  "session_id": "sess_01J...",
  "checkpoint_id": "<checkpoint_id>",
  "confirmed": true
});

# JSON-RPC over the local socket
carina call session.checkpoint.restore

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.checkpoint.restore","params":{"session_id":"sess_01J...","checkpoint_id":"<checkpoint_id>","confirmed":true}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.checkpoint.restore", "params": { "session_id": "sess_01J...", "checkpoint_id": "<checkpoint_id>", "confirmed": true } }

复制 JSON复制本地 CLI发送

#session.checkpoint.compactwrite控制面

参数

字段	类型
session_id	string
task_id	string? (paused task; defaults to latest paused task)

返回值

CheckpointCompactResult

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "session.checkpoint.compact",
  "params": {
    "session_id": "sess_01J...",
    "task_id": "Summarize module boundaries"
  }
}

// scope: write
const result = await client.request("session.checkpoint.compact", {
  "session_id": "sess_01J...",
  "task_id": "Summarize module boundaries"
});

# JSON-RPC over the local socket
carina call session.checkpoint.compact

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"session.checkpoint.compact","params":{"session_id":"sess_01J...","task_id":"Summarize module boundaries"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "session.checkpoint.compact", "params": { "session_id": "sess_01J...", "task_id": "Summarize module boundaries" } }

复制 JSON复制本地 CLI发送

Execution13

#execution.startwrite

参数

字段	类型
session_id	string
prompt	string
client_submission_id	string?
agent	string?
model	string?
reasoning_effort	string?
locale	en|zh|zh-Hant|ja|ko|es|fr?
token_budget	integer >= 0?
mode	background?
success_criteria	SuccessCheck[]?
output_schema	JSON Schema Draft 2020-12 object?
input_media_refs	MediaRef[]? max 4

返回值

ExecutionRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.start",
  "params": {
    "session_id": "sess_01J...",
    "prompt": "Summarize module boundaries",
    "token_budget": 1,
    "success_criteria": [],
    "input_media_refs": []
  }
}

// scope: write
const result = await client.request("execution.start", {
  "session_id": "sess_01J...",
  "prompt": "Summarize module boundaries",
  "token_budget": 1,
  "success_criteria": [],
  "input_media_refs": []
});

# JSON-RPC over the local socket
carina call execution.start

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.start","params":{"session_id":"sess_01J...","prompt":"Summarize module boundaries","token_budget":1,"success_criteria":[],"input_media_refs":[]}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.start", "params": { "session_id": "sess_01J...", "prompt": "Summarize module boundaries", "token_budget": 1 } }

复制 JSON复制本地 CLI发送

#execution.retrywrite

参数

字段	类型
run_id	string
client_submission_id	ASCII token 1-128
routing	original|current? (default original)
current_model	string? (required from current-route clients)
current_reasoning_effort	string?

返回值

ExecutionRun with retry_of_run_id; original run remains terminal

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.retry",
  "params": {
    "run_id": "<run_id>",
    "client_submission_id": "<client_submission_id>"
  }
}

// scope: write
const result = await client.request("execution.retry", {
  "run_id": "<run_id>",
  "client_submission_id": "<client_submission_id>"
});

# JSON-RPC over the local socket
carina call execution.retry

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.retry","params":{"run_id":"<run_id>","client_submission_id":"<client_submission_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.retry", "params": { "run_id": "<run_id>", "client_submission_id": "<client_submission_id>" } }

复制 JSON复制本地 CLI发送

#execution.resumewrite控制面

参数

字段	类型
run_id	string

返回值

ExecutionRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.resume",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: write
const result = await client.request("execution.resume", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call execution.resume

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.resume","params":{"run_id":"<run_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.resume", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#execution.statusread远程

参数

字段	类型
run_id	string

返回值

ExecutionRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.status",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: read
const result = await client.request("execution.status", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call execution.status

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.status","params":{"run_id":"<run_id>"}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.status", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#execution.listread远程

参数

字段	类型
session_id	string?

返回值

ExecutionRun[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.list",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("execution.list", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call execution.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.list","params":{"session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.list", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#execution.resultread远程

参数

字段	类型
run_id	string

返回值

ExecutionRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.result",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: read
const result = await client.request("execution.result", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call execution.result

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.result","params":{"run_id":"<run_id>"}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.result", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#execution.cancelwrite

参数

字段	类型
run_id	string

返回值

ExecutionRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.cancel",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: write
const result = await client.request("execution.cancel", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call execution.cancel

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.cancel","params":{"run_id":"<run_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.cancel", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#execution.interruptwrite

参数

字段	类型
run_id	string
mode	soft?

返回值

{ requested: boolean, already_requested: boolean, run_id: string, mode: soft, safe_point: next_turn_boundary, active_tool: boolean, queue_depth: integer }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.interrupt",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: write
const result = await client.request("execution.interrupt", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call execution.interrupt

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.interrupt","params":{"run_id":"<run_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.interrupt", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#execution.steerwrite

参数

字段	类型
run_id	string
message	string
priority	normal|urgent?
steer_id	string?

返回值

{ queued: boolean, run_id: string, status: string, priority: string, steer_id: string, queue_depth: integer, safe_point: next_turn_boundary }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.steer",
  "params": {
    "run_id": "<run_id>",
    "message": "<message>"
  }
}

// scope: write
const result = await client.request("execution.steer", {
  "run_id": "<run_id>",
  "message": "<message>"
});

# JSON-RPC over the local socket
carina call execution.steer

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.steer","params":{"run_id":"<run_id>","message":"<message>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.steer", "params": { "run_id": "<run_id>", "message": "<message>" } }

复制 JSON复制本地 CLI发送

#execution.queue.listread

参数

字段	类型
run_id	string
preview_cells	integer > 0?

返回值

{ run_id: string, queue_depth: integer, soft_interrupt_pending: boolean, items: { steer_id: string, priority: string, preview: string, index: integer }[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.queue.list",
  "params": {
    "run_id": "<run_id>",
    "preview_cells": 1
  }
}

// scope: read
const result = await client.request("execution.queue.list", {
  "run_id": "<run_id>",
  "preview_cells": 1
});

# JSON-RPC over the local socket
carina call execution.queue.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.queue.list","params":{"run_id":"<run_id>","preview_cells":1}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.queue.list", "params": { "run_id": "<run_id>", "preview_cells": 1 } }

复制 JSON复制本地 CLI发送

#execution.queue.dropwrite

参数

字段	类型
run_id	string
steer_id	string

返回值

{ run_id: string, steer_id: string, dropped: boolean, queue_depth: integer }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.queue.drop",
  "params": {
    "run_id": "<run_id>",
    "steer_id": "<steer_id>"
  }
}

// scope: write
const result = await client.request("execution.queue.drop", {
  "run_id": "<run_id>",
  "steer_id": "<steer_id>"
});

# JSON-RPC over the local socket
carina call execution.queue.drop

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.queue.drop","params":{"run_id":"<run_id>","steer_id":"<steer_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.queue.drop", "params": { "run_id": "<run_id>", "steer_id": "<steer_id>" } }

复制 JSON复制本地 CLI发送

#execution.budget.extendadmin控制面

参数

字段	类型
run_id	string
additional_tokens	integer > 0
approver	string?

返回值

ExecutionRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.budget.extend",
  "params": {
    "run_id": "<run_id>",
    "additional_tokens": 1
  }
}

// scope: admin
const result = await client.request("execution.budget.extend", {
  "run_id": "<run_id>",
  "additional_tokens": 1
});

# JSON-RPC over the local socket
carina call execution.budget.extend

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.budget.extend","params":{"run_id":"<run_id>","additional_tokens":1}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.budget.extend", "params": { "run_id": "<run_id>", "additional_tokens": 1 } }

复制 JSON复制本地 CLI发送

#execution.btwwrite

参数

字段	类型
run_id	string
question	string

返回值

{ answer: string, ephemeral: true }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "execution.btw",
  "params": {
    "run_id": "<run_id>",
    "question": "<question>"
  }
}

// scope: write
const result = await client.request("execution.btw", {
  "run_id": "<run_id>",
  "question": "<question>"
});

# JSON-RPC over the local socket
carina call execution.btw

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"execution.btw","params":{"run_id":"<run_id>","question":"<question>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "execution.btw", "params": { "run_id": "<run_id>", "question": "<question>" } }

复制 JSON复制本地 CLI发送

Governance3

#governance.action.approveadmin控制面

参数

字段	类型
session_id	string
decision_id	string
approver	string?
role	string?
scope	once|session|project?

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "governance.action.approve",
  "params": {
    "session_id": "sess_01J...",
    "decision_id": "<decision_id>"
  }
}

// scope: admin
const result = await client.request("governance.action.approve", {
  "session_id": "sess_01J...",
  "decision_id": "<decision_id>"
});

# JSON-RPC over the local socket
carina call governance.action.approve

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"governance.action.approve","params":{"session_id":"sess_01J...","decision_id":"<decision_id>"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "governance.action.approve", "params": { "session_id": "sess_01J...", "decision_id": "<decision_id>" } }

复制 JSON复制本地 CLI发送

#governance.action.denyadmin控制面

参数

字段	类型
session_id	string
decision_id	string
approver	string?
reason	string

返回值

PermissionDecision

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "governance.action.deny",
  "params": {
    "session_id": "sess_01J...",
    "decision_id": "<decision_id>",
    "reason": "<reason>"
  }
}

// scope: admin
const result = await client.request("governance.action.deny", {
  "session_id": "sess_01J...",
  "decision_id": "<decision_id>",
  "reason": "<reason>"
});

# JSON-RPC over the local socket
carina call governance.action.deny

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"governance.action.deny","params":{"session_id":"sess_01J...","decision_id":"<decision_id>","reason":"<reason>"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "governance.action.deny", "params": { "session_id": "sess_01J...", "decision_id": "<decision_id>", "reason": "<reason>" } }

复制 JSON复制本地 CLI发送

#governance.approval.resolveadmin控制面

参数

字段	类型
decision_id	string
approve	boolean
approver	string?
scope	once|session|project?

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "governance.approval.resolve",
  "params": {
    "decision_id": "<decision_id>",
    "approve": true
  }
}

// scope: admin
const result = await client.request("governance.approval.resolve", {
  "decision_id": "<decision_id>",
  "approve": true
});

# JSON-RPC over the local socket
carina call governance.approval.resolve

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"governance.approval.resolve","params":{"decision_id":"<decision_id>","approve":true}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "governance.approval.resolve", "params": { "decision_id": "<decision_id>", "approve": true } }

复制 JSON复制本地 CLI发送

Question2

#question.answerwrite

参数

字段	类型
question_id	string
value	string

返回值

{ question_id: string, accepted: boolean, value: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "question.answer",
  "params": {
    "question_id": "<question_id>",
    "value": "<value>"
  }
}

// scope: write
const result = await client.request("question.answer", {
  "question_id": "<question_id>",
  "value": "<value>"
});

# JSON-RPC over the local socket
carina call question.answer

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"question.answer","params":{"question_id":"<question_id>","value":"<value>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "question.answer", "params": { "question_id": "<question_id>", "value": "<value>" } }

复制 JSON复制本地 CLI发送

#question.pendingread

参数

{}

返回值

{ question_ids: string[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "question.pending",
  "params": {}
}

// scope: read
const result = await client.request("question.pending", {});

# JSON-RPC over the local socket
carina call question.pending

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"question.pending","params":{}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "question.pending", "params": {} }

复制 JSON复制本地 CLI发送

History1

#history.recentread

参数

字段	类型
limit	number?
scope	session|workspace|global?
session_id	string? (required for session/workspace scope)

返回值

{ entries: string[], count: number, scope: session|workspace|global }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "history.recent",
  "params": {
    "limit": 1,
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("history.recent", {
  "limit": 1,
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call history.recent

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"history.recent","params":{"limit":1,"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "history.recent", "params": { "limit": 1, "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

Memory12

#memory.readread

参数

字段	类型
session_id	string
target	memory|user?

返回值

MemoryRevisionRead

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.read",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("memory.read", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call memory.read

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.read","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.read", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#memory.listread

参数

字段	类型
session_id	string
target	memory|user?

返回值

MemoryState

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.list",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("memory.list", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call memory.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.list","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.list", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#memory.contextread

参数

字段	类型
session_id	string

返回值

{ scope: MemoryScope, context: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.context",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("memory.context", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call memory.context

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.context","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.context", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#memory.searchread

参数

字段	类型
session_id	string
query	string
target	memory|user?
limit	number?
mode	lexical|semantic|auto?
model	provider/model?

返回值

MemorySearchResult

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.search",
  "params": {
    "session_id": "sess_01J...",
    "query": "<query>",
    "limit": 1
  }
}

// scope: read
const result = await client.request("memory.search", {
  "session_id": "sess_01J...",
  "query": "<query>",
  "limit": 1
});

# JSON-RPC over the local socket
carina call memory.search

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.search","params":{"session_id":"sess_01J...","query":"<query>","limit":1}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.search", "params": { "session_id": "sess_01J...", "query": "<query>", "limit": 1 } }

复制 JSON复制本地 CLI发送

#memory.statusread

参数

字段	类型
session_id	string?

返回值

MemoryStatus

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.status",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("memory.status", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call memory.status

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.status","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.status", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#memory.writewrite控制面

参数

字段	类型
version	1?
session_id	string
target	memory|user?
action	add|replace|remove|batch
content	string?
old_text	string?
operations	MemoryOperation[]?
expected_revision	string?
idempotency_key	string?

返回值

MemoryRevisionWrite

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.write",
  "params": {
    "session_id": "sess_01J...",
    "action": "<action>",
    "operations": []
  }
}

// scope: write
const result = await client.request("memory.write", {
  "session_id": "sess_01J...",
  "action": "<action>",
  "operations": []
});

# JSON-RPC over the local socket
carina call memory.write

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.write","params":{"session_id":"sess_01J...","action":"<action>","operations":[]}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.write", "params": { "session_id": "sess_01J...", "action": "<action>" } }

复制 JSON复制本地 CLI发送

#memory.handoffwrite控制面

参数

字段	类型
source_session_id	string
target_session_id	string
target	memory|user
expected_revision	string?
idempotency_key	string

返回值

MemoryRevisionWrite|PermissionDecision

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.handoff",
  "params": {
    "source_session_id": "sess_01J...",
    "target_session_id": "sess_01J...",
    "target": "<target>",
    "idempotency_key": "<idempotency_key>"
  }
}

// scope: write
const result = await client.request("memory.handoff", {
  "source_session_id": "sess_01J...",
  "target_session_id": "sess_01J...",
  "target": "<target>",
  "idempotency_key": "<idempotency_key>"
});

# JSON-RPC over the local socket
carina call memory.handoff

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.handoff","params":{"source_session_id":"sess_01J...","target_session_id":"sess_01J...","target":"<target>","idempotency_key":"<idempotency_key>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.handoff", "params": { "source_session_id": "sess_01J...", "target_session_id": "sess_01J...", "target": "<target>", "idempotency_key": "<idempotency_key>" } }

复制 JSON复制本地 CLI发送

#memory.rollbackwrite控制面

参数

字段	类型
session_id	string
target	memory|user
revision	string
expected_revision	string
idempotency_key	string

返回值

MemoryRevisionWrite

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.rollback",
  "params": {
    "session_id": "sess_01J...",
    "target": "<target>",
    "revision": "<revision>",
    "expected_revision": "<expected_revision>",
    "idempotency_key": "<idempotency_key>"
  }
}

// scope: write
const result = await client.request("memory.rollback", {
  "session_id": "sess_01J...",
  "target": "<target>",
  "revision": "<revision>",
  "expected_revision": "<expected_revision>",
  "idempotency_key": "<idempotency_key>"
});

# JSON-RPC over the local socket
carina call memory.rollback

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.rollback","params":{"session_id":"sess_01J...","target":"<target>","revision":"<revision>","expected_revision":"<expected_revision>","idempotency_key":"<idempotency_key>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.rollback", "params": { "session_id": "sess_01J...", "target": "<target>", "revision": "<revision>", "expected_revision": "<expected_revision>", "idempotency_key": "<idempotency_key>" } }

复制 JSON复制本地 CLI发送

#memory.verifyread

参数

字段	类型
session_id	string
target	memory|user
revision	string?

返回值

MemoryVerificationProof

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.verify",
  "params": {
    "session_id": "sess_01J...",
    "target": "<target>"
  }
}

// scope: read
const result = await client.request("memory.verify", {
  "session_id": "sess_01J...",
  "target": "<target>"
});

# JSON-RPC over the local socket
carina call memory.verify

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.verify","params":{"session_id":"sess_01J...","target":"<target>"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.verify", "params": { "session_id": "sess_01J...", "target": "<target>" } }

复制 JSON复制本地 CLI发送

#memory.projection.authorizeadmin控制面

参数

字段	类型
session_id	string

返回值

{ projections: MemoryProjectionWriteResult[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.projection.authorize",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: admin
const result = await client.request("memory.projection.authorize", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call memory.projection.authorize

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.projection.authorize","params":{"session_id":"sess_01J..."}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.projection.authorize", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#memory.projection.reseedadmin控制面

参数

字段	类型
session_id	string
document_id	string
remote_quiesced	boolean

返回值

{ document_id: string, status: blocked, requires_authorization: true, remote_state_known: false }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.projection.reseed",
  "params": {
    "session_id": "sess_01J...",
    "document_id": "<document_id>",
    "remote_quiesced": true
  }
}

// scope: admin
const result = await client.request("memory.projection.reseed", {
  "session_id": "sess_01J...",
  "document_id": "<document_id>",
  "remote_quiesced": true
});

# JSON-RPC over the local socket
carina call memory.projection.reseed

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.projection.reseed","params":{"session_id":"sess_01J...","document_id":"<document_id>","remote_quiesced":true}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.projection.reseed", "params": { "session_id": "sess_01J...", "document_id": "<document_id>", "remote_quiesced": true } }

复制 JSON复制本地 CLI发送

#memory.projection.retryadmin控制面

参数

字段	类型
session_id	string
document_id	string

返回值

{ document_id: string, status: blocked, attempts: number, previous_error_code: string, requires_authorization: true }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "memory.projection.retry",
  "params": {
    "session_id": "sess_01J...",
    "document_id": "<document_id>"
  }
}

// scope: admin
const result = await client.request("memory.projection.retry", {
  "session_id": "sess_01J...",
  "document_id": "<document_id>"
});

# JSON-RPC over the local socket
carina call memory.projection.retry

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"memory.projection.retry","params":{"session_id":"sess_01J...","document_id":"<document_id>"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "memory.projection.retry", "params": { "session_id": "sess_01J...", "document_id": "<document_id>" } }

复制 JSON复制本地 CLI发送

Schedule5

#schedule.createwrite控制面

参数

字段	类型
session_id	string
prompt	string
kind	at|every|cron
expression	string
model	string?
reasoning_effort	string?
agent	string?
mode	background?
concurrency_policy	forbid|queue|replace|allow?

返回值

Schedule

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "schedule.create",
  "params": {
    "session_id": "sess_01J...",
    "prompt": "Summarize module boundaries",
    "kind": "<kind>",
    "expression": "<expression>"
  }
}

// scope: write
const result = await client.request("schedule.create", {
  "session_id": "sess_01J...",
  "prompt": "Summarize module boundaries",
  "kind": "<kind>",
  "expression": "<expression>"
});

# JSON-RPC over the local socket
carina call schedule.create

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"schedule.create","params":{"session_id":"sess_01J...","prompt":"Summarize module boundaries","kind":"<kind>","expression":"<expression>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "schedule.create", "params": { "session_id": "sess_01J...", "prompt": "Summarize module boundaries", "kind": "<kind>", "expression": "<expression>" } }

复制 JSON复制本地 CLI发送

#schedule.listread

参数

字段	类型
session_id	string

返回值

{ schedules: Schedule[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "schedule.list",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("schedule.list", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call schedule.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"schedule.list","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "schedule.list", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#schedule.pausewrite控制面

参数

字段	类型
session_id	string
schedule_id	string

返回值

Schedule

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "schedule.pause",
  "params": {
    "session_id": "sess_01J...",
    "schedule_id": "<schedule_id>"
  }
}

// scope: write
const result = await client.request("schedule.pause", {
  "session_id": "sess_01J...",
  "schedule_id": "<schedule_id>"
});

# JSON-RPC over the local socket
carina call schedule.pause

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"schedule.pause","params":{"session_id":"sess_01J...","schedule_id":"<schedule_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "schedule.pause", "params": { "session_id": "sess_01J...", "schedule_id": "<schedule_id>" } }

复制 JSON复制本地 CLI发送

#schedule.resumewrite控制面

参数

字段	类型
session_id	string
schedule_id	string

返回值

Schedule

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "schedule.resume",
  "params": {
    "session_id": "sess_01J...",
    "schedule_id": "<schedule_id>"
  }
}

// scope: write
const result = await client.request("schedule.resume", {
  "session_id": "sess_01J...",
  "schedule_id": "<schedule_id>"
});

# JSON-RPC over the local socket
carina call schedule.resume

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"schedule.resume","params":{"session_id":"sess_01J...","schedule_id":"<schedule_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "schedule.resume", "params": { "session_id": "sess_01J...", "schedule_id": "<schedule_id>" } }

复制 JSON复制本地 CLI发送

#schedule.deletewrite控制面

参数

字段	类型
session_id	string
schedule_id	string

返回值

{ deleted: boolean, schedule_id: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "schedule.delete",
  "params": {
    "session_id": "sess_01J...",
    "schedule_id": "<schedule_id>"
  }
}

// scope: write
const result = await client.request("schedule.delete", {
  "session_id": "sess_01J...",
  "schedule_id": "<schedule_id>"
});

# JSON-RPC over the local socket
carina call schedule.delete

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"schedule.delete","params":{"session_id":"sess_01J...","schedule_id":"<schedule_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "schedule.delete", "params": { "session_id": "sess_01J...", "schedule_id": "<schedule_id>" } }

复制 JSON复制本地 CLI发送

Goal7

#goal.getread

参数

字段	类型
session_id	string

返回值

{ goal: SessionGoal? }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "goal.get",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("goal.get", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call goal.get

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"goal.get","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "goal.get", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#goal.setwrite控制面

参数

字段	类型
session_id	string
objective	string
status	active|paused|blocked|budget_limited|usage_limited|complete?
token_budget	integer >= 0?
max_continuations	integer 1..32?
success_criteria	SuccessCheck[]?
auto_continue	boolean? default false

返回值

SessionGoal

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "goal.set",
  "params": {
    "session_id": "sess_01J...",
    "objective": "<objective>",
    "token_budget": 1,
    "max_continuations": 1,
    "success_criteria": [],
    "auto_continue": true
  }
}

// scope: write
const result = await client.request("goal.set", {
  "session_id": "sess_01J...",
  "objective": "<objective>",
  "token_budget": 1,
  "max_continuations": 1,
  "success_criteria": [],
  "auto_continue": true
});

# JSON-RPC over the local socket
carina call goal.set

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"goal.set","params":{"session_id":"sess_01J...","objective":"<objective>","token_budget":1,"max_continuations":1,"success_criteria":[],"auto_continue":true}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "goal.set", "params": { "session_id": "sess_01J...", "objective": "<objective>", "token_budget": 1, "max_continuations": 1, "auto_continue": true } }

复制 JSON复制本地 CLI发送

#goal.clearwrite控制面

参数

字段	类型
session_id	string

返回值

{ cleared: boolean, session_id: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "goal.clear",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("goal.clear", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call goal.clear

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"goal.clear","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "goal.clear", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#goal.pausewrite控制面

参数

字段	类型
session_id	string

返回值

SessionGoal

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "goal.pause",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("goal.pause", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call goal.pause

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"goal.pause","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "goal.pause", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#goal.resumewrite控制面

参数

字段	类型
session_id	string

返回值

SessionGoal

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "goal.resume",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("goal.resume", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call goal.resume

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"goal.resume","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "goal.resume", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#goal.completewrite控制面

参数

字段	类型
session_id	string

返回值

SessionGoal

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "goal.complete",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("goal.complete", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call goal.complete

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"goal.complete","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "goal.complete", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#goal.continuewrite控制面

参数

字段	类型
session_id	string

返回值

Task

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "goal.continue",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: write
const result = await client.request("goal.continue", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call goal.continue

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"goal.continue","params":{"session_id":"sess_01J..."}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "goal.continue", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

Workflow8

#workflow.runwrite控制面

参数

字段	类型
session_id	string
workflow	string
input	string?

返回值

WorkflowRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workflow.run",
  "params": {
    "session_id": "sess_01J...",
    "workflow": "<workflow>"
  }
}

// scope: write
const result = await client.request("workflow.run", {
  "session_id": "sess_01J...",
  "workflow": "<workflow>"
});

# JSON-RPC over the local socket
carina call workflow.run

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workflow.run","params":{"session_id":"sess_01J...","workflow":"<workflow>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workflow.run", "params": { "session_id": "sess_01J...", "workflow": "<workflow>" } }

复制 JSON复制本地 CLI发送

#workflow.listread远程

参数

{}

返回值

WorkflowRun[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workflow.list",
  "params": {}
}

// scope: read
const result = await client.request("workflow.list", {});

# JSON-RPC over the local socket
carina call workflow.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workflow.list","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workflow.list", "params": {} }

复制 JSON复制本地 CLI发送

#workflow.detailread远程

参数

字段	类型
run_id	string

返回值

WorkflowRunDetail

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workflow.detail",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: read
const result = await client.request("workflow.detail", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call workflow.detail

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workflow.detail","params":{"run_id":"<run_id>"}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workflow.detail", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#workflow.pausewrite控制面

参数

字段	类型
run_id	string

返回值

WorkflowRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workflow.pause",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: write
const result = await client.request("workflow.pause", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call workflow.pause

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workflow.pause","params":{"run_id":"<run_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workflow.pause", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#workflow.resumewrite控制面

参数

字段	类型
run_id	string

返回值

WorkflowRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workflow.resume",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: write
const result = await client.request("workflow.resume", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call workflow.resume

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workflow.resume","params":{"run_id":"<run_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workflow.resume", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#workflow.stopwrite控制面

参数

字段	类型
run_id	string

返回值

WorkflowRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workflow.stop",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: write
const result = await client.request("workflow.stop", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call workflow.stop

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workflow.stop","params":{"run_id":"<run_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workflow.stop", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#workflow.restartwrite控制面

参数

字段	类型
run_id	string

返回值

WorkflowRun

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workflow.restart",
  "params": {
    "run_id": "<run_id>"
  }
}

// scope: write
const result = await client.request("workflow.restart", {
  "run_id": "<run_id>"
});

# JSON-RPC over the local socket
carina call workflow.restart

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workflow.restart","params":{"run_id":"<run_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workflow.restart", "params": { "run_id": "<run_id>" } }

复制 JSON复制本地 CLI发送

#workflow.savewrite控制面

参数

字段	类型
run_id	string
name	string

返回值

{ path: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workflow.save",
  "params": {
    "run_id": "<run_id>",
    "name": "<name>"
  }
}

// scope: write
const result = await client.request("workflow.save", {
  "run_id": "<run_id>",
  "name": "<name>"
});

# JSON-RPC over the local socket
carina call workflow.save

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workflow.save","params":{"run_id":"<run_id>","name":"<name>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workflow.save", "params": { "run_id": "<run_id>", "name": "<name>" } }

复制 JSON复制本地 CLI发送

Channel5

#channel.sender.registeradmin控制面

参数

字段	类型
id	string
secret_env	CARINA_CHANNEL_*
sessions	string[]
kinds	string[]
can_relay_permission	boolean?

返回值

{ registered: boolean, sender_id: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "channel.sender.register",
  "params": {
    "id": "<id>",
    "secret_env": "<secret_env>",
    "sessions": "sess_01J...",
    "kinds": [],
    "can_relay_permission": true
  }
}

// scope: admin
const result = await client.request("channel.sender.register", {
  "id": "<id>",
  "secret_env": "<secret_env>",
  "sessions": "sess_01J...",
  "kinds": [],
  "can_relay_permission": true
});

# JSON-RPC over the local socket
carina call channel.sender.register

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"channel.sender.register","params":{"id":"<id>","secret_env":"<secret_env>","sessions":"sess_01J...","kinds":[],"can_relay_permission":true}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "channel.sender.register", "params": { "id": "<id>", "secret_env": "<secret_env>", "sessions": "sess_01J...", "kinds": "<kinds>", "can_relay_permission": true } }

复制 JSON复制本地 CLI发送

#channel.sender.listadmin

参数

{}

返回值

ChannelSender[] (secrets omitted)

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "channel.sender.list",
  "params": {}
}

// scope: admin
const result = await client.request("channel.sender.list", {});

# JSON-RPC over the local socket
carina call channel.sender.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"channel.sender.list","params":{}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "channel.sender.list", "params": {} }

复制 JSON复制本地 CLI发送

#channel.event.injectadmin远程控制面

参数

字段	类型
event	ChannelEvent
signature	hex-hmac-sha256

返回值

ChannelReceipt

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "channel.event.inject",
  "params": {
    "event": "<event>",
    "signature": "<signature>"
  }
}

// scope: admin
const result = await client.request("channel.event.inject", {
  "event": "<event>",
  "signature": "<signature>"
});

# JSON-RPC over the local socket
carina call channel.event.inject

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"channel.event.inject","params":{"event":"<event>","signature":"<signature>"}}

请求演练

admin

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "channel.event.inject", "params": { "event": "<event>", "signature": "<signature>" } }

复制 JSON复制本地 CLI发送

#channel.event.pendingadmin

参数

{}

返回值

{ incidents: ChannelIncident[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "channel.event.pending",
  "params": {}
}

// scope: admin
const result = await client.request("channel.event.pending", {});

# JSON-RPC over the local socket
carina call channel.event.pending

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"channel.event.pending","params":{}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "channel.event.pending", "params": {} }

复制 JSON复制本地 CLI发送

#channel.event.reconcileadmin控制面

参数

字段	类型
sender_id	string
event_id	string
outcome	executed|not_executed
confirmed	boolean

返回值

ChannelReconcileResult

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "channel.event.reconcile",
  "params": {
    "sender_id": "<sender_id>",
    "event_id": "<event_id>",
    "outcome": "<outcome>",
    "confirmed": true
  }
}

// scope: admin
const result = await client.request("channel.event.reconcile", {
  "sender_id": "<sender_id>",
  "event_id": "<event_id>",
  "outcome": "<outcome>",
  "confirmed": true
});

# JSON-RPC over the local socket
carina call channel.event.reconcile

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"channel.event.reconcile","params":{"sender_id":"<sender_id>","event_id":"<event_id>","outcome":"<outcome>","confirmed":true}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "channel.event.reconcile", "params": { "sender_id": "<sender_id>", "event_id": "<event_id>", "outcome": "<outcome>", "confirmed": true } }

复制 JSON复制本地 CLI发送

Extension6

#extension.installadmin控制面

参数

字段	类型
source	trusted local directory

返回值

InstalledExtension

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "extension.install",
  "params": {
    "source": "<source>"
  }
}

// scope: admin
const result = await client.request("extension.install", {
  "source": "<source>"
});

# JSON-RPC over the local socket
carina call extension.install

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"extension.install","params":{"source":"<source>"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "extension.install", "params": { "source": "<source>" } }

复制 JSON复制本地 CLI发送

#extension.listread

参数

字段	类型
workspace_root	string? absolute path; when present, project-tier disables from <workspace_root>/.carina/extensions.json are merged into effective_enabled per request (disable-only, never persisted)

返回值

ExtensionInventory

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "extension.list",
  "params": {
    "workspace_root": "/repo"
  }
}

// scope: read
const result = await client.request("extension.list", {
  "workspace_root": "/repo"
});

# JSON-RPC over the local socket
carina call extension.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"extension.list","params":{"workspace_root":"/repo"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "extension.list", "params": { "workspace_root": "/repo" } }

复制 JSON复制本地 CLI发送

#extension.enableadmin控制面

参数

字段	类型
name	string

返回值

InstalledExtension

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "extension.enable",
  "params": {
    "name": "<name>"
  }
}

// scope: admin
const result = await client.request("extension.enable", {
  "name": "<name>"
});

# JSON-RPC over the local socket
carina call extension.enable

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"extension.enable","params":{"name":"<name>"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "extension.enable", "params": { "name": "<name>" } }

复制 JSON复制本地 CLI发送

#extension.disableadmin控制面

参数

字段	类型
name	string

返回值

InstalledExtension

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "extension.disable",
  "params": {
    "name": "<name>"
  }
}

// scope: admin
const result = await client.request("extension.disable", {
  "name": "<name>"
});

# JSON-RPC over the local socket
carina call extension.disable

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"extension.disable","params":{"name":"<name>"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "extension.disable", "params": { "name": "<name>" } }

复制 JSON复制本地 CLI发送

#extension.updateadmin控制面

参数

字段	类型
name	string

返回值

InstalledExtension

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "extension.update",
  "params": {
    "name": "<name>"
  }
}

// scope: admin
const result = await client.request("extension.update", {
  "name": "<name>"
});

# JSON-RPC over the local socket
carina call extension.update

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"extension.update","params":{"name":"<name>"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "extension.update", "params": { "name": "<name>" } }

复制 JSON复制本地 CLI发送

#extension.safe_modeadmin控制面

参数

字段	类型
on	boolean

返回值

ExtensionInventory

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "extension.safe_mode",
  "params": {
    "on": true
  }
}

// scope: admin
const result = await client.request("extension.safe_mode", {
  "on": true
});

# JSON-RPC over the local socket
carina call extension.safe_mode

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"extension.safe_mode","params":{"on":true}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "extension.safe_mode", "params": { "on": true } }

复制 JSON复制本地 CLI发送

Telemetry1

#telemetry.statusread远程

参数

{}

返回值

{ enabled: boolean, format: carina-telemetry-json-v1, otlp: false }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "telemetry.status",
  "params": {}
}

// scope: read
const result = await client.request("telemetry.status", {});

# JSON-RPC over the local socket
carina call telemetry.status

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"telemetry.status","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "telemetry.status", "params": {} }

复制 JSON复制本地 CLI发送

Artifact3

#artifact.statread

参数

字段	类型
session_id	string
run_id	string?
call_id	string?
artifact_id	sha256

返回值

ArtifactMetadata

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "artifact.stat",
  "params": {
    "session_id": "sess_01J...",
    "artifact_id": "<artifact_id>"
  }
}

// scope: read
const result = await client.request("artifact.stat", {
  "session_id": "sess_01J...",
  "artifact_id": "<artifact_id>"
});

# JSON-RPC over the local socket
carina call artifact.stat

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"artifact.stat","params":{"session_id":"sess_01J...","artifact_id":"<artifact_id>"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "artifact.stat", "params": { "session_id": "sess_01J...", "artifact_id": "<artifact_id>" } }

复制 JSON复制本地 CLI发送

#artifact.readread

参数

字段	类型
session_id	string
run_id	string?
call_id	string?
artifact_id	sha256
offset	integer? >= 0
limit	integer? 0..1048576

返回值

{ metadata: ArtifactMetadata, offset: integer, next_offset: integer, eof: boolean, content_base64: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "artifact.read",
  "params": {
    "session_id": "sess_01J...",
    "artifact_id": "<artifact_id>",
    "offset": 1,
    "limit": 1
  }
}

// scope: read
const result = await client.request("artifact.read", {
  "session_id": "sess_01J...",
  "artifact_id": "<artifact_id>",
  "offset": 1,
  "limit": 1
});

# JSON-RPC over the local socket
carina call artifact.read

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"artifact.read","params":{"session_id":"sess_01J...","artifact_id":"<artifact_id>","offset":1,"limit":1}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "artifact.read", "params": { "session_id": "sess_01J...", "artifact_id": "<artifact_id>", "offset": 1, "limit": 1 } }

复制 JSON复制本地 CLI发送

#artifact.uploadwrite

参数

字段	类型
session_id	string
upload_id	string
chunk_index	integer >= 0
content_base64	base64 <= 524288 decoded bytes
final	boolean
sha256	sha256
total_bytes	integer 1..4194304
media_type	image/png|image/jpeg|image/gif|image/webp
origin	string

返回值

MediaRef on final chunk; upload receipt otherwise

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "artifact.upload",
  "params": {
    "session_id": "sess_01J...",
    "upload_id": "<upload_id>",
    "chunk_index": 1,
    "content_base64": "<content_base64>",
    "final": true,
    "sha256": "<sha256>",
    "total_bytes": 1,
    "media_type": "<media_type>",
    "origin": "<origin>"
  }
}

// scope: write
const result = await client.request("artifact.upload", {
  "session_id": "sess_01J...",
  "upload_id": "<upload_id>",
  "chunk_index": 1,
  "content_base64": "<content_base64>",
  "final": true,
  "sha256": "<sha256>",
  "total_bytes": 1,
  "media_type": "<media_type>",
  "origin": "<origin>"
});

# JSON-RPC over the local socket
carina call artifact.upload

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"artifact.upload","params":{"session_id":"sess_01J...","upload_id":"<upload_id>","chunk_index":1,"content_base64":"<content_base64>","final":true,"sha256":"<sha256>","total_bytes":1,"media_type":"<media_type>","origin":"<origin>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "artifact.upload", "params": { "session_id": "sess_01J...", "upload_id": "<upload_id>", "chunk_index": 1, "content_base64": "<content_base64>", "final": true, "sha256": "<sha256>", "total_bytes": 1, "media_type": "<media_type>", "origin": "<origin>" } }

复制 JSON复制本地 CLI发送

Context5

#context.statusread

参数

{}

返回值

ContextEngineStatus

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "context.status",
  "params": {}
}

// scope: read
const result = await client.request("context.status", {});

# JSON-RPC over the local socket
carina call context.status

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"context.status","params":{}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "context.status", "params": {} }

复制 JSON复制本地 CLI发送

#context.doctorread

参数

{}

返回值

{ ok: boolean, status: ContextEngineStatus }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "context.doctor",
  "params": {}
}

// scope: read
const result = await client.request("context.doctor", {});

# JSON-RPC over the local socket
carina call context.doctor

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"context.doctor","params":{}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "context.doctor", "params": {} }

复制 JSON复制本地 CLI发送

#context.statsread

参数

{}

返回值

ContextEngineStats

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "context.stats",
  "params": {}
}

// scope: read
const result = await client.request("context.stats", {});

# JSON-RPC over the local socket
carina call context.stats

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"context.stats","params":{}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "context.stats", "params": {} }

复制 JSON复制本地 CLI发送

#context.summaryread

参数

字段	类型
session_id	string

返回值

ContextSummary

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "context.summary",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("context.summary", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call context.summary

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"context.summary","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "context.summary", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#context.compresswrite

参数

字段	类型
content	string
session_id	string?
task_id	string?
turn	number?
kind	string?
tool	string?
pinned	boolean?

返回值

ContextCompressResponse

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "context.compress",
  "params": {
    "content": "<content>",
    "session_id": "sess_01J...",
    "task_id": "Summarize module boundaries",
    "turn": 1,
    "pinned": true
  }
}

// scope: write
const result = await client.request("context.compress", {
  "content": "<content>",
  "session_id": "sess_01J...",
  "task_id": "Summarize module boundaries",
  "turn": 1,
  "pinned": true
});

# JSON-RPC over the local socket
carina call context.compress

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"context.compress","params":{"content":"<content>","session_id":"sess_01J...","task_id":"Summarize module boundaries","turn":1,"pinned":true}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "context.compress", "params": { "content": "<content>", "session_id": "sess_01J...", "task_id": "Summarize module boundaries", "turn": 1, "pinned": true } }

复制 JSON复制本地 CLI发送

Workspace18

#worktree.createwrite控制面

参数

字段	类型
id	string
repo_root	string
base_ref	string?
branch	string?
owner	string?

返回值

Worktree

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worktree.create",
  "params": {
    "id": "<id>",
    "repo_root": "/repo"
  }
}

// scope: write
const result = await client.request("worktree.create", {
  "id": "<id>",
  "repo_root": "/repo"
});

# JSON-RPC over the local socket
carina call worktree.create

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worktree.create","params":{"id":"<id>","repo_root":"/repo"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worktree.create", "params": { "id": "<id>", "repo_root": "/repo" } }

复制 JSON复制本地 CLI发送

#worktree.listread

参数

{}

返回值

Worktree[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worktree.list",
  "params": {}
}

// scope: read
const result = await client.request("worktree.list", {});

# JSON-RPC over the local socket
carina call worktree.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worktree.list","params":{}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worktree.list", "params": {} }

复制 JSON复制本地 CLI发送

#worktree.enterwrite控制面

参数

字段	类型
id	string
owner	string

返回值

Worktree

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worktree.enter",
  "params": {
    "id": "<id>",
    "owner": "<owner>"
  }
}

// scope: write
const result = await client.request("worktree.enter", {
  "id": "<id>",
  "owner": "<owner>"
});

# JSON-RPC over the local socket
carina call worktree.enter

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worktree.enter","params":{"id":"<id>","owner":"<owner>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worktree.enter", "params": { "id": "<id>", "owner": "<owner>" } }

复制 JSON复制本地 CLI发送

#worktree.lockwrite控制面

参数

字段	类型
id	string
owner	string

返回值

Worktree

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worktree.lock",
  "params": {
    "id": "<id>",
    "owner": "<owner>"
  }
}

// scope: write
const result = await client.request("worktree.lock", {
  "id": "<id>",
  "owner": "<owner>"
});

# JSON-RPC over the local socket
carina call worktree.lock

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worktree.lock","params":{"id":"<id>","owner":"<owner>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worktree.lock", "params": { "id": "<id>", "owner": "<owner>" } }

复制 JSON复制本地 CLI发送

#worktree.unlockwrite控制面

参数

字段	类型
id	string
owner	string

返回值

Worktree

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worktree.unlock",
  "params": {
    "id": "<id>",
    "owner": "<owner>"
  }
}

// scope: write
const result = await client.request("worktree.unlock", {
  "id": "<id>",
  "owner": "<owner>"
});

# JSON-RPC over the local socket
carina call worktree.unlock

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worktree.unlock","params":{"id":"<id>","owner":"<owner>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worktree.unlock", "params": { "id": "<id>", "owner": "<owner>" } }

复制 JSON复制本地 CLI发送

#worktree.cleanupwrite控制面

参数

字段	类型
id	string
owner	string
force	boolean?

返回值

{ removed: boolean, id: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worktree.cleanup",
  "params": {
    "id": "<id>",
    "owner": "<owner>",
    "force": true
  }
}

// scope: write
const result = await client.request("worktree.cleanup", {
  "id": "<id>",
  "owner": "<owner>",
  "force": true
});

# JSON-RPC over the local socket
carina call worktree.cleanup

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worktree.cleanup","params":{"id":"<id>","owner":"<owner>","force":true}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worktree.cleanup", "params": { "id": "<id>", "owner": "<owner>", "force": true } }

复制 JSON复制本地 CLI发送

#workspace.treeread

参数

字段	类型
session_id	string
max_depth	number?

返回值

TreeNode[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.tree",
  "params": {
    "session_id": "sess_01J...",
    "max_depth": 1
  }
}

// scope: read
const result = await client.request("workspace.tree", {
  "session_id": "sess_01J...",
  "max_depth": 1
});

# JSON-RPC over the local socket
carina call workspace.tree

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.tree","params":{"session_id":"sess_01J...","max_depth":1}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.tree", "params": { "session_id": "sess_01J...", "max_depth": 1 } }

复制 JSON复制本地 CLI发送

#workspace.diffread

参数

字段	类型
session_id	string

返回值

WorkspaceDiffResponse

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.diff",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("workspace.diff", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call workspace.diff

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.diff","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.diff", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#workspace.searchread

参数

字段	类型
session_id	string
pattern	string
glob	string?

返回值

Match[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.search",
  "params": {
    "session_id": "sess_01J...",
    "pattern": "<pattern>"
  }
}

// scope: read
const result = await client.request("workspace.search", {
  "session_id": "sess_01J...",
  "pattern": "<pattern>"
});

# JSON-RPC over the local socket
carina call workspace.search

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.search","params":{"session_id":"sess_01J...","pattern":"<pattern>"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.search", "params": { "session_id": "sess_01J...", "pattern": "<pattern>" } }

复制 JSON复制本地 CLI发送

#workspace.file.getread

参数

字段	类型
session_id	string
path	clean workspace-relative string

返回值

{ content: UTF-8 text <= 1 MiB, hash: sha256 string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.file.get",
  "params": {
    "session_id": "sess_01J...",
    "path": "/repo"
  }
}

// scope: read
const result = await client.request("workspace.file.get", {
  "session_id": "sess_01J...",
  "path": "/repo"
});

# JSON-RPC over the local socket
carina call workspace.file.get

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.file.get","params":{"session_id":"sess_01J...","path":"/repo"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.file.get", "params": { "session_id": "sess_01J...", "path": "/repo" } }

复制 JSON复制本地 CLI发送

#workspace.trustadmin控制面

参数

字段	类型
session_id	string
trusted	boolean

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.trust",
  "params": {
    "session_id": "sess_01J...",
    "trusted": true
  }
}

// scope: admin
const result = await client.request("workspace.trust", {
  "session_id": "sess_01J...",
  "trusted": true
});

# JSON-RPC over the local socket
carina call workspace.trust

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.trust","params":{"session_id":"sess_01J...","trusted":true}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.trust", "params": { "session_id": "sess_01J...", "trusted": true } }

复制 JSON复制本地 CLI发送

#workspace.patch.proposewrite

参数

字段	类型
session_id	string
diff	string?
files	PatchFile[]?
reason	string?

返回值

PatchTransaction

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.patch.propose",
  "params": {
    "session_id": "sess_01J...",
    "files": []
  }
}

// scope: write
const result = await client.request("workspace.patch.propose", {
  "session_id": "sess_01J...",
  "files": []
});

# JSON-RPC over the local socket
carina call workspace.patch.propose

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.patch.propose","params":{"session_id":"sess_01J...","files":[]}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.patch.propose", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#workspace.patch.applywrite

参数

字段	类型
session_id	string?
patch_id	string

返回值

PatchTransaction

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.patch.apply",
  "params": {
    "session_id": "sess_01J...",
    "patch_id": "<patch_id>"
  }
}

// scope: write
const result = await client.request("workspace.patch.apply", {
  "session_id": "sess_01J...",
  "patch_id": "<patch_id>"
});

# JSON-RPC over the local socket
carina call workspace.patch.apply

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.patch.apply","params":{"session_id":"sess_01J...","patch_id":"<patch_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.patch.apply", "params": { "session_id": "sess_01J...", "patch_id": "<patch_id>" } }

复制 JSON复制本地 CLI发送

#workspace.patch.verifywrite

参数

字段	类型
session_id	string
patch_id	string

返回值

PatchTransaction

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.patch.verify",
  "params": {
    "session_id": "sess_01J...",
    "patch_id": "<patch_id>"
  }
}

// scope: write
const result = await client.request("workspace.patch.verify", {
  "session_id": "sess_01J...",
  "patch_id": "<patch_id>"
});

# JSON-RPC over the local socket
carina call workspace.patch.verify

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.patch.verify","params":{"session_id":"sess_01J...","patch_id":"<patch_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.patch.verify", "params": { "session_id": "sess_01J...", "patch_id": "<patch_id>" } }

复制 JSON复制本地 CLI发送

#workspace.patch.rollback.previewread

参数

字段	类型
session_id	string
patch_id	string

返回值

PatchRollbackPreview

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.patch.rollback.preview",
  "params": {
    "session_id": "sess_01J...",
    "patch_id": "<patch_id>"
  }
}

// scope: read
const result = await client.request("workspace.patch.rollback.preview", {
  "session_id": "sess_01J...",
  "patch_id": "<patch_id>"
});

# JSON-RPC over the local socket
carina call workspace.patch.rollback.preview

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.patch.rollback.preview","params":{"session_id":"sess_01J...","patch_id":"<patch_id>"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.patch.rollback.preview", "params": { "session_id": "sess_01J...", "patch_id": "<patch_id>" } }

复制 JSON复制本地 CLI发送

#workspace.patch.rollbackwrite

参数

字段	类型
session_id	string?
patch_id	string

返回值

PatchTransaction

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.patch.rollback",
  "params": {
    "session_id": "sess_01J...",
    "patch_id": "<patch_id>"
  }
}

// scope: write
const result = await client.request("workspace.patch.rollback", {
  "session_id": "sess_01J...",
  "patch_id": "<patch_id>"
});

# JSON-RPC over the local socket
carina call workspace.patch.rollback

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.patch.rollback","params":{"session_id":"sess_01J...","patch_id":"<patch_id>"}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.patch.rollback", "params": { "session_id": "sess_01J...", "patch_id": "<patch_id>" } }

复制 JSON复制本地 CLI发送

#workspace.patch.listread

参数

字段	类型
session_id	string

返回值

PatchTransaction[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.patch.list",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("workspace.patch.list", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call workspace.patch.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.patch.list","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.patch.list", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#workspace.patch.showread

参数

字段	类型
session_id	string
patch_id	string

返回值

PatchTransaction

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "workspace.patch.show",
  "params": {
    "session_id": "sess_01J...",
    "patch_id": "<patch_id>"
  }
}

// scope: read
const result = await client.request("workspace.patch.show", {
  "session_id": "sess_01J...",
  "patch_id": "<patch_id>"
});

# JSON-RPC over the local socket
carina call workspace.patch.show

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"workspace.patch.show","params":{"session_id":"sess_01J...","patch_id":"<patch_id>"}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "workspace.patch.show", "params": { "session_id": "sess_01J...", "patch_id": "<patch_id>" } }

复制 JSON复制本地 CLI发送

Mcp1

#mcp.inventoryread

参数

字段	类型
verbose	boolean?

返回值

{ servers: MCPInventoryServer[], count: integer } (secret-free; private servers omitted)

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "mcp.inventory",
  "params": {
    "verbose": true
  }
}

// scope: read
const result = await client.request("mcp.inventory", {
  "verbose": true
});

# JSON-RPC over the local socket
carina call mcp.inventory

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"mcp.inventory","params":{"verbose":true}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "mcp.inventory", "params": { "verbose": true } }

复制 JSON复制本地 CLI发送

Command2

#command.listread远程

参数

字段	类型
session_id	string?
workspace_root	string?

返回值

{ revision: string, commands: Command[] }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "command.list",
  "params": {
    "session_id": "sess_01J...",
    "workspace_root": "/repo"
  }
}

// scope: read
const result = await client.request("command.list", {
  "session_id": "sess_01J...",
  "workspace_root": "/repo"
});

# JSON-RPC over the local socket
carina call command.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"command.list","params":{"session_id":"sess_01J...","workspace_root":"/repo"}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "command.list", "params": { "session_id": "sess_01J...", "workspace_root": "/repo" } }

复制 JSON复制本地 CLI发送

#command.execwrite

参数

字段	类型
session_id	string
task_id	string?
argv	string[]

返回值

{ decision: PermissionDecision, result: CommandResult? }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "command.exec",
  "params": {
    "session_id": "sess_01J...",
    "task_id": "Summarize module boundaries",
    "argv": []
  }
}

// scope: write
const result = await client.request("command.exec", {
  "session_id": "sess_01J...",
  "task_id": "Summarize module boundaries",
  "argv": []
});

# JSON-RPC over the local socket
carina call command.exec

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"command.exec","params":{"session_id":"sess_01J...","task_id":"Summarize module boundaries","argv":[]}}

请求演练

write

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "command.exec", "params": { "session_id": "sess_01J...", "task_id": "Summarize module boundaries", "argv": "<argv>" } }

复制 JSON复制本地 CLI发送

Audit3

#audit.reportread远程

参数

字段	类型
session_id	string

返回值

AuditReport

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audit.report",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("audit.report", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call audit.report

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"audit.report","params":{"session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "audit.report", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#audit.exportread远程

参数

字段	类型
session_id	string
format	jsonl|sqlite?

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audit.export",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("audit.export", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call audit.export

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"audit.export","params":{"session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "audit.export", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#audit.verifyread远程

参数

字段	类型
session_id	string

返回值

AuditVerification

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audit.verify",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("audit.verify", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call audit.verify

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"audit.verify","params":{"session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "audit.verify", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

Profile2

#profile.describeread远程

参数

字段	类型
profile	string?
session_id	string?

返回值

PermissionProfile

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "profile.describe",
  "params": {
    "profile": "safe-edit",
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("profile.describe", {
  "profile": "safe-edit",
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call profile.describe

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"profile.describe","params":{"profile":"safe-edit","session_id":"sess_01J..."}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "profile.describe", "params": { "profile": "safe-edit", "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#profile.inventoryread

参数

字段	类型
session_id	string

返回值

{ effective: PermissionProfile, profile: string, source: string, choices: object[], mutation: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "profile.inventory",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("profile.inventory", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call profile.inventory

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"profile.inventory","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "profile.inventory", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

Product Control3

#config.inventoryread

参数

字段	类型
session_id	string

返回值

{ effective: object, sources: object, choices: object, mutation: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "config.inventory",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("config.inventory", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call config.inventory

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"config.inventory","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "config.inventory", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#skill.inventoryread

参数

字段	类型
session_id	string

返回值

{ skills: object[], count: integer, mutation: string }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "skill.inventory",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("skill.inventory", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call skill.inventory

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"skill.inventory","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "skill.inventory", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

#hook.inventoryread

参数

字段	类型
session_id	string

返回值

{ hooks: object[], count: integer, safe_mode: boolean, supported_events: string[], commands_redacted: true }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "hook.inventory",
  "params": {
    "session_id": "sess_01J..."
  }
}

// scope: read
const result = await client.request("hook.inventory", {
  "session_id": "sess_01J..."
});

# JSON-RPC over the local socket
carina call hook.inventory

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"hook.inventory","params":{"session_id":"sess_01J..."}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "hook.inventory", "params": { "session_id": "sess_01J..." } }

复制 JSON复制本地 CLI发送

Secret2

#secret.grantadmin控制面

参数

object

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "secret.grant",
  "params": {}
}

// scope: admin
const result = await client.request("secret.grant", {});

# JSON-RPC over the local socket
carina call secret.grant

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"secret.grant","params":{}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "secret.grant", "params": {} }

复制 JSON复制本地 CLI发送

#secret.requestadmin控制面

参数

object

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "secret.request",
  "params": {}
}

// scope: admin
const result = await client.request("secret.request", {});

# JSON-RPC over the local socket
carina call secret.request

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"secret.request","params":{}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "secret.request", "params": {} }

复制 JSON复制本地 CLI发送

Plugin2

#plugin.inspectread

参数

object

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "plugin.inspect",
  "params": {}
}

// scope: read
const result = await client.request("plugin.inspect", {});

# JSON-RPC over the local socket
carina call plugin.inspect

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"plugin.inspect","params":{}}

请求演练

read

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "plugin.inspect", "params": {} }

复制 JSON复制本地 CLI发送

#plugin.runadmin控制面

参数

object

返回值

object

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "plugin.run",
  "params": {}
}

// scope: admin
const result = await client.request("plugin.run", {});

# JSON-RPC over the local socket
carina call plugin.run

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"plugin.run","params":{}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "plugin.run", "params": {} }

复制 JSON复制本地 CLI发送

Worker4

#worker.registerworker远程

参数

字段	类型
name	string
kind	remote|ci|sandbox?
process_tree_containment	none|unix_pgrp_v1|windows_job_v1
pools	string[]? (worker_pool:<tag> capability tags, max 8, each 1-64 lowercase alnum/dash/underscore; matches a streaming workflow step's affinity.worker_pool)

返回值

{ worker_id: string, worker_credential: string } (credential returned once; server stores only a hash)

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worker.register",
  "params": {
    "name": "<name>",
    "process_tree_containment": "<process_tree_containment>",
    "pools": []
  }
}

// scope: worker
const result = await client.request("worker.register", {
  "name": "<name>",
  "process_tree_containment": "<process_tree_containment>",
  "pools": []
});

# JSON-RPC over the local socket
carina call worker.register

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worker.register","params":{"name":"<name>","process_tree_containment":"<process_tree_containment>","pools":[]}}

请求演练

worker

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worker.register", "params": { "name": "<name>", "process_tree_containment": "<process_tree_containment>" } }

复制 JSON复制本地 CLI发送

#worker.heartbeatworker远程

参数

字段	类型
worker_id	string
worker_credential	string

返回值

{ ok: boolean }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worker.heartbeat",
  "params": {
    "worker_id": "<worker_id>",
    "worker_credential": "<worker_credential>"
  }
}

// scope: worker
const result = await client.request("worker.heartbeat", {
  "worker_id": "<worker_id>",
  "worker_credential": "<worker_credential>"
});

# JSON-RPC over the local socket
carina call worker.heartbeat

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worker.heartbeat","params":{"worker_id":"<worker_id>","worker_credential":"<worker_credential>"}}

请求演练

worker

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worker.heartbeat", "params": { "worker_id": "<worker_id>", "worker_credential": "<worker_credential>" } }

复制 JSON复制本地 CLI发送

#worker.listread远程

参数

{}

返回值

Worker[]

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worker.list",
  "params": {}
}

// scope: read
const result = await client.request("worker.list", {});

# JSON-RPC over the local socket
carina call worker.list

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worker.list","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worker.list", "params": {} }

复制 JSON复制本地 CLI发送

#worker.revokeworker远程控制面

参数

字段	类型
worker_id	string
worker_credential	string

返回值

{ ok: boolean }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "worker.revoke",
  "params": {
    "worker_id": "<worker_id>",
    "worker_credential": "<worker_credential>"
  }
}

// scope: worker
const result = await client.request("worker.revoke", {
  "worker_id": "<worker_id>",
  "worker_credential": "<worker_credential>"
});

# JSON-RPC over the local socket
carina call worker.revoke

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"worker.revoke","params":{"worker_id":"<worker_id>","worker_credential":"<worker_credential>"}}

请求演练

worker

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "worker.revoke", "params": { "worker_id": "<worker_id>", "worker_credential": "<worker_credential>" } }

复制 JSON复制本地 CLI发送

Backpressure2

#backpressure.reportworker远程

参数

PressureReport + { worker_credential: string }

返回值

{ accepted: boolean, report: PressureReport, directive: ThrottleDirective }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "backpressure.report",
  "params": {}
}

// scope: worker
const result = await client.request("backpressure.report", {});

# JSON-RPC over the local socket
carina call backpressure.report

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"backpressure.report","params":{}}

请求演练

worker

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "backpressure.report", "params": {} }

复制 JSON复制本地 CLI发送

#backpressure.statusread远程

参数

{}

返回值

BackpressureStatus

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "backpressure.status",
  "params": {}
}

// scope: read
const result = await client.request("backpressure.status", {});

# JSON-RPC over the local socket
carina call backpressure.status

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"backpressure.status","params":{}}

请求演练

read

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "backpressure.status", "params": {} }

复制 JSON复制本地 CLI发送

Work5

#work.submitadmin控制面

参数

WorkSubmission + { required_worker_capabilities: string[]? }

返回值

WorkItem

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "work.submit",
  "params": {}
}

// scope: admin
const result = await client.request("work.submit", {});

# JSON-RPC over the local socket
carina call work.submit

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"work.submit","params":{}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "work.submit", "params": {} }

复制 JSON复制本地 CLI发送

#work.canceladmin控制面

参数

字段	类型
task_id	string

返回值

Task

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "work.cancel",
  "params": {
    "task_id": "Summarize module boundaries"
  }
}

// scope: admin
const result = await client.request("work.cancel", {
  "task_id": "Summarize module boundaries"
});

# JSON-RPC over the local socket
carina call work.cancel

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"work.cancel","params":{"task_id":"Summarize module boundaries"}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "work.cancel", "params": { "task_id": "Summarize module boundaries" } }

复制 JSON复制本地 CLI发送

#work.pollworker远程

参数

字段	类型
worker_id	string
worker_credential	string
ttl_ms	number?

返回值

WorkLease?

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "work.poll",
  "params": {
    "worker_id": "<worker_id>",
    "worker_credential": "<worker_credential>",
    "ttl_ms": 1
  }
}

// scope: worker
const result = await client.request("work.poll", {
  "worker_id": "<worker_id>",
  "worker_credential": "<worker_credential>",
  "ttl_ms": 1
});

# JSON-RPC over the local socket
carina call work.poll

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"work.poll","params":{"worker_id":"<worker_id>","worker_credential":"<worker_credential>","ttl_ms":1}}

请求演练

worker

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "work.poll", "params": { "worker_id": "<worker_id>", "worker_credential": "<worker_credential>", "ttl_ms": 1 } }

复制 JSON复制本地 CLI发送

#work.renewworker远程

参数

字段	类型
worker_id	string
worker_credential	string
task_id	string
lease_generation	integer >= 1
ttl_ms	number?

返回值

{ ok: boolean, cancelled: boolean? }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "work.renew",
  "params": {
    "worker_id": "<worker_id>",
    "worker_credential": "<worker_credential>",
    "task_id": "Summarize module boundaries",
    "lease_generation": 1,
    "ttl_ms": 1
  }
}

// scope: worker
const result = await client.request("work.renew", {
  "worker_id": "<worker_id>",
  "worker_credential": "<worker_credential>",
  "task_id": "Summarize module boundaries",
  "lease_generation": 1,
  "ttl_ms": 1
});

# JSON-RPC over the local socket
carina call work.renew

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"work.renew","params":{"worker_id":"<worker_id>","worker_credential":"<worker_credential>","task_id":"Summarize module boundaries","lease_generation":1,"ttl_ms":1}}

请求演练

worker

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "work.renew", "params": { "worker_id": "<worker_id>", "worker_credential": "<worker_credential>", "task_id": "Summarize module boundaries", "lease_generation": 1, "ttl_ms": 1 } }

复制 JSON复制本地 CLI发送

#work.reportworker远程

参数

WorkReport + { worker_credential: string, lease_generation: integer >= 1, usage: {input_tokens: integer >= 0, output_tokens: integer >= 0, cache_read_tokens: integer >= 0?, cache_write_tokens: integer >= 0?}?, channel_messages: [{channel: string, payload: any}]? (max 64; see docs/worker-executor.md) }

返回值

{ ok: boolean }

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "work.report",
  "params": {}
}

// scope: worker
const result = await client.request("work.report", {});

# JSON-RPC over the local socket
carina call work.report

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"work.report","params":{}}

请求演练

worker

Mock 无需 daemon。Live 会先完成 gateway.hello，再发送当前 JSON-RPC 请求。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "work.report", "params": {} }

复制 JSON复制本地 CLI发送

Debug2

#debug.snapshotadmin

参数

字段	类型
limit	number?
component	string?

返回值

DebugSnapshot

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "debug.snapshot",
  "params": {
    "limit": 1
  }
}

// scope: admin
const result = await client.request("debug.snapshot", {
  "limit": 1
});

# JSON-RPC over the local socket
carina call debug.snapshot

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"debug.snapshot","params":{"limit":1}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "debug.snapshot", "params": { "limit": 1 } }

复制 JSON复制本地 CLI发送

#debug.correlation.searchadmin

参数

字段	类型
correlation_id	string
limit	number?

返回值

DebugSnapshot

请求示例

JSON-RPCTypeScriptCLI复制

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "debug.correlation.search",
  "params": {
    "correlation_id": "<correlation_id>",
    "limit": 1
  }
}

// scope: admin
const result = await client.request("debug.correlation.search", {
  "correlation_id": "<correlation_id>",
  "limit": 1
});

# JSON-RPC over the local socket
carina call debug.correlation.search

# equivalent payload:
# {"jsonrpc":"2.0","id":1,"method":"debug.correlation.search","params":{"correlation_id":"<correlation_id>","limit":1}}

请求演练

admin

此方法不开放远程调用；请使用 Mock 或本地 CLI。

模拟实时

请求体{ "jsonrpc": "2.0", "id": 1, "method": "debug.correlation.search", "params": { "correlation_id": "<correlation_id>", "limit": 1 } }

复制 JSON复制本地 CLI发送

权威来源

• 由 protocol/jsonrpc/methods.json 经 pnpm sync-protocol 生成
• 通道钉扎：src/data/rpc-catalog-0.8.x.json / rpc-catalog-next.json（及 public/data/）
• 叙述：API 概览 · JSON-RPC · 版本

下一步

• 会话 — 会话生命周期深读
• 展开任意方法 → Try it Playground