API reference

AlianHub has a REST API for scripts, integrations and AI tools. Every request goes to your own instance (for example https://hub.example.com/api/v2/...); there is no separate API host.

Generated by npm run api:doc from the routes the server registers, the guards they sit behind and scripts/api-doc.meta.json. It is regenerated in the docs pull request that follows merges to staging, so in between it can be a few routes behind the code: npm run api:doc:check says whether it is current, and a route added since is not here yet.

Built from 1001 routes and the meta file, fingerprint 19460bc345b9.

The server registers 1001 routes. 65 are documented in full in these pages. The other 936 are listed in the appendix with their method, path and auth, marked internal or undocumented, so this page is honest about what it does not cover. A machine-readable list of paths, methods, auth and tags is in docs/api/openapi.json.

Every id, name and token below is a placeholder.

Where this comes from

These pages are built from docs/API.md, which npm run api:doc generates from the routes the server registers. The machine-readable list of paths, methods, auth and tags is openapi.json.

Start here

• Base URL and versions
• Authentication
• Responses and errors
• Rate limiting
• Ids and dates
• Pagination
• Webhook deliveries
• Stability

Endpoints by area

• Identity
• Read-only token API
• Tasks
• Everything
• Projects
• Pages
• Agents
• Dashboards
• Webhooks
• Goals
• Whiteboards
• Imports
• Custom fields

Everything else

• Every route — every other route the server registers, with its auth and status.
• MCP server — the tools an AI app can call.