diff options
| author | Dax Raad <[email protected]> | 2025-09-09 23:43:37 -0400 |
|---|---|---|
| committer | Dax Raad <[email protected]> | 2025-09-09 23:44:04 -0400 |
| commit | 38e8c42cf02f73fb300889ab989088899a3aedb7 (patch) | |
| tree | 313db96535cf136cc1032618b43462c1f2f0e14c /packages/web/src/content/docs/server.mdx | |
| parent | 58fe88432714456350244ebbea1e6287d3dccb36 (diff) | |
| download | opencode-38e8c42cf02f73fb300889ab989088899a3aedb7.tar.gz opencode-38e8c42cf02f73fb300889ab989088899a3aedb7.zip | |
ci: format
Diffstat (limited to 'packages/web/src/content/docs/server.mdx')
| -rw-r--r-- | packages/web/src/content/docs/server.mdx | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/packages/web/src/content/docs/server.mdx b/packages/web/src/content/docs/server.mdx index 0713cce65..2eea2ba74 100644 --- a/packages/web/src/content/docs/server.mdx +++ b/packages/web/src/content/docs/server.mdx @@ -79,9 +79,9 @@ The opencode server exposes the following APIs. ### Config -| Method | Path | Description | Response | -| ------ | ------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `GET` | `/config` | Get config info | <a href={typesUrl}><code>Config</code></a> | +| Method | Path | Description | Response | +| ------ | ------------------- | --------------------------------- | ---------------------------------------------------------------------------------------- | +| `GET` | `/config` | Get config info | <a href={typesUrl}><code>Config</code></a> | | `GET` | `/config/providers` | List providers and default models | `{ providers: `<a href={typesUrl}>Provider[]</a>`, default: { [key: string]: string } }` | --- @@ -101,8 +101,8 @@ The opencode server exposes the following APIs. | `POST` | `/session/:id/share` | Share session | Returns <a href={typesUrl}><code>Session</code></a> | | `DELETE` | `/session/:id/share` | Unshare session | Returns <a href={typesUrl}><code>Session</code></a> | | `POST` | `/session/:id/summarize` | Summarize session | | -| `GET` | `/session/:id/message` | List messages in a session | Returns `{ info: `<a href={typesUrl}>Message</a>`, parts: `<a href={typesUrl}>Part[]</a>`}[]` | -| `GET` | `/session/:id/message/:messageID` | Get message details | Returns `{ info: `<a href={typesUrl}>Message</a>`, parts: `<a href={typesUrl}>Part[]</a>`}` | +| `GET` | `/session/:id/message` | List messages in a session | Returns `{ info: `<a href={typesUrl}>Message</a>`, parts: `<a href={typesUrl}>Part[]</a>`}[]` | +| `GET` | `/session/:id/message/:messageID` | Get message details | Returns `{ info: `<a href={typesUrl}>Message</a>`, parts: `<a href={typesUrl}>Part[]</a>`}` | | `POST` | `/session/:id/message` | Send chat message | body matches [`ChatInput`](https://github.com/sst/opencode/blob/main/packages/opencode/src/session/index.ts#L358), returns <a href={typesUrl}><code>Message</code></a> | | `POST` | `/session/:id/shell` | Run a shell command | body matches [`CommandInput`](https://github.com/sst/opencode/blob/main/packages/opencode/src/session/index.ts#L1007), returns <a href={typesUrl}><code>Message</code></a> | | `POST` | `/session/:id/revert` | Revert a message | body: `{ messageID }` | @@ -175,6 +175,6 @@ The opencode server exposes the following APIs. ### Docs -| Method | Path | Description | Response | -| ------ | ------ | -------------------------------------- | ------------------------------------------ | +| Method | Path | Description | Response | +| ------ | ------ | ------------------------- | --------------------------- | | `GET` | `/doc` | OpenAPI 3.1 specification | HTML page with OpenAPI spec | |