Skip to content

Commit 2fe48ba

Browse files
committed
docs: format sdk surface table
1 parent 8d1582e commit 2fe48ba

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

docs/concepts/openclaw-sdk.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,24 @@ resources.
2525

2626
`@openclaw/sdk` ships with:
2727

28-
| Surface | Status | What it does |
29-
| ------------------------- | ------- | ---------------------------------------------------------------------------- |
30-
| `OpenClaw` | Ready | Main client entry point. Owns transport, connection, requests, and events. |
31-
| `GatewayClientTransport` | Ready | WebSocket transport backed by the Gateway client. |
32-
| `oc.agents` | Ready | Lists, creates, updates, deletes, and gets agent handles. |
33-
| `Agent.run()` | Ready | Starts a Gateway `agent` run and returns a `Run`. |
34-
| `oc.runs` | Ready | Creates, gets, waits for, cancels, and streams runs. |
35-
| `Run.events()` | Ready | Streams normalized per-run events with replay for fast runs. |
36-
| `Run.wait()` | Ready | Calls `agent.wait` and returns a stable `RunResult`. |
37-
| `Run.cancel()` | Ready | Calls `sessions.abort` by run id, with session key when available. |
38-
| `oc.sessions` | Ready | Creates, resolves, sends to, patches, compacts, and gets session handles. |
39-
| `Session.send()` | Ready | Calls `sessions.send` and returns a `Run`. |
40-
| `oc.models` | Ready | Calls `models.list` and the current `models.authStatus` status RPC. |
41-
| `oc.tools` | Ready | Lists, scopes, and invokes Gateway tools through the policy pipeline. |
42-
| `oc.artifacts` | Ready | Lists, gets, and downloads Gateway transcript artifacts. |
43-
| `oc.approvals` | Ready | Lists and resolves exec approvals through Gateway approval RPCs. |
44-
| `oc.rawEvents()` | Ready | Exposes raw Gateway events for advanced consumers. |
45-
| `normalizeGatewayEvent()` | Ready | Converts raw Gateway events into the stable SDK event shape. |
28+
| Surface | Status | What it does |
29+
| ------------------------- | ------ | -------------------------------------------------------------------------- |
30+
| `OpenClaw` | Ready | Main client entry point. Owns transport, connection, requests, and events. |
31+
| `GatewayClientTransport` | Ready | WebSocket transport backed by the Gateway client. |
32+
| `oc.agents` | Ready | Lists, creates, updates, deletes, and gets agent handles. |
33+
| `Agent.run()` | Ready | Starts a Gateway `agent` run and returns a `Run`. |
34+
| `oc.runs` | Ready | Creates, gets, waits for, cancels, and streams runs. |
35+
| `Run.events()` | Ready | Streams normalized per-run events with replay for fast runs. |
36+
| `Run.wait()` | Ready | Calls `agent.wait` and returns a stable `RunResult`. |
37+
| `Run.cancel()` | Ready | Calls `sessions.abort` by run id, with session key when available. |
38+
| `oc.sessions` | Ready | Creates, resolves, sends to, patches, compacts, and gets session handles. |
39+
| `Session.send()` | Ready | Calls `sessions.send` and returns a `Run`. |
40+
| `oc.models` | Ready | Calls `models.list` and the current `models.authStatus` status RPC. |
41+
| `oc.tools` | Ready | Lists, scopes, and invokes Gateway tools through the policy pipeline. |
42+
| `oc.artifacts` | Ready | Lists, gets, and downloads Gateway transcript artifacts. |
43+
| `oc.approvals` | Ready | Lists and resolves exec approvals through Gateway approval RPCs. |
44+
| `oc.rawEvents()` | Ready | Exposes raw Gateway events for advanced consumers. |
45+
| `normalizeGatewayEvent()` | Ready | Converts raw Gateway events into the stable SDK event shape. |
4646

4747
The SDK also exports the core types used by those surfaces:
4848
`AgentRunParams`, `RunResult`, `RunStatus`, `OpenClawEvent`,

0 commit comments

Comments
 (0)