voao pro public API
The public API lets your own systems generate with voao pro's models. It is deliberately small: it does generation only.
With it you can:
- list the models and tools your plan includes, and the settings each one takes;
- ask the price of a request before you submit it (nothing is reserved);
- submit a job, then poll it or be told by a webhook when it ends;
- upload files to use as inputs (a reference picture, say) and download the results;
- read your API usage by day.
It does not cover stories, canvases, characters, projects, bulk batches, the brand library, or managing members, billing, keys and webhook endpoints. Those stay in the web app.
The API is available on plans that include API access. Keys and webhook endpoints are created by an owner or admin of your organization in the console.
Basics
| Base path | /v1 on the API host of your organization |
| Format | JSON in and out (Content-Type: application/json), UTF-8 |
| Authentication | Authorization: Bearer vk_<prefix>_<secret> |
| Time | RFC 3339 in UTC |
| Ids | UUIDs |
| Reference | API reference, generated from the OpenAPI description the server is built from; the file itself is v1.yaml |
Guides
- Quickstart: list models, price, submit, wait, download.
- Authentication: keys, scopes and what a key can reach.
- Idempotency: submitting safely more than once.
- Limits and errors: rate limits, the error shape, request ids and versioning.
- Webhooks: events, signatures, retries.
Jobs at a glance
A job moves through these statuses: queued, submitted, running, finalizing, then one of succeeded, failed, blocked or cancelled. Credits are reserved when you submit and settled only when the job succeeds; a job that fails, is blocked or is cancelled returns them. A finished job carries its results as asset ids in result_asset_ids; you fetch the files with the assets endpoints.