OpenCode — API

opencode v1.0.0 · spec ↗ · 188 endpoints · 1 deprecated

opencode api

What it covers

Session 27 Experimental HttpApi session routes.
Sessions 17 Experimental session routes.
Pty 15 PTY websocket route.
Experimental 13 Experimental HttpApi read-only routes.
Tui 13 Experimental HttpApi TUI routes.
Instance 12 Experimental HttpApi instance read routes.
Mcp 8 Experimental HttpApi MCP routes.
Integrations 7 Integration discovery and authentication routes.
Permissions 7 Experimental permission routes.
Workspace 7 Experimental HttpApi workspace routes.
File 6 Experimental HttpApi file routes.
Global 6 Global server routes.

20 more areas

Opencode Httpapi 5 Experimental HttpApi surface for selected instance routes.
Project 5 Experimental HttpApi project routes.
Projectcopy 4 Project copy management routes.
Provider 4 Experimental HttpApi provider routes.
Session Questions 4 Experimental session question routes.
Sync 4 Experimental HttpApi sync routes.
Config 3 Experimental HttpApi config routes.
Control 3 Control plane routes.
Filesystem 3 Experimental location-scoped filesystem routes.
Question 3 Question routes.
Permission 2 Experimental HttpApi permission routes.
Providers 2 Experimental provider routes.
Commands 1 Experimental command routes.
Controlplane 1 Control-plane orchestration routes.
Event 1 Instance event stream route.
Events 1 Experimental event stream route.
Messages 1 Experimental message routes.
Models 1 Experimental model routes.
Reference 1 Location-scoped project references.
Skills 1 Experimental skill routes.

Endpoints

Open an endpoint for its inputs and outputs.

Session 27

DELETE /session/{sessionID} Delete session

Loading…
DELETE /session/{sessionID}/message/{messageID} Delete message

Loading…
DELETE /session/{sessionID}/message/{messageID}/part/{partID} Delete a part from a message.

Loading…
DELETE /session/{sessionID}/share Unshare session

Loading…
GET /session List sessions

Loading…
GET /session/status Get session status

Loading…
GET /session/{sessionID} Get session

Loading…
GET /session/{sessionID}/children Get session children

Loading…
GET /session/{sessionID}/diff Get message diff

Loading…
GET /session/{sessionID}/message Get session messages

Loading…
GET /session/{sessionID}/message/{messageID} Get message

Loading…
GET /session/{sessionID}/todo Get session todos

Loading…
PATCH /session/{sessionID} Update session

Loading…
PATCH /session/{sessionID}/message/{messageID}/part/{partID} Update a part in a message.

Loading…
POST /session Create session

Loading…
POST /session/{sessionID}/abort Abort session

Loading…
POST /session/{sessionID}/command Send command

Loading…
POST /session/{sessionID}/fork Fork session

Loading…
POST /session/{sessionID}/init Initialize session

Loading…
POST /session/{sessionID}/message Send message

Loading…
POST /session/{sessionID}/permissions/{permissionID} Respond to permissiondeprecated

Loading…
POST /session/{sessionID}/prompt_async Send async message

Loading…
POST /session/{sessionID}/revert Revert message

Loading…
POST /session/{sessionID}/share Share session

Loading…
POST /session/{sessionID}/shell Run shell command

Loading…
POST /session/{sessionID}/summarize Summarize session

Loading…
POST /session/{sessionID}/unrevert Restore reverted messages

Loading…

Sessions 17

GET /api/session List sessions

Loading…
GET /api/session/active List active sessions

Loading…
GET /api/session/{sessionID} Get session

Loading…
GET /api/session/{sessionID}/context Get session context

Loading…
GET /api/session/{sessionID}/event Subscribe to session events

Loading…
GET /api/session/{sessionID}/history Get session history

Loading…
GET /api/session/{sessionID}/message/{messageID} Get session message

Loading…
POST /api/session Create session

Loading…
POST /api/session/{sessionID}/agent Switch session agent

Loading…
POST /api/session/{sessionID}/compact Compact session

Loading…
POST /api/session/{sessionID}/interrupt Interrupt session execution

Loading…
POST /api/session/{sessionID}/model Switch session model

Loading…
POST /api/session/{sessionID}/prompt Send message

Loading…
POST /api/session/{sessionID}/revert/clear Clear staged revert

Loading…
POST /api/session/{sessionID}/revert/commit Commit staged revert

Loading…
POST /api/session/{sessionID}/revert/stage Stage session revert

