Skip to content

BACKEND_API.md

Latest commit

 

History

History
96 lines (77 loc) · 1.63 KB

BACKEND_API.md

File metadata and controls

96 lines (77 loc) · 1.63 KB

Backend API

All endpoints require authentication via Authorization: Bearer <token> header.

List Backends

GET /api/backends

Response:

[
  {"id": "opencode", "name": "OpenCode"},
  {"id": "claudecode", "name": "Claude Code"},
  {"id": "codex", "name": "Codex"},
  {"id": "gemini", "name": "Gemini"},
  {"id": "grok", "name": "Grok Build"}
]

Get Backend

GET /api/backends/:id

Response:

{"id": "opencode", "name": "OpenCode"}

List Backend Agents

GET /api/backends/:id/agents

Response:

[{"id": "build", "name": "build"}, {"id": "plan", "name": "plan"}]

Get Backend Config

GET /api/backends/:id/config

Response:

{
  "id": "opencode",
  "name": "OpenCode",
  "enabled": true,
  "settings": {
    "base_url": "http://127.0.0.1:4096",
    "default_agent": "build",
    "permissive": true
  }
}

For claudecode, settings includes api_key_configured and optional fields like default_model. Grok settings include an optional cli_path. Codex and Gemini currently use empty settings unless configured by future backend-specific fields.

Update Backend Config

PUT /api/backends/:id/config

Body:

{
  "enabled": true,
  "settings": {
    "base_url": "http://127.0.0.1:4096",
    "default_agent": "build",
    "permissive": true
  }
}

Claude Code accepts api_key in settings to store it securely in the secrets vault. Grok accepts cli_path to override the CLI binary path.

Response:

{
  "ok": true,
  "message": "Backend configuration updated. Restart Sandboxed.sh to apply runtime changes."
}