summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src/content/docs/sdk.mdx
diff options
context:
space:
mode:
authoropencode-agent[bot] <219766164+opencode-agent[bot]@users.noreply.github.com>2025-12-22 22:26:47 -0600
committerGitHub <[email protected]>2025-12-22 22:26:47 -0600
commit968543af398da3274014f74354de5f56141447ef (patch)
treefc0c12b7f95e6f2ef57b7bdfffe0957eae396252 /packages/web/src/content/docs/sdk.mdx
parent5af35117db705b71604cc3e6a4ed07fc9bbf28e7 (diff)
downloadopencode-968543af398da3274014f74354de5f56141447ef.tar.gz
opencode-968543af398da3274014f74354de5f56141447ef.zip
docs: new `/global/health` API (#6006)
Co-authored-by: opencode-agent[bot] <opencode-agent[bot]@users.noreply.github.com>
Diffstat (limited to 'packages/web/src/content/docs/sdk.mdx')
-rw-r--r--packages/web/src/content/docs/sdk.mdx17
1 files changed, 17 insertions, 0 deletions
diff --git a/packages/web/src/content/docs/sdk.mdx b/packages/web/src/content/docs/sdk.mdx
index 4f9a2959f..1ff843103 100644
--- a/packages/web/src/content/docs/sdk.mdx
+++ b/packages/web/src/content/docs/sdk.mdx
@@ -123,6 +123,23 @@ The SDK exposes all server APIs through a type-safe client.
---
+### Global
+
+| Method | Description | Response |
+| ----------------- | ------------------------------- | ------------------------------------ |
+| `global.health()` | Check server health and version | `{ healthy: true, version: string }` |
+
+---
+
+#### Examples
+
+```javascript
+const health = await client.global.health()
+console.log(health.data.version)
+```
+
+---
+
### App
| Method | Description | Response |