--- title: Сервер description: Взаимодействуйте с сервером opencode через HTTP. --- import config from "../../../../config.mjs" export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts` Команда `opencode serve` запускает автономный HTTP-сервер, который предоставляет конечную точку OpenAPI, которую может использовать клиент с открытым кодом. --- ### Использование ```bash opencode serve [--port ] [--hostname ] [--cors ] ``` #### Параметры | Флаг | Описание | По умолчанию | | --------------- | ----------------------------------- | ---------------- | | `--port` | Port to listen on | `4096` | | `--hostname` | Hostname to listen on | `127.0.0.1` | | `--mdns` | Enable mDNS discovery | `false` | | `--mdns-domain` | Custom domain name for mDNS service | `opencode.local` | | `--cors` | Additional browser origins to allow | `[]` | `--cors` можно передать несколько раз: ```bash opencode serve --cors http://localhost:5173 --cors https://app.example.com ``` --- ### Аутентификация Установите `OPENCODE_SERVER_PASSWORD`, чтобы защитить сервер с помощью базовой аутентификации HTTP. Имя пользователя по умолчанию — `opencode` или установите `OPENCODE_SERVER_USERNAME`, чтобы переопределить его. Это относится как к `opencode serve`, так и к `opencode web`. ```bash OPENCODE_SERVER_PASSWORD=your-password opencode serve ``` --- ### Как это работает Когда вы запускаете `opencode`, он запускает TUI и сервер. Где находится TUI клиент, который общается с сервером. Сервер предоставляет спецификацию OpenAPI 3.1. конечная точка. Эта конечная точка также используется для создания файла [SDK](/docs/sdk). :::tip Используйте сервер opencode для программного взаимодействия с открытым кодом. ::: Эта архитектура позволяет открытому коду поддерживать несколько клиентов и позволяет программно взаимодействовать с открытым кодом. Вы можете запустить `opencode serve`, чтобы запустить автономный сервер. Если у вас есть TUI с открытым кодом запущен, `opencode serve` запустит новый сервер. --- #### Подключиться к существующему серверу Когда вы запускаете TUI, он случайным образом назначает порт и имя хоста. Вместо этого вы можете передать `--hostname` и `--port` [flags](/docs/cli). Затем используйте это для подключения к его серверу. Конечную точку [`/tui`](#tui) можно использовать для управления TUI через сервер. Например, вы можете предварительно заполнить или запустить подсказку. Эта настройка используется плагинами opencode [IDE](/docs/ide). --- ## Спецификация Сервер публикует спецификацию OpenAPI 3.1, которую можно просмотреть по адресу: ``` http://:/doc ``` For example, `http://localhost:4096/doc`. Use the spec to generate clients or inspect request and response types. Or view it in a Swagger explorer. --- ## API Сервер opencode предоставляет следующие API. --- ### Глобальный | Метод | Путь | Описание | Ответ | | ----- | ---------------- | ------------------------------ | ------------------------------------ | | `GET` | `/global/health` | Get server health and version | `{ healthy: true, version: string }` | | `GET` | `/global/event` | Get global events (SSE stream) | Event stream | --- ### Проект | Метод | Путь | Описание | Ответ | | ----- | ------------------ | ----------------------- | --------------------------------------------- | | `GET` | `/project` | List all projects | Project[] | | `GET` | `/project/current` | Get the current project | Project | --- ### Путь и система контроля версий | Метод | Путь | Описание | Ответ | | ----- | ------- | ------------------------------------ | ------------------------------------------- | | `GET` | `/path` | Get the current path | Path | | `GET` | `/vcs` | Get VCS info for the current project | VcsInfo | --- ### Экземпляр | Метод | Путь | Описание | Ответ | | ------ | ------------------- | ---------------------------- | --------- | | `POST` | `/instance/dispose` | Dispose the current instance | `boolean` | --- ### Конфигурация | Метод | Путь | Описание | Ответ | | ------- | ------------------- | --------------------------------- | ---------------------------------------------------------------------------------------- | | `GET` | `/config` | Get config info | Config | | `PATCH` | `/config` | Update config | Config | | `GET` | `/config/providers` | List providers and default models | `{ providers: `Provider[]`, default: { [key: string]: string } }` | --- ### Поставщик | Метод | Путь | Описание | Ответ | | ------ | -------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `GET` | `/provider` | List all providers | `{ all: `Provider[]`, default: {...}, connected: string[] }` | | `GET` | `/provider/auth` | Get provider authentication methods | `{ [providerID: string]: `ProviderAuthMethod[]` }` | | `POST` | `/provider/{id}/oauth/authorize` | Authorize a provider using OAuth | ProviderAuthAuthorization | | `POST` | `/provider/{id}/oauth/callback` | Handle OAuth callback for a provider | `boolean` | --- ### Сессии | Метод | Путь | Описание | Примечания | | -------- | ---------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------- | | `GET` | `/session` | List all sessions | Returns Session[] | | `POST` | `/session` | Create a new session | body: `{ parentID?, title? }`, returns Session | | `GET` | `/session/status` | Get session status for all sessions | Returns `{ [sessionID: string]: `SessionStatus` }` | | `GET` | `/session/:id` | Get session details | Returns Session | | `DELETE` | `/session/:id` | Delete a session and all its data | Returns `boolean` | | `PATCH` | `/session/:id` | Update session properties | body: `{ title? }`, returns Session | | `GET` | `/session/:id/children` | Get a session's child sessions | Returns Session[] | | `GET` | `/session/:id/todo` | Get the todo list for a session | Returns Todo[] | | `POST` | `/session/:id/init` | Analyze app and create `AGENTS.md` | body: `{ messageID, providerID, modelID }`, returns `boolean` | | `POST` | `/session/:id/fork` | Fork an existing session at a message | body: `{ messageID? }`, returns Session | | `POST` | `/session/:id/abort` | Abort a running session | Returns `boolean` | | `POST` | `/session/:id/share` | Share a session | Returns Session | | `DELETE` | `/session/:id/share` | Unshare a session | Returns Session | | `GET` | `/session/:id/diff` | Get the diff for this session | query: `messageID?`, returns FileDiff[] | | `POST` | `/session/:id/summarize` | Summarize the session | body: `{ providerID, modelID }`, returns `boolean` | | `POST` | `/session/:id/revert` | Revert a message | body: `{ messageID, partID? }`, returns `boolean` | | `POST` | `/session/:id/unrevert` | Restore all reverted messages | Returns `boolean` | | `POST` | `/session/:id/permissions/:permissionID` | Respond to a permission request | body: `{ response, remember? }`, returns `boolean` | --- ### Сообщения | Метод | Путь | Описание | Примечания | | ------ | --------------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `GET` | `/session/:id/message` | List messages in a session | query: `limit?`, returns `{ info: `Message`, parts: `Part[]`}[]` | | `POST` | `/session/:id/message` | Send a message and wait for response | body: `{ messageID?, model?, agent?, noReply?, system?, tools?, parts }`, returns `{ info: `Message`, parts: `Part[]`}` | | `GET` | `/session/:id/message/:messageID` | Get message details | Returns `{ info: `Message`, parts: `Part[]`}` | | `POST` | `/session/:id/prompt_async` | Send a message asynchronously (no wait) | body: same as `/session/:id/message`, returns `204 No Content` | | `POST` | `/session/:id/command` | Execute a slash command | body: `{ messageID?, agent?, model?, command, arguments }`, returns `{ info: `Message`, parts: `Part[]`}` | | `POST` | `/session/:id/shell` | Run a shell command | body: `{ agent, model?, command }`, returns `{ info: `Message`, parts: `Part[]`}` | --- ### Команды | Метод | Путь | Описание | Ответ | | ----- | ---------- | ----------------- | --------------------------------------------- | | `GET` | `/command` | List all commands | Command[] | --- ### Файлы | Метод | Путь | Описание | Ответ | | ----- | ------------------------ | ---------------------------------- | ------------------------------------------------------------------------------------------- | | `GET` | `/find?pattern=` | Search for text in files | Array of match objects with `path`, `lines`, `line_number`, `absolute_offset`, `submatches` | | `GET` | `/find/file?query=` | Find files and directories by name | `string[]` (paths) | | `GET` | `/find/symbol?query=` | Find workspace symbols | Symbol[] | | `GET` | `/file?path=` | List files and directories | FileNode[] | | `GET` | `/file/content?path=

