Check Omn product combination

POST/api/v2/mv/capabilities/checkCopy URL

Authentication · x-api-key

Omn V1 independent product API. Independent Omn request, planning and delivery semantics.

All endpointsRequestResponsesCode

Request

Unknown fields are not accepted.

• Request · durationSecRequired

  number

  Requested or known media duration in seconds.

  Minimum: 10. Maximum: 600.

• Request · autoSubtitleOptional

  boolean

  Whether the proposed combination requests automatic captions.

• Request · creativeOptional

  object

  Creative intent, independent of output resolution.

  Unknown fields are not accepted.

  5 fields

  • Request · creative.modeRequired

    "auto" | "story" | "mood" | "perform" | "sing" | "dance" | "sing_dance" | "sing_play"

    auto, story, mood, perform, sing, dance, sing_dance or sing_play. All use the same request envelope.

    Default: "auto".

  • Request · creative.briefOptional

    string

    Describe the desired story, subjects, action and mood. Required for a brief-led story.

    Maximum characters: 3000.

  • Request · creative.charactersOptional

    object

    Whether characters may appear and the desired count.

    Unknown fields are not accepted.

    2 fields

    • Request · creative.characters.policyRequired

      "auto" | "required" | "forbidden"

      auto lets the director decide; required mandates characters; forbidden excludes them and conflicts with performance modes or character references.

      Default: "auto".

    • Request · creative.characters.countOptional

      string | integer

      Desired number of main characters (1 or 2); cannot be combined with forbidden.

      Minimum: 1. Maximum: 2. Must match at least one alternative.

      2 fields / alternatives

      • Request · creative.characters.count · anyOf 1Alternative

        string

        Desired number of main characters (1 or 2); cannot be combined with forbidden.

        Format: integer. Default: 0.

      • Request · creative.characters.count · anyOf 2Alternative

        integer

        Desired number of main characters (1 or 2); cannot be combined with forbidden.

        Minimum: 1. Maximum: 2.

  • Request · creative.optionsOptional

    object

    Mode-specific choices; irrelevant options are rejected.

    Unknown fields are not accepted.

    3 fields

    • Request · creative.options.combinationOptional

      "alternating" | "simultaneous"

      Required for sing_dance or sing_play. alternating uses separate shots. simultaneous requests same-shot actions and currently returns 422 before debit.

      Default: "alternating".

    • Request · creative.options.instrumentOptional

      string

      Instrument to feature in perform or sing_play.

      Minimum characters: 1. Maximum characters: 100.

    • Request · creative.options.storySourceOptional

      "lyrics" | "brief"

      Required for story: lyrics uses song evidence; brief uses creative.brief.

      Default: "lyrics".

  • Request · creative.styleOptional

    string

    Visual treatment passed to director planning and shot generation.

    Maximum characters: 1000.

• Request · hasCharacterImageOptional

  boolean

  Whether the request will supply a character reference image.

• Request · hasMotionReferenceVideoOptional

  boolean

  Whether the request will supply a motion reference video.

• Request · hasSubtitleTimelineOptional

  boolean

  Whether the request will supply a caption timeline.

• Request · outputOptional

  object

  Delivery format. No render tier or provider selector is accepted.

  Unknown fields are not accepted.

  2 fields

  • Request · output.aspectRatioOptional

    "16:9" | "9:16" | "1:1" | "4:3" | "3:4"

    Delivery aspect ratio; defaults to 16:9. Motion references require 16:9 or 9:16.

  • Request · output.resolutionOptional

    "540p" | "720p" | "1080p" | "1440p"

    540p, 720p, 1080p or 1440p for every mode. Defaults to 720p. Motion output may be resized from its source resolution.

• Request · referenceImageCountOptional

  string | integer

  Number of scene or style reference images in the proposed request.

  Minimum: 0. Maximum: 6. Must match at least one alternative.

  2 fields / alternatives

  • Request · referenceImageCount · anyOf 1Alternative

    string

    Format: integer. Default: 0.

  • Request · referenceImageCount · anyOf 2Alternative

    integer

    Minimum: 0. Maximum: 6.

• Request · singerCountOptional

  string | integer

  Number of ordered singer portrait references in the proposed request.

  Minimum: 0. Maximum: 2. Must match at least one alternative.

  2 fields / alternatives

  • Request · singerCount · anyOf 1Alternative

    string

    Format: integer. Default: 0.

  • Request · singerCount · anyOf 2Alternative

    integer

    Minimum: 0. Maximum: 2.

