Skip to content
API documentation

Read MV generation capabilities

GET/api/v1/mv/capabilities

Authentication · x-api-key

Read generation options and constraints available to the caller. `native` describes the optional Omn V1 engine (`generation.engineVersion="omn-v1"`): `selectableContracts` keeps its boolean shape, and `selectableContractDetails` adds per-contract readiness, duration, resolution, aspect-ratio, render-tier, schedule, shot-type, singing, singer-count, dance and motion-video hints derived from the same admission rules; reading them never starts or purchases a generation. `defaultEngine` reports the enabled contracts and rolloutPercent (default 0): a stable percentage of users with implicit Fast requests is evaluated for Omn V1; the rest and rejected requests stay on Vidu. Explicit engine selections and saved execution plans are unchanged. A successful preflight is still required before purchasing a supported combination.

Request

No request parameters.

Responses

200 OK

application/json

401 Unauthorized

application/json

  • Response 401 · errorRequired

    object
    3 fields
    • Response 401 · error.codeRequired

      string

      Application-specific error code (see error catalog)

    • Response 401 · error.messageRequired

      string

      Human readable error message

    • Response 401 · error.detailsOptional

      object

      Additional error details (optional)

  • Response 401 · successRequired

    false

    Always false for error responses

403 Forbidden

application/json

  • Response 403 · errorRequired

    object
    3 fields
    • Response 403 · error.codeRequired

      string

      Application-specific error code (see error catalog)

    • Response 403 · error.messageRequired

      string

      Human readable error message

    • Response 403 · error.detailsOptional

      object

      Additional error details (optional)

  • Response 403 · successRequired

    false

    Always false for error responses

429 Too Many Requests

Request allowance or task admission capacity exceeded. Follow Retry-After when present; otherwise wait for active tasks and use bounded backoff. Limits do not guarantee throughput. For SSE, this is the HTTP connection response, not an event.

application/json

  • Response 429 · errorRequired

    object
    3 fields
    • Response 429 · error.codeRequired

      string

      RATE_LIMITED for request and task admission rejections.

    • Response 429 · error.messageRequired

      string
    • Response 429 · error.detailsOptional

      object

      Optional and scope-dependent. Request limits supply scope/policy/type/limit/current/retryAfterSec. Task admission supplies inFlight/limit/tier, plus scope=apiKey for a key cap. IP rejection can omit details. In-flight rejection does not promise Retry-After.

      8 fields
  • Response 429 · successRequired

    false

    Default: false.

500 Internal Server Error

application/json

  • Response 500 · errorRequired

    object
    3 fields
    • Response 500 · error.codeRequired

      string

      Application-specific error code (see error catalog)

    • Response 500 · error.messageRequired

      string

      Human readable error message

    • Response 500 · error.detailsOptional

      object

      Additional error details (optional)

  • Response 500 · successRequired

    false

    Always false for error responses

Interactive API Explorer → · OpenAPI JSON