Base URL
All API requests are made over HTTPS to the following base URL:Authentication
Every request must include your API key as a bearer token in theAuthorization header. Keys start with sk_live_ and are created from the API Keys page in your dashboard.
The generation lifecycle
Generations run asynchronously. Rather than blocking until a model finishes — which can take seconds to minutes — the API splits the work into two calls:1
Create a generation
POST /v1/generations with a model and its inputs. The response returns immediately with an id and an initial status (such as queued).2
Poll for the result
GET /v1/generations/{id} until status becomes completed (or succeeded). When it does, output.url points to your finished asset. If status is failed, read error.message.Versioning
The current API version isv1, reflected in the base URL path. When Varo Cloud introduces changes that would break existing integrations — such as removing a field, changing a field’s type, or altering existing behavior — a new version prefix (e.g., /v2) will be released and the previous version will continue to work during a deprecation window.
Non-breaking additions, including new optional fields on existing responses and entirely new endpoints, are rolled out without a version bump. Write your integration to ignore unknown fields so these additions do not affect your code.
Request format
Send request bodies as JSON and include theContent-Type: application/json header on every request that has a body. All responses are JSON as well.
Response format
A generation is returned as a flat JSON object. The fields you’ll use most arestatus, output, and usage:
When a request fails, the API returns an error object instead. See Errors for the full format and status codes.
Rate limits
API keys are subject to rate limits. When you exceed your limit, the API returns a
429 Too Many Requests response — read the X-RateLimit-Reset header for the Unix timestamp when your quota resets, and wait until then before retrying. If you need a higher limit for production workloads, contact Varo Cloud support.