API reference

Use the generated Vex OpenAPI document for the public control-plane contract.

On this page

OpenAPI document

The Rails API generates the public control-plane contract. Use the canonical OpenAPI JSON for SDK generation, typed clients, or an interactive API client. Do not copy an API schema into prose where the generated contract is more precise.

API areas

Authentication and current user session
Organizations, members, and invitations
Repository access and VCS operations
Idempotent change submit, sync, lookup, and merge queues
Import baselines for Git and GitHub adoption
Hosting apps, environments, services, deployments, domains, CDN, and static sites
Image repositories, registry tokens, and tag listing

Authorization and concurrency

Browser sessions and bearer tokens with repository access can access the relevant control-plane operations. Landing requests and queue mutations require repository write access; organization-admin operations are explicitly marked by their endpoints.

Queue and merge-policy mutations use an optimistic expected version. A stale version returns 409 rather than silently overwriting concurrent work. See the CLI reference for task-oriented command forms over the same contract.