API contract
Identify the existing dashboard, agent, and public API entry points and their access requirements.
Most release-management tasks can be completed in the dashboard. This page preserves the integration overview for clients already using the API.
Access requirements
| Interface | Access |
|---|---|
/api/v1/dashboard | A signed-in VibeUpdate session with active account access for app, release, and token management. |
/api/v1/agent | An Agent Token belonging to an account with active access. |
/mcp | The same token and access requirements, through Streamable HTTP. |
| Public SDK and changelog reads | No Agent Token required. |
An identifier is not authorization. Agent tokens grant management access and must not be included in mobile apps. Public SDK checks use the public app ID and matching native application identifier. Public changelog reads also depend on the app's public-page setting.
The visible release version is descriptive. Update decisions compare native build numbers independently for iOS and Android. See update modes.
Handle errors before reporting success
REST errors include an HTTP status and a JSON body with statusCode, a nested error containing code and message, optional error details, plus path and timestamp.
Do not retry rejected validation requests without correcting their inputs. Missing or invalid authentication and an authenticated account without paid access are different conditions. After a lost response to a write, read the target back before deciding whether to repeat the operation.
MCP tool errors use isError: true in the tool result. HTTP success alone does not establish that a tool completed its action.
For the connection workflow, see MCP setup. For the separate CLI, use its published package instructions.