OpenAPI description
Download the machine-readable contract for the current account-facing API operations.
The specification describes the account-facing control API: catalog, identity, account snapshot, services, storage, templates, activity, diagnostics, API keys, and hosted top-ups. It includes request fields, response shapes, authentication requirements, path/query parameters, and idempotency headers.
What it covers
- Shared Zod request schemas supply field types, defaults, and limits.
- GPU model/memory and MIG count relationships are included as cross-field constraints.
- Interactive Firebase authentication is distinguished from personal API-key authentication.
- Service and volume writes return bare resource objects; individual reads use named envelopes.
- Logs use plain text, and diagnostic command results distinguish output, exit code, and truncation.
- Monitoring distinguishes live, missing, stale, and inactive readings.
Import the file into an OpenAPI-compatible editor or API client to inspect requests. Review the method and resource before executing a request: some operations allocate paid resources or delete files. This documentation does not execute account mutations for you.
Preview scope
The specification follows the current source implementation. Runtime readiness, live capacity, regional pricing, and enabled payment/browser/monitoring configuration remain separate requirements. It is not a guarantee that every operation is enabled in every deployment.
Administrative APIs, supplier APIs, internal callbacks, and payment webhooks are not client integration surfaces and are omitted. Service endpoint proxy traffic is described in the connection guide.
Keep integrations correct
Use the configured server origin, check the public catalog, and supply credentials through a secret store. Read the API conventions before building mutation retries. Do not replay an uncertain diagnostic command automatically, and do not assume an asynchronous acknowledgement is application readiness.