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.

Conventions

Across every endpoint:

  • Base URL: https://getvivix.com
  • 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: generation_id is a UUID — don't parse it, just round-trip it. request_id is not a UUID; it's an opaque req_… token — treat it as a log reference, not an identifier to validate.

Response headers

Every response, success or error, includes:

  • X-Request-Id — the trace id. Quote this when you write to support.