Responses

200 OK

application/json

Unknown fields are not accepted.

• Response 200 · contractVersionRequired

  "v2"

• Response 200 · creativeIntentRequired

  object

  Unknown fields are not accepted.

  4 fields

  • Response 200 · creativeIntent.directionRequired

    "auto" | "story" | "mood" | "performance"

    Default: "auto".

  • Response 200 · creativeIntent.performanceRequired

    "auto" | "sing" | "sing_perform" | "perform" | "dance" | "sing_dance" | "sing_play"

    Default: "auto".

  • Response 200 · creativeIntent.singingRequired

    "required" | "forbidden" | "unspecified"

    Default: "required".

  • Response 200 · creativeIntent.storySourceOptional

    "lyrics" | "prompt"

    Default: "lyrics".

• Response 200 · readyRequired

  boolean

  Advisory runtime readiness; successful preflight is still required. No capacity is reserved.

• Response 200 · reasonRequired

  "specialist_mode_unsupported" | "lip_sync_unsupported" | "character_image_unsupported" | "output_profile_unsupported" | "aspect_ratio_unsupported" | "duration_unsupported" | "cost_limit_exceeded" | "subtitle_timeline_required" | "contract_unsupported" | "source_unsupported" | "reference_images_unsupported" | "mode_unsupported" | "not_eligible" | "engine_closed" | "capacity_unavailable" | "workers_unavailable" | "engine_configuration_unavailable" | "scheduling_unavailable" | null

  Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · reason · anyOf 1Alternative

    "specialist_mode_unsupported" | "lip_sync_unsupported" | "character_image_unsupported" | "output_profile_unsupported" | "aspect_ratio_unsupported" | "duration_unsupported" | "cost_limit_exceeded" | "subtitle_timeline_required" | "contract_unsupported" | "source_unsupported" | "reference_images_unsupported" | "mode_unsupported" | "not_eligible" | "engine_closed" | "capacity_unavailable" | "workers_unavailable" | "engine_configuration_unavailable" | "scheduling_unavailable"

    Default: "specialist_mode_unsupported".

  • Response 200 · reason · anyOf 2Alternative

    null

• Response 200 · retryableRequired

  boolean

• Response 200 · supportedRequired

  boolean | null

  Support under configured product capabilities, ignoring operational disablement. Null when configuration cannot establish support.

  Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · supported · anyOf 1Alternative

    boolean

  • Response 200 · supported · anyOf 2Alternative

    null

