GitDocket docs
Local HTTP reference.
A small reference for the browser preview’s read routes. For automation, start with the CLI or MCP tools.
What exists
Docket has no published OpenAPI specification. docket serve exposes a local HTTP surface used by its browser UI. These are current implementation routes, not a versioned public service contract.
The MCP input schemas are the available machine-readable tool reference. For HTTP inspection, use the loopback URL printed by Serve on your own computer.
Useful read routes
All routes below use GET. Task, epic, document, and search responses include a page object. The board keeps pagination inside its columns.
| Route | Returns |
|---|---|
/api/nav?summary=1 | Navigation summary. |
/api/home?briefing=1 | Home briefing. |
/api/tasks?page=1&limit=20 | Paginated work items. |
/api/board?page=1 | Work grouped by state. |
/api/epics?page=1 | Epic rollups. |
/api/docs?page=1 | Document inventory. |
/api/search?q=welcome&page=1&limit=10 | Ranked search hits. |
/api/source/reference/welcome.md | A bounded Markdown source page. |
The source example exists in the Harbor demo. Use an exact path from your own bundle inventory. Source responses include a hash and may include a continuation cursor; unknown paths return 404 and stale cursors return 409.
Try a read
Start the local server on an available port, then query it from a second terminal:
docket serve --port 4111curl 'http://127.0.0.1:4111/api/tasks?page=1&limit=20'Serve binds to loopback and checks the request host and origin. It has no remote authentication layer; it is intended for same-computer use. This page covers a small read subset. Use the CLI or MCP operations for documented task mutations.