` | Read a file | FileContent | | `GET` | `/file/status` | Get status for tracked files | File[] | #### `/find/file` параметры запроса - `query` (обязательно) — строка поиска (нечеткое совпадение) - `type` (необязательно) — ограничить результаты `"file"` или `"directory"`. - `directory` (необязательно) — переопределить корень проекта для поиска. - `limit` (необязательно) — максимальное количество результатов (1–200) - `dirs` (необязательно) — устаревший флаг (`"false"` возвращает только файлы) --- ### Инструменты (Экспериментальные) | Метод | Путь | Описание | Ответ | | ----- | ------------------------------------------- | ---------------------------------------- | -------------------------------------------- | | `GET` | `/experimental/tool/ids` | List all tool IDs | ToolIDs | | `GET` | `/experimental/tool?provider=

&model=` | List tools with JSON schemas for a model | ToolList | --- ### LSP, форматтеры и MCP | Метод | Путь | Описание | Ответ | | ------ | ------------ | -------------------------- | -------------------------------------------------------- | | `GET` | `/lsp` | Get LSP server status | LSPStatus[] | | `GET` | `/formatter` | Get formatter status | FormatterStatus[] | | `GET` | `/mcp` | Get MCP server status | `{ [name: string]: `MCPStatus` }` | | `POST` | `/mcp` | Add MCP server dynamically | body: `{ name, config }`, returns MCP status object | --- ### Агенты | Метод | Путь | Описание | Ответ | | ----- | -------- | ------------------------- | ------------------------------------------- | | `GET` | `/agent` | List all available agents | Agent[] | --- ### Ведение журнала | Метод | Путь | Описание | Ответ | | ------ | ------ | ------------------------------------------------------------ | --------- | | `POST` | `/log` | Write log entry. Body: `{ service, level, message, extra? }` | `boolean` | --- ### TUI | Метод | Путь | Описание | Ответ | | ------ | ----------------------- | ------------------------------------------- | ---------------------- | | `POST` | `/tui/append-prompt` | Append text to the prompt | `boolean` | | `POST` | `/tui/open-help` | Open the help dialog | `boolean` | | `POST` | `/tui/open-sessions` | Open the session selector | `boolean` | | `POST` | `/tui/open-themes` | Open the theme selector | `boolean` | | `POST` | `/tui/open-models` | Open the model selector | `boolean` | | `POST` | `/tui/submit-prompt` | Submit the current prompt | `boolean` | | `POST` | `/tui/clear-prompt` | Clear the prompt | `boolean` | | `POST` | `/tui/execute-command` | Execute a command (`{ command }`) | `boolean` | | `POST` | `/tui/show-toast` | Show toast (`{ title?, message, variant }`) | `boolean` | | `GET` | `/tui/control/next` | Wait for the next control request | Control request object | | `POST` | `/tui/control/response` | Respond to a control request (`{ body }`) | `boolean` | --- ### Авторизация | Метод | Путь | Описание | Ответ | | ----- | ----------- | --------------------------------------------------------------- | --------- | | `PUT` | `/auth/:id` | Set authentication credentials. Body must match provider schema | `boolean` | --- ### События | Метод | Путь | Описание | Ответ | | ----- | -------- | ----------------------------------------------------------------------------- | ------------------------- | | `GET` | `/event` | Server-sent events stream. First event is `server.connected`, then bus events | Server-sent events stream | --- ### Документы | Метод | Путь | Описание | Ответ | | ----- | ------ | ------------------------- | --------------------------- | | `GET` | `/doc` | OpenAPI 3.1 specification | HTML page with OpenAPI spec |