Loading…
POST /api/session/{sessionID}/wait Wait for session

Loading…

Pty 15

DELETE /api/pty/{ptyID} Remove PTY session

Loading…
DELETE /pty/{ptyID} Remove PTY session

Loading…
GET /api/pty List PTY sessions

Loading…
GET /api/pty/{ptyID} Get PTY session

Loading…
GET /api/pty/{ptyID}/connect Connect to PTY session

Loading…
GET /pty List PTY sessions

Loading…
GET /pty/shells List available shells

Loading…
GET /pty/{ptyID} Get PTY session

Loading…
GET /pty/{ptyID}/connect Connect to PTY session

Loading…
POST /api/pty Create PTY session

Loading…
POST /api/pty/{ptyID}/connect-token Create PTY WebSocket token

Loading…
POST /pty Create PTY session

Loading…
POST /pty/{ptyID}/connect-token Create PTY WebSocket token

Loading…
PUT /api/pty/{ptyID} Update PTY session

Loading…
PUT /pty/{ptyID} Update PTY session

Loading…

Experimental 13

DELETE /experimental/worktree Remove worktree

Loading…
GET /experimental/capabilities Get experimental capabilities

Loading…
GET /experimental/console Get active Console provider metadata

Loading…
GET /experimental/console/orgs List switchable Console orgs

Loading…
GET /experimental/resource Get MCP resources

Loading…
GET /experimental/session List sessions

Loading…
GET /experimental/tool List tools

Loading…
GET /experimental/tool/ids List tool IDs

Loading…
GET /experimental/worktree List worktrees

Loading…
POST /experimental/console/switch Switch active Console org

Loading…
POST /experimental/session/{sessionID}/background Background subagents

Loading…
POST /experimental/worktree Create worktree

Loading…
POST /experimental/worktree/reset Reset worktree

Loading…

Tui 13

GET /tui/control/next Get next TUI request

Loading…
POST /tui/append-prompt Append TUI prompt

Loading…
POST /tui/clear-prompt Clear TUI prompt

Loading…
POST /tui/control/response Submit TUI response

Loading…
POST /tui/execute-command Execute TUI command

Loading…
POST /tui/open-help Open help dialog

Loading…
POST /tui/open-models Open models dialog

Loading…
POST /tui/open-sessions Open sessions dialog

Loading…
POST /tui/open-themes Open themes dialog

Loading…
POST /tui/publish Publish TUI event

Loading…
POST /tui/select-session Select session

Loading…
POST /tui/show-toast Show TUI toast

Loading…
POST /tui/submit-prompt Submit TUI prompt

Loading…

Instance 12

GET /agent List agents

Loading…
GET /command List commands

Loading…
GET /formatter Get formatter status

Loading…
GET /lsp Get LSP status

Loading…
GET /path Get paths

Loading…
GET /skill List skills

Loading…
GET /vcs Get VCS info

Loading…
GET /vcs/diff Get VCS diff

Loading…
GET /vcs/diff/raw Get raw VCS diff

Loading…
GET /vcs/status Get VCS status

Loading…
POST /instance/dispose Dispose instance

Loading…
POST /vcs/apply Apply VCS patch

Loading…

Mcp 8

DELETE /mcp/{name}/auth Remove MCP OAuth

Loading…
GET /mcp Get MCP status

Loading…
POST /mcp Add MCP server

Loading…
POST /mcp/{name}/auth Start MCP OAuth

Loading…
POST /mcp/{name}/auth/authenticate Authenticate MCP OAuth

Loading…
POST /mcp/{name}/auth/callback Complete MCP OAuth

Loading…
POST /mcp/{name}/connect Connect an MCP server.

Loading…
POST /mcp/{name}/disconnect Disconnect an MCP server.

Loading…

Integrations 7

DELETE /api/integration/attempt/{attemptID} Cancel OAuth connection

Loading…
GET /api/integration List integrations

Loading…
GET /api/integration/attempt/{attemptID} Get OAuth attempt status

Loading…
GET /api/integration/{integrationID} Get integration

Loading…
POST /api/integration/attempt/{attemptID}/complete Complete OAuth connection

Loading…
POST /api/integration/{integrationID}/connect/key Connect with key

Loading…
POST /api/integration/{integrationID}/connect/oauth Begin OAuth connection

Loading…

Permissions 7

DELETE /api/permission/saved/{id} Remove saved permission

Loading…
GET /api/permission/request List pending permission requests

