BETAWe are currently in beta. Should you encounter any issues, please do not hesitate to contact us.
Discount on all models + if you follow us on twitter and hit us on dm you will get free credit to your email hurry up 🔥🔥🔥 click here
API · ENDPOINTS

Every URL, every payload.

Four endpoints cover the entire API surface. Each one has a dedicated page with full request shape, response schema, code samples, and the errors it can return.

POST
Generate/api/v1/generate

Submit a generation job. Returns a generation_id you can poll.

→GET
Generation status/api/v1/generations/{id}

Check whether a generation has completed and read the output URL.

→GET
List models/api/v1/models

List the models available to your key, including param schemas and cost bands.

→GET
Credits balance/api/v1/credits

Read your current credit balance, tier, and cycle reset date.

→

Conventions

Across every endpoint:

  • Base URL: https://vivix-atelier.vercel.app
  • Auth: Authorization: Bearer vvx_live_… on every request
  • Content type: application/json for all POSTs
  • Field naming: snake_case throughout. generation_id, output_url, credits_used.
  • Timestamps: ISO 8601 UTC strings (2026-05-10T12:34:56Z)
  • IDs: UUIDs as strings — don't parse them, just round-trip them.
  • Pagination (where applicable): cursor-based via ?cursor=…&limit=…

Response headers

Every successful response includes:

  • X-Request-Id — the trace id. Quote this when you write to support.
  • X-RateLimit-Remaining — calls left in your current minute window.
  • X-Credits-Balance — your wallet balance after the call (or estimate, for in-progress generations).