API Overview

Base URL: https://api.venelx.com. This page maps the API's main endpoints, grouped by domain.

Authentication

Two credential types, both sent as Authorization: Bearer <token>:

Session JWT — issued at login; what the dashboard uses.
Personal API token (vx_...) — for scripts and the MCP server; scoped read or write (API tokens). A read token can only make GET requests; the write scope is required for any request that changes something (any non-GET method). Project routes additionally enforce project roles (build triggers require at least the developer role).

Health & system

Mount	Description
`GET /api/health` (alias `/health`)	Liveness probe — reports service status and version
`/api/system`	Service health and deploy status (`/health`, `/deploy`, `/deploy/check`)

Auth & tokens

Mount	Description
`/api/auth` (alias `/api/v2/auth`)	Signup, login, session refresh, password flows
`/api/tokens` (alias `/api/v2/tokens`)	Personal API tokens — create/list/revoke `vx_` tokens
`/api/cli-auth`	Browser login for the MCP server (`npx @venelx/mcp login`): `POST /start`, `GET /poll/:id`, `POST /approve`, `POST /deny`
`/api/sso`, `/api/scim/v2`	Single sign-on (OIDC) and SCIM 2.0 provisioning (beta)

Projects & builds

Mount	Description
`/api/projects` (alias `/api/v2/projects`)	Project CRUD and project listing
`/api/:projectId/settings`	Project settings and env vars
`/api/:projectId/platform-flows`	Per-platform flow configuration
`/api/:projectId/build-stack`	Build stack selection per project
`/api/:projectId/testing`, `/api/testing`	Maestro app tests — configuration and test runs
`/api/web-testing`	Playwright web tests — sites, flows, runs
`/api/build-catalog`	Available build definitions/platforms
`POST /api/:projectId/build/:platform`	Queue a build for one platform (write scope + developer role)
`POST /api/:projectId/build-matrix`	Queue builds for multiple platforms at once (write scope + developer role)
`/api/:projectId/artifacts` (alias `/api/v2/artifacts`)	Build artifacts — list, download tokens
`GET /api/storage/download-token`	Presigned download token for an artifact
`GET /api/:projectId/build-jobs/:jobId/logs/stream`	Live build log stream (SSE)
`GET /api/:projectId/logs/:platform/tail`	Tail the latest build log for a platform
`GET /api/history`	Build history across your projects
`/api/notifications`	Your notifications

Build triggers surface a skipReason (e.g. signing_not_ready, github_token_invalid) when a build can't start — the same values the MCP trigger_build tool reports.

Signing

Mount	Description
`/api/signing`	Account-level signing credentials
`/api/:projectId/signing`	Per-project iOS/Android signing — upload, status, provisioning

Git providers

Mount	Description
`/api/github`	GitHub App OAuth flow, repo listing, connection status, token refresh
`GET /api/auth/github-status`	Shorthand alias for the GitHub connection status
`/api/gitlab`	GitLab integration (optional)

Teams, billing & enterprise

Mount	Description
`/api/teams` (alias `/api/v2/teams`)	Teams, membership, roles, team secrets
`/api/billing`	Plans, subscriptions, customer portal
`/api/webhooks`	Inbound webhooks (raw body, HMAC-verified)
`/api/webhooks/billing`	Lemon Squeezy billing webhooks
`/api/enterprise`	Enterprise features and licensing

Mount	Description
`/api/me/workers` (alias `/api/customer-workers`)	Your self-hosted workers — create, pairing, status
`GET /api/me/workers/usage`	Worker usage by month
`GET /api/me/workers/:id/metrics`	CPU, memory, and disk history for a worker
`PATCH /api/me/workers/:id/team`	Assign a worker to a team's worker pool

OTA, store & notifications

Mount	Description
`/api/ota`	Public OTA update endpoints
`/api/:projectId/ota`	Project OTA bundle management
`/ota-static`	Static serving of OTA bundles
`/api/store`	App-store submit (App Store / Google Play)
`/api/push` (alias `/api/v2/push`)	Push notification registration and send
`/api/recovery`	Account/project recovery flows

Mount	Description
`/api/analytics`, `GET /api/:projectId/analytics`	Usage and build analytics
`GET /api/storage`	Storage overview
`GET /api/badge/:projectId/:platform.svg`	Build status badge (public)
`/api/public/{qr,artifact,logs,download}/:id`	Public share links for builds: QR code, artifact page, logs, download

/api/v2/* mounts alias the current routers for compatibility — /api/v2/auth, /api/v2/projects, /api/v2/teams, and friends behave identically to their unversioned counterparts. New integrations should use the unversioned paths above.

← Environment Variables