• Response 200 · creativeOptional

  object

  Must match at least one alternative.

  5 fields / alternatives

  • Response 200 · creative · anyOf 1Alternative

    object

    Unknown fields are not accepted.

    2 fields

    • Response 200 · creative · anyOf 1.presetRequired

      "auto"

    • Response 200 · creative · anyOf 1.singingOptional

      "allowed" | "forbidden"

      Default: "allowed".

  • Response 200 · creative · anyOf 2Alternative

    object

    Unknown fields are not accepted.

    2 fields

    • Response 200 · creative · anyOf 2.presetRequired

      "mood"

    • Response 200 · creative · anyOf 2.singingOptional

      "allowed" | "forbidden"

      Default: "allowed".

  • Response 200 · creative · anyOf 3Alternative

    object

    Unknown fields are not accepted.

    3 fields

    • Response 200 · creative · anyOf 3.presetRequired

      "story"

    • Response 200 · creative · anyOf 3.storySourceRequired

      "lyrics" | "prompt"

      Default: "lyrics".

    • Response 200 · creative · anyOf 3.singingOptional

      "allowed" | "forbidden"

      Default: "allowed".

  • Response 200 · creative · anyOf 4Alternative

    object

    Unknown fields are not accepted.

    1 field

    • Response 200 · creative · anyOf 4.presetRequired

      "sing" | "sing_perform" | "perform" | "dance" | "sing_dance" | "sing_play"

      Default: "sing".

  • Response 200 · creative · anyOf 5Alternative

    object

    Creative intent, independent of output resolution.

    Unknown fields are not accepted.

    5 fields

    • Response 200 · creative · anyOf 5.modeRequired

      "auto" | "story" | "mood" | "perform" | "sing" | "dance" | "sing_dance" | "sing_play"

      auto, story, mood, perform, sing, dance, sing_dance or sing_play. All use the same request envelope.

      Default: "auto".

    • Response 200 · creative · anyOf 5.briefOptional

      string

      Describe the desired story, subjects, action and mood. Required for a brief-led story.

      Maximum characters: 3000.

    • Response 200 · creative · anyOf 5.charactersOptional

      object

      Whether characters may appear and the desired count.

      Unknown fields are not accepted.

      2 fields

      • Response 200 · creative · anyOf 5.characters.policyRequired

        "auto" | "required" | "forbidden"

        auto lets the director decide; required mandates characters; forbidden excludes them and conflicts with performance modes or character references.

        Default: "auto".

      • Response 200 · creative · anyOf 5.characters.countOptional

        string | integer

        Desired number of main characters (1 or 2); cannot be combined with forbidden.

        Minimum: 1. Maximum: 2. Must match at least one alternative.

        2 fields / alternatives

        • Response 200 · creative · anyOf 5.characters.count · anyOf 1Alternative

          string

          Desired number of main characters (1 or 2); cannot be combined with forbidden.

          Format: integer. Default: 0.

          1 field

          • Response 200 · creative · anyOf 5.characters.count · anyOf 1See schema

            string

            Expand this value in the interactive reference.

            Format: integer. Default: 0.

        • Response 200 · creative · anyOf 5.characters.count · anyOf 2Alternative

          integer

          Desired number of main characters (1 or 2); cannot be combined with forbidden.

          Minimum: 1. Maximum: 2.

          1 field

          • Response 200 · creative · anyOf 5.characters.count · anyOf 2See schema

            integer

            Expand this value in the interactive reference.

            Minimum: 1. Maximum: 2.

    • Response 200 · creative · anyOf 5.optionsOptional

      object

      Mode-specific choices; irrelevant options are rejected.

      Unknown fields are not accepted.

      3 fields

      • Response 200 · creative · anyOf 5.options.combinationOptional

        "alternating" | "simultaneous"

        Required for sing_dance or sing_play. alternating uses separate shots. simultaneous requests same-shot actions and currently returns 422 before debit.

        Default: "alternating".

      • Response 200 · creative · anyOf 5.options.instrumentOptional

        string

        Instrument to feature in perform or sing_play.

        Minimum characters: 1. Maximum characters: 100.

      • Response 200 · creative · anyOf 5.options.storySourceOptional

        "lyrics" | "brief"

        Required for story: lyrics uses song evidence; brief uses creative.brief.

        Default: "lyrics".

    • Response 200 · creative · anyOf 5.styleOptional

      string

      Visual treatment passed to director planning and shot generation.

      Maximum characters: 1000.

• Response 200 · outputOptional

  object

  Unknown fields are not accepted.

  3 fields

  • Response 200 · output.aspectRatioOptional

    "16:9" | "9:16" | "1:1" | "4:3" | "3:4"

    Delivery aspect ratio; defaults to 16:9. Motion references require 16:9 or 9:16.

  • Response 200 · output.renderTierOptional

    "draft" | "standard" | "hd" | "ultra"

    Omn V1 only. draft delivers 540p; standard 720p; hd 1080p; ultra 720p, 1080p or 1440p. When omitted: resolution=1440p or quality="high" selects ultra, standard quality selects draft at 540p and standard at 720p and hd at 1080p. Native shot rendering offers these tiers for both managed versions subject to capability and preflight checks. Dance motion transfer supports draft or standard only.

  • Response 200 · output.resolutionOptional

    "540p" | "720p" | "1080p" | "1440p"

    540p, 720p, 1080p or 1440p for every mode. Defaults to 720p. Motion output may be resized from its source resolution.

• Response 200 · requestedOutputOptional

  object

  Unknown fields are not accepted.

  3 fields

  • Response 200 · requestedOutput.aspectRatioOptional

    "16:9" | "9:16" | "1:1" | "4:3" | "3:4"

    Delivery aspect ratio; defaults to 16:9. Motion references require 16:9 or 9:16.

  • Response 200 · requestedOutput.renderTierOptional

    "draft" | "standard" | "hd" | "ultra"

    Omn V1 only. draft delivers 540p; standard 720p; hd 1080p; ultra 720p, 1080p or 1440p. When omitted: resolution=1440p or quality="high" selects ultra, standard quality selects draft at 540p and standard at 720p and hd at 1080p. Native shot rendering offers these tiers for both managed versions subject to capability and preflight checks. Dance motion transfer supports draft or standard only.

  • Response 200 · requestedOutput.resolutionOptional

    "540p" | "720p" | "1080p" | "1440p"

    540p, 720p, 1080p or 1440p for every mode. Defaults to 720p. Motion output may be resized from its source resolution.