Loading…
GET /api/permission/saved List saved permissions

Loading…
GET /api/session/{sessionID}/permission List session permission requests

Loading…
GET /api/session/{sessionID}/permission/{requestID} Get permission request

Loading…
POST /api/session/{sessionID}/permission Create permission request

Loading…
POST /api/session/{sessionID}/permission/{requestID}/reply Reply to pending permission request

Loading…

Workspace 7

DELETE /experimental/workspace/{id} Remove workspace

Loading…
GET /experimental/workspace List workspaces

Loading…
GET /experimental/workspace/adapter List workspace adapters

Loading…
GET /experimental/workspace/status Workspace status

Loading…
POST /experimental/workspace Create workspace

Loading…
POST /experimental/workspace/sync-list Sync workspace list

Loading…
POST /experimental/workspace/warp Warp session into workspace

Loading…

File 6

GET /file List files

Loading…
GET /file/content Read file

Loading…
GET /file/status Get file status

Loading…
GET /find Find text

Loading…
GET /find/file Find files

Loading…
GET /find/symbol Find symbols

Loading…

Global 6

GET /global/config Get global configuration

Loading…
GET /global/event Get global events

Loading…
GET /global/health Get health

Loading…
PATCH /global/config Update global configuration

Loading…
POST /global/dispose Dispose instance

Loading…
POST /global/upgrade Upgrade opencode

Loading…

Opencode Httpapi 5

DELETE /api/credential/{credentialID} Remove credential

Loading…
GET /api/agent List agents

Loading…
GET /api/health Check server health

Loading…
GET /api/location Get location

Loading…
PATCH /api/credential/{credentialID} Update credential

Loading…

Project 5

GET /project List all projects

Loading…
GET /project/current Get current project

Loading…
GET /project/{projectID}/directories List project directories

Loading…
PATCH /project/{projectID} Update project

Loading…
POST /project/git/init Initialize git repository

Loading…

Projectcopy 4

DELETE /experimental/project/{projectID}/copy

Loading…
POST /experimental/project/{projectID}/copy

Loading…
POST /experimental/project/{projectID}/copy/generate-name Generate project copy name

Loading…
POST /experimental/project/{projectID}/copy/refresh

Loading…

Provider 4

GET /provider List providers

Loading…
GET /provider/auth Get provider auth methods

Loading…
POST /provider/{providerID}/oauth/authorize Start OAuth authorization

Loading…
POST /provider/{providerID}/oauth/callback Handle OAuth callback

Loading…

Session Questions 4

GET /api/question/request List pending question requests

Loading…
GET /api/session/{sessionID}/question List session question requests

Loading…
POST /api/session/{sessionID}/question/{requestID}/reject Reject pending question request

Loading…
POST /api/session/{sessionID}/question/{requestID}/reply Reply to pending question request

Loading…

Sync 4

POST /sync/history List sync events

Loading…
POST /sync/replay Replay sync events

Loading…
POST /sync/start Start workspace sync

Loading…
POST /sync/steal Steal session into workspace

Loading…

Config 3

GET /config Get configuration

Loading…
GET /config/providers List config providers

Loading…
PATCH /config Update configuration

Loading…

Control 3

DELETE /auth/{providerID} Remove auth credentials

Loading…
POST /log Write log

Loading…
PUT /auth/{providerID} Set auth credentials

Loading…

Filesystem 3

GET /api/fs/find Find files

Loading…
GET /api/fs/list List directory

Loading…
GET /api/fs/read/* Read file

Loading…

Question 3

GET /question List pending questions

Loading…
POST /question/{requestID}/reject Reject question request

Loading…
POST /question/{requestID}/reply Reply to question request

Loading…

Permission 2

GET /permission List pending permissions

Loading…
POST /permission/{requestID}/reply Respond to permission request

Loading…

Providers 2

GET /api/provider List providers

Loading…
GET /api/provider/{providerID} Get provider

Loading…

Commands 1

GET /api/command List commands

Loading…

Controlplane 1

POST /experimental/control-plane/move-session Move session

Loading…

Event 1

GET /event Subscribe to events

Loading…

Events 1

GET /api/event Subscribe to events

Loading…

Messages 1

GET /api/session/{sessionID}/message Get session messages

Loading…

Models 1

GET /api/model List models

Loading…

Reference 1

GET /api/reference List references

Loading…

Skills 1

GET /api/skill List skills

Loading…

Recent changes

2026-08-04 ⚠ POST /session/{sessionID}/permissions/{permissionID}