Skip to content

Endpoints

This page maps WarmHub’s mounted REST endpoints for repository reads, action observability, component installs, and the MCP and streaming transports. Most rows link to the page that documents the endpoint in detail. A few mounted routes are owned by other pages — see Documented elsewhere below. For base URL, authentication, request and response format, idempotency, and pagination, see the Overview.

Endpoints marked None are publicly accessible for public repositories. Private repositories require a valid Bearer token.

MethodPathDescriptionAuth
GET/api/repos/:org/:repo/headHEAD snapshotNone
GET/api/repos/:org/:repo/about/:wrefAssertions about a thingNone
GET/api/repos/:org/:repo/queryFiltered queryNone
MethodPathDescriptionAuth
GET/api/repos/:org/:repo/actions/runsList action runsrepo:configure
GET/api/repos/:org/:repo/actions/runs/:runId/attemptsGet run attemptsrepo:configure
GET/api/repos/:org/:repo/actions/notificationsList action notifications (terminal failures, plus successes when notifyOnSuccess is enabled)repo:configure
POST/api/action-runs/:runId/callbackReport async action progress or completionrepo:write
MethodPathDescriptionAuth
POST/mcpMCP HTTP transport (GET returns 405)Bearer token
POST/mcp/:orgName/:repoNameRepo-scoped MCP HTTP transport (GET returns 405)Bearer token
GET/sseServer-sent invalidation stream with a live ticketLive ticket
MethodPathDescriptionAuth
POST/api/component-registry/:orgName/:componentName/resolveCheck install eligibility and mint an install idrepo:write on the install repo
POST/api/component-registry/:orgName/:componentName/sourceDownload the component source archive through the backendrepo:write on the install repo
POST/api/component-registry/:orgName/:componentName/setup-callDispatch the optional registered-component setup callbackrepo:write on the install repo

These surfaces are intentionally documented through SDK, CLI, and MCP workflows rather than REST endpoint references:

SurfaceUse Instead
Commit writesSDK commit APIs, wh commit submit, or warmhub_commit_submit
Shape managementSDK shape APIs, wh shape, or commit writes
Organization and repository managementCLI org/repo commands or SDK org/repo APIs
Subscription managementSubscription CLI/MCP workflows
Credential set managementCredential CLI workflows
PAT managementPersonal Access Tokens guide

A few other mounted routes are documented on the pages that own those surfaces, so they are not repeated here:

RoutesDocumented on
MCP OAuth metadata — /.well-known/oauth-protected-resource, /.well-known/oauth-authorization-serverMCP Server
Raw repository content — /:org/:repo/readme.md, /:org/:repo/agents.md, /:org/:repo/llms.txtContent shapes