400 Bad Request

application/json

• Response 400 · errorRequired

  object
  3 fields

  • Response 400 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 400 · error.messageRequired

    string

    Human readable error message

  • Response 400 · error.detailsOptional

    object

    Additional error details (optional)

• Response 400 · successRequired

  false

  Always false for error responses

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

402 Payment Required

application/json

• Response 402 · errorRequired

  object
  3 fields

  • Response 402 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 402 · error.messageRequired

    string

    Human readable error message

  • Response 402 · error.detailsOptional

    object

    Additional error details (optional)

• Response 402 · 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

404 Not Found

application/json

• Response 404 · errorRequired

  object
  3 fields

  • Response 404 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 404 · error.messageRequired

    string

    Human readable error message

  • Response 404 · error.detailsOptional

    object

    Additional error details (optional)

• Response 404 · successRequired

  false

  Always false for error responses

409 Conflict

application/json

• Response 409 · errorRequired

  object
  3 fields

  • Response 409 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 409 · error.messageRequired

    string

    Human readable error message

  • Response 409 · error.detailsOptional

    object

    Additional error details (optional)

• Response 409 · successRequired

  false

  Always false for error responses

413 Payload Too Large

application/json

• Response 413 · errorRequired

  object
  3 fields

  • Response 413 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 413 · error.messageRequired

    string

    Human readable error message

  • Response 413 · error.detailsOptional

    object

    Additional error details (optional)

• Response 413 · successRequired

  false

  Always false for error responses

422 Unprocessable Entity

application/json

• Response 422 · errorRequired

  object
  3 fields

  • Response 422 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 422 · error.messageRequired

    string

    Human readable error message

  • Response 422 · error.detailsOptional

    object

    Additional error details (optional)

• Response 422 · 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 · error.details.currentOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.inFlightOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.limitOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.policyOptional

      "operation" | "query"

    • Response 429 · error.details.retryAfterSecOptional

      integer

      Minimum: 1.

    • Response 429 · error.details.scopeOptional

      "user" | "api-key" | "ip" | "apiKey"

    • Response 429 · error.details.tierOptional

      "FREE" | "PREMIUM" | "ENTERPRISE"

    • Response 429 · error.details.typeOptional

      "rps" | "daily" | "monthly"

• 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

502 Bad Gateway

application/json

• Response 502 · errorRequired

  object
  3 fields

  • Response 502 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 502 · error.messageRequired

    string

    Human readable error message

  • Response 502 · error.detailsOptional

    object

    Additional error details (optional)

• Response 502 · successRequired

  false

  Always false for error responses

503 Service Unavailable

application/json

• Response 503 · errorRequired

  object
  3 fields

  • Response 503 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 503 · error.messageRequired

    string

    Human readable error message

  • Response 503 · error.detailsOptional

    object

    Additional error details (optional)

• Response 503 · successRequired

  false

  Always false for error responses

Request example

Wrap lines

cURL

curl --globoff --request POST \
  --url 'https://api.omnapi.com/api/v2/mv/capabilities/check' \
  --header "x-api-key: $OMNAPI_KEY" \
  --header 'Content-Type: application/json' \
  --data @request.json

Node.js

import { readFile } from "node:fs/promises";
const response = await fetch("https://api.omnapi.com/api/v2/mv/capabilities/check", {
  method: "POST",
  headers: {
    "x-api-key": process.env.OMNAPI_KEY,
    "Content-Type": "application/json",
  },
  body: await readFile("request.json", "utf8"),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.text());

Python

import os, json
import requests

response = requests.request(
    "POST", "https://api.omnapi.com/api/v2/mv/capabilities/check",
    headers={
        "x-api-key": os.environ["OMNAPI_KEY"],
    },
    json=json.load(open("request.json")),
    timeout=60,
)
response.raise_for_status()
print(response.text)

Set URL and header variables. Save your JSON body as request.json.

Interactive API Explorer → · OpenAPI JSON