Developers
REST API reference
Source-backed overview of the HiveBase Platform API v2, generated from the OpenAPI snapshot in packages/api-schema.
HiveBase Platform API v2
REST paths in the OpenAPI snapshot.
HTTP operations across all groups.
Base URL
Use scoped hb_sk_* bearer keys for server-side API calls.
https://app.hivebase.ai/api/v2decision
5 operations
POST /api/v2/decisionsPOSTRecord an immutable decision event with structured context, judgment, and entity references. Decisio
PATCH /api/v2/decisions/:id/outcomePATCHBackfill the outcome of a past decision — set outcome_status (success, failure, mixed) and outcome_s
POST /api/v2/decisions/:id/supersedePOSTMark a past decision as superseded by a newer one. Use when a later decision invalidates or replaces
GET /api/v2/decisions/graphGETWalk the decision graph from a root decision, following both supersession (later decisions that repl
GET /api/v2/decisions/searchGETSearch past decisions using hybrid retrieval — semantic similarity combined with structured filters
mcp
1 operation
POST /api/v2/mcpPOSTPlatform API v2 MCP endpoint — JSON-RPC 2.0
repo
4 operations
GET /api/v2/reposGETList all GitHub repositories connected to this workspace — returns repo full names, default branches
GET /api/v2/repos/:repo_full_name/treeGETGet the file and directory tree for a connected repository up to a configurable depth. Use this to u
GET /api/v2/repos/searchGETSemantic search across all indexed source code in connected repositories using voyage-code-3 embeddi
GET /api/v2/repos/symbolsGETLook up a specific symbol (function, class, type, or variable) across all indexed repositories by ex
task
10 operations
GET /api/v2/tasksGETList tasks with optional filters (status, assignee, project, inbox status). Use this to find existin
POST /api/v2/tasksPOSTCreate the task object, with optional policy-aware execution. Use execution.mode=none to only create
GET /api/v2/tasks/:idGETGet a single task by ID with full metadata, assignees, comments, and enrichment context. Use this af
PATCH /api/v2/tasks/:idPATCHUpdate one or more fields on an existing task (name, status, priority, assignees, dates, etc.). Use
POST /api/v2/tasks/:id/commentsPOSTAdd a plain-text comment to a task's activity feed. Use this for status updates, notes, or follow-up
GET /api/v2/tasks/:id/runGETGet the current execution status for a task, including the latest agent session, fleet metadata when
POST /api/v2/tasks/:id/runPOSTStart execution for an existing task. For normal code tasks this delegates the task to a HiveBase co
POST /api/v2/tasks/:id/run/approvePOSTApprove a gated execution plan for a task that is awaiting plan approval. This starts the queued clo
POST /api/v2/tasks/:id/run/cancelPOSTCancel the active execution run for a task. This marks active agent sessions as cancelled and leaves
GET /api/v2/tasks/:id/run/subscribeGETPoll execution milestones for a task run. For cloud code fleets this returns fleet milestones and is