Hosted API
Understand when to use the Mogplex hosted API for app-backed state, runs, repos, models, MCP, sandboxes, and observability.
The hosted API is the control-plane surface behind the Mogplex app and parts of the CLI.
Use it when another system needs to inspect or drive Mogplex state directly: repos, runs, models, MCP servers, sandboxes, settings, and runtime activity.
Use the API when
- a CI job or internal tool needs to start or inspect runs
- a dashboard needs repo, run, model, or observability state
- the CLI needs hosted account state
- you are debugging current route behavior in the product
- an adjacent service should behave like the app
Prefer the app when a human is configuring account setup, GitHub coverage, agents, routing, or sandboxes interactively.
Product-first route model
The hosted API follows product surfaces. It is not documented as a frozen long-term public REST platform yet.
That means you should read it from the product outward:
- identify the surface you are trying to drive
- find the route family behind that surface
- confirm the auth mode and response envelope
- document the routes your own integration depends on
Route families
| Family | Examples |
|---|---|
| Identity and settings | /api/auth/*, /api/settings, /api/models |
| Projects and GitHub state | /api/repos, /api/workspaces, /api/github/* |
| Reusable behavior | /api/agents, /api/skills, /api/rules, /api/mcp-servers |
| Routing | /api/triggers, /api/assignments, /api/flows |
| Runtime | /api/chat, /api/commands, /api/sandbox, /api/observability/* |
| v1 public run surface | /api/v1/mogplex/* |
For the concrete map, use Route Families.
Auth model
The same hosted surface can be reached through browser session auth, personal access tokens, and internal test auth depending on the route.
Start with:
- API Authentication for PATs, scopes, idempotency, and browser auth behavior
- API Errors for envelope shape and retry guidance
- Working Requests for copyable examples
Good first calls
GET /api/auth/userto confirm setup stateGET /api/settingsto inspect shared defaultsGET /api/modelsto inspect model availabilityGET /api/github/installationsto confirm GitHub App coverageGET /api/v1/mogplex/mcp/serversto export CLI-ready MCP definitionsGET /api/observability/statsto inspect runtime health and usage