--- title: Server description: Komunicirajte s opencode serverom preko HTTP-a. --- import config from "../../../../config.mjs" export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts` Komanda `opencode serve` pokrece headless HTTP server koji izlaže OpenAPI endpoint koji opencode klijent moze koristiti. --- ### Usage ```bash opencode serve [--port ] [--hostname ] [--cors ] ``` #### Options | Zastava | Opis | Default | | --------------- | ----------------------------------- | ---------------- | | `--port` | Port na kojem slusa | `4096` | | `--hostname` | Hostname na kojem slusa | `127.0.0.1` | | `--mdns` | Ukljuci mDNS otkrivanje | `false` | | `--mdns-domain` | Prilagodeni domen za mDNS servis | `opencode.local` | | `--cors` | Dodatni browser origin-i koje dozv. | `[]` | `--cors` mozete navesti vise puta: ```bash opencode serve --cors http://localhost:5173 --cors https://app.example.com ``` --- ### Authentication Postavite `OPENCODE_SERVER_PASSWORD` da zastitite server HTTP basic auth mehanizmom. Korisnicko ime je po defaultu `opencode`, ili postavite `OPENCODE_SERVER_USERNAME` za nadjacavanje. Ovo vazi i za `opencode serve` i za `opencode web`. ```bash OPENCODE_SERVER_PASSWORD=your-password opencode serve ``` --- ### How it works Kada pokrenete `opencode`, pokrecu se TUI i server. TUI je klijent koji komunicira sa serverom. Server izlaže OpenAPI 3.1 spec endpoint koji se koristi i za generisanje [SDK-a](/docs/sdk). :::tip Koristite opencode server za programsku interakciju sa opencode-om. ::: Ova arhitektura omogucava opencode podrsku za vise klijenata i programsku interakciju. Mozete pokrenuti `opencode serve` da startate standalone server. Ako je opencode TUI vec pokrenut, `opencode serve` ce pokrenuti novi server. --- #### Connect to an existing server Kada pokrenete TUI, port i hostname se nasumicno dodijele. Umjesto toga, mozete zadati `--hostname` i `--port` [zastave](/docs/cli), pa se povezati na taj server. Endpoint [`/tui`](#tui) mozete koristiti za upravljanje TUI-jem kroz server. Na primjer, mozete unaprijed popuniti ili pokrenuti prompt. Ovaj setup koriste OpenCode [IDE](/docs/ide) pluginovi. --- ## Spec Server objavljuje OpenAPI 3.1 specifikaciju koju mozete vidjeti na: ``` http://:/doc ``` Na primjer, `http://localhost:4096/doc`. Koristite specifikaciju da generisete klijente ili pregledate tipove zahtjeva i odgovora. Mozete je otvoriti i u Swagger exploreru. --- ## APIs opencode server izlaže sljedece API-je. --- ### Global | Metoda | Putanja | Opis | Odgovor | | ------ | ---------------- | ------------------------------ | ------------------------------------ | | `GET` | `/global/health` | Get server health and version | `{ healthy: true, version: string }` | | `GET` | `/global/event` | Get global events (SSE stream) | Event stream | --- ### Project | Metoda | Putanja | Opis | Odgovor | | ------ | ------------------ | ----------------------- | --------------------------------------------- | | `GET` | `/project` | List all projects | Project[] | | `GET` | `/project/current` | Get the current project | Project | --- ### Path & VCS | Metoda | Putanja | Opis | Odgovor | | ------ | ------- | ------------------------------------ | ------------------------------------------- | | `GET` | `/path` | Get the current path | Path | | `GET` | `/vcs` | Get VCS info for the current project | VcsInfo | --- ### Instance | Metoda | Putanja | Opis | Odgovor | | ------ | ------------------- | ---------------------------- | --------- | | `POST` | `/instance/dispose` | Dispose the current instance | `boolean` | --- ### Config | Metoda | Putanja | Opis | Odgovor | | ------- | ------------------- | --------------------------------- | ---------------------------------------------------------------------------------------- | | `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 } }` | --- ### Provider | Metoda | Putanja | Opis | Odgovor | | ------ | -------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `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` | --- ### Sessions | Metoda | Putanja | Opis | Napomene | | -------- | ---------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------- | | `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` | --- ### Messages | Metoda | Putanja | Opis | Napomene | | ------ | --------------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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[]`}` | --- ### Commands | Metoda | Putanja | Opis | Odgovor | | ------ | ---------- | ----------------- | --------------------------------------------- | | `GET` | `/command` | List all commands | Command[] | --- ### Files | Metoda | Putanja | Opis | Odgovor | | ------ | ------------------------ | ---------------------------------- | ------------------------------------------------------------------------------------------- | | `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 parameters - `query` (required) — search string (fuzzy match) - `type` (optional) — limit results to `"file"` or `"directory"` - `directory` (optional) — override the project root for the search - `limit` (optional) — max results (1–200) - `dirs` (optional) — legacy flag (`"false"` returns only files) --- ### Tools (Experimental) | Metoda | Putanja | Opis | Odgovor | | ------ | ------------------------------------------- | ---------------------------------------- | -------------------------------------------- | | `GET` | `/experimental/tool/ids` | List all tool IDs | ToolIDs | | `GET` | `/experimental/tool?provider=

&model=` | List tools with JSON schemas for a model | ToolList | --- ### LSP, Formatters & MCP | Metoda | Putanja | Opis | Odgovor | | ------ | ------------ | -------------------------- | -------------------------------------------------------- | | `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 | --- ### Agents | Metoda | Putanja | Opis | Odgovor | | ------ | -------- | ------------------------- | ------------------------------------------- | | `GET` | `/agent` | List all available agents | Agent[] | --- ### Logging | Metoda | Putanja | Opis | Odgovor | | ------ | ------- | ------------------------------------------------------------ | --------- | | `POST` | `/log` | Write log entry. Body: `{ service, level, message, extra? }` | `boolean` | --- ### TUI | Metoda | Putanja | Opis | Odgovor | | ------ | ----------------------- | ------------------------------------------- | ---------------------- | | `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` | --- ### Auth | Metoda | Putanja | Opis | Odgovor | | ------ | ----------- | --------------------------------------------------------------- | --------- | | `PUT` | `/auth/:id` | Set authentication credentials. Body must match provider schema | `boolean` | --- ### Events | Metoda | Putanja | Opis | Odgovor | | ------ | -------- | ----------------------------------------------------------------------------- | ------------------------- | | `GET` | `/event` | Server-sent events stream. First event is `server.connected`, then bus events | Server-sent events stream | --- ### Docs | Metoda | Putanja | Opis | Odgovor | | ------ | ------- | ------------------------- | --------------------------- | | `GET` | `/doc` | OpenAPI 3.1 specification | HTML page with OpenAPI spec |