API Overview
Claude Deck exposes a RESTful API under /api/v1/. The frontend communicates with the backend entirely through this API.
Base URL
http://localhost:8000/api/v1In development, the Vite dev server proxies /api requests from port 5173 to the backend at port 8000.
Authentication
None. Claude Deck is a local-only application — no authentication is required.
Request/Response Format
All request and response bodies use JSON. Set Content-Type: application/json for requests with bodies.
Common Query Parameters
| Parameter | Type | Description |
|---|---|---|
project_path | string | Optional. Project directory path for project-scoped resources. |
scope | string | user, project, plugin, or managed — depends on the endpoint. |
Error Handling
| Status | Meaning |
|---|---|
200 | Success |
201 | Resource created |
204 | Deleted (no content) |
400 | Validation error |
404 | Resource not found |
500 | Server error |
Error responses return JSON with a detail field:
{
"detail": "Resource not found"
}Provider-aware endpoints may also map failures into normalized states such as unsupported capability, missing binary, unavailable CLI command, CLI failure, parse failure, or validation failure. Sensitive CLI stdout/stderr and raw provider payloads should be redacted or omitted before they are returned.
API Documentation
FastAPI generates interactive API docs at:
- Swagger UI:
http://localhost:8000/docs - ReDoc:
http://localhost:8000/redoc
Route Modules
| Module | Prefix | Description |
|---|---|---|
| Config | /config and /codex-config | Configuration management |
| Providers | /providers | Provider metadata, status, diagnostics, and inventory |
| MCP Servers | /mcp | MCP server management |
| Commands | /commands | Slash commands |
| Plugins | /plugins | Plugin management |
| Hooks | /hooks | Event hooks |
| Permissions | /permissions | Access control rules |
| Agents | /agents | Agents and skills |
| Sessions | /sessions | Session transcripts |
| Context | /context | Context window analysis |
| Plans | /plans | Implementation plans |
| Output Styles | /output-styles | Response formatting |
| Status Line | /statusline | Terminal status bar |
| Agent Bridge | /agent-bridge | Provider-aware live terminal monitoring |
| CC Bridge | /cc-bridge | Legacy Claude Code terminal monitoring route |
| Usage | /usage | Token usage tracking |
| Memory | /memory | Memory hierarchy |
| Backup | /backup | Configuration backups |