Quote a ten-second creative preview

POST/api/v1/mv/drafts/{id}/preview/preflightCopy URL

Authentication · x-api-key

Validate a draft revision for its separately priced first-ten-second preview. Save the preflightId for the paid preview request; this check does not purchase a video.

All endpointsRequestResponsesCode

Request

idpath · Required

string

Resource identifier returned by the corresponding create operation.

Unknown fields are not accepted.

• Request · expectedVersionRequired

  string | integer

  Optimistic-concurrency guard using the current resource version.

  Minimum: 1. Must match at least one alternative.

  2 fields / alternatives

  • Request · expectedVersion · anyOf 1Alternative

    string

    Format: integer. Default: 0.

  • Request · expectedVersion · anyOf 2Alternative

    integer

    Minimum: 1.

• Request · webhookUrlOptional

  string

  Optional HTTPS endpoint for the generated Task's completion notification.

  Format: uri.

Responses

200 OK

application/json

Unknown fields are not accepted.

• Response 200 · checksRequired

  object

  Unknown fields are not accepted.

  5 fields

  • Response 200 · checks.referenceImagesRequired

    array<object>
    1 field

    • Response 200 · checks.referenceImages[]Each item

      object
      8 fields

      • Response 200 · checks.referenceImages[].kindRequired

        string

      • Response 200 · checks.referenceImages[].statusRequired

        "ok"

      • Response 200 · checks.referenceImages[].clipIdOptional

        string

      • Response 200 · checks.referenceImages[].durationSecOptional

        number

      • Response 200 · checks.referenceImages[].processingModeOptional

        string

      • Response 200 · checks.referenceImages[].rangeOptional

        object
        2 fields

        • Response 200 · checks.referenceImages[].range.endSecOptional

          number

          Minimum: 0.

          1 field

          • Response 200 · checks.referenceImages[].range.endSecSee schema

            number

            Expand this value in the interactive reference.

            Minimum: 0.

        • Response 200 · checks.referenceImages[].range.startSecOptional

          number

          Minimum: 0.

          1 field

          • Response 200 · checks.referenceImages[].range.startSecSee schema

            number

            Expand this value in the interactive reference.

            Minimum: 0.

      • Response 200 · checks.referenceImages[].sourceDurationSecOptional

        number

      • Response 200 · checks.referenceImages[].urlOptional

        string

  • Response 200 · checks.sourceRequired

    object
    8 fields

    • Response 200 · checks.source.kindRequired

      string

    • Response 200 · checks.source.statusRequired

      "ok"

    • Response 200 · checks.source.clipIdOptional

      string

    • Response 200 · checks.source.durationSecOptional

      number

    • Response 200 · checks.source.processingModeOptional

      string

    • Response 200 · checks.source.rangeOptional

      object
      2 fields

      • Response 200 · checks.source.range.endSecOptional

        number

        Minimum: 0.

      • Response 200 · checks.source.range.startSecOptional

        number

        Minimum: 0.

    • Response 200 · checks.source.sourceDurationSecOptional

      number

    • Response 200 · checks.source.urlOptional

      string

  • Response 200 · checks.characterImageOptional

    object
    8 fields

    • Response 200 · checks.characterImage.kindRequired

      string

    • Response 200 · checks.characterImage.statusRequired

      "ok"

    • Response 200 · checks.characterImage.clipIdOptional

      string

    • Response 200 · checks.characterImage.durationSecOptional

      number

    • Response 200 · checks.characterImage.processingModeOptional

      string

    • Response 200 · checks.characterImage.rangeOptional

      object
      2 fields

      • Response 200 · checks.characterImage.range.endSecOptional

        number

        Minimum: 0.

      • Response 200 · checks.characterImage.range.startSecOptional

        number

        Minimum: 0.

    • Response 200 · checks.characterImage.sourceDurationSecOptional

      number

    • Response 200 · checks.characterImage.urlOptional

      string

  • Response 200 · checks.srtUrlOptional

    object
    8 fields

    • Response 200 · checks.srtUrl.kindRequired

      string

    • Response 200 · checks.srtUrl.statusRequired

      "ok"

    • Response 200 · checks.srtUrl.clipIdOptional

      string

    • Response 200 · checks.srtUrl.durationSecOptional

      number

    • Response 200 · checks.srtUrl.processingModeOptional

      string

    • Response 200 · checks.srtUrl.rangeOptional

      object
      2 fields

      • Response 200 · checks.srtUrl.range.endSecOptional

        number

        Minimum: 0.

      • Response 200 · checks.srtUrl.range.startSecOptional

        number

        Minimum: 0.

    • Response 200 · checks.srtUrl.sourceDurationSecOptional

      number

    • Response 200 · checks.srtUrl.urlOptional

      string

  • Response 200 · checks.visualBoardOptional

    object
    8 fields

    • Response 200 · checks.visualBoard.kindRequired

      string

    • Response 200 · checks.visualBoard.statusRequired

      "ok"

    • Response 200 · checks.visualBoard.clipIdOptional

      string

    • Response 200 · checks.visualBoard.durationSecOptional

      number

    • Response 200 · checks.visualBoard.processingModeOptional

      string

    • Response 200 · checks.visualBoard.rangeOptional

      object
      2 fields

      • Response 200 · checks.visualBoard.range.endSecOptional

        number

        Minimum: 0.

      • Response 200 · checks.visualBoard.range.startSecOptional

        number

        Minimum: 0.

    • Response 200 · checks.visualBoard.sourceDurationSecOptional

      number

    • Response 200 · checks.visualBoard.urlOptional

      string

• Response 200 · creditsRequiredRequired

  number

  Minimum: 0.

• Response 200 · expiresAtRequired

  string

• Response 200 · modeRequired

  "fast" | "studio"

• Response 200 · preflightIdRequired

  string

• Response 200 · quoteRequired

  object

  Unknown fields are not accepted.

  15 fields

  • Response 200 · quote.breakdownRequired

    object

    Unknown fields are not accepted.

    9 fields

    • Response 200 · quote.breakdown.baseOptional

      number

    • Response 200 · quote.breakdown.composeOperationsOptional

      number

    • Response 200 · quote.breakdown.durationOptional

      number

    • Response 200 · quote.breakdown.estimatedSceneCountOptional

      number

    • Response 200 · quote.breakdown.finalizeOptional

      number

    • Response 200 · quote.breakdown.lipSyncOptional

      number

    • Response 200 · quote.breakdown.renderPerSceneOptional

      number

    • Response 200 · quote.breakdown.scenesOptional

      number

    • Response 200 · quote.breakdown.visualBoardOptional

      number

  • Response 200 · quote.creditsRequired

    number

    Minimum: 0.

  • Response 200 · quote.assumptionsOptional

    array<string>
    1 field

    • Response 200 · quote.assumptions[]Each item

      string

  • Response 200 · quote.baseCreditsOptional

    number

  • Response 200 · quote.billingIncrementCreditsOptional

    number

    Minimum: 0.0001.

  • Response 200 · quote.calculatedSubtotalCreditsOptional

    number

  • Response 200 · quote.componentsOptional

    array<object>
    1 field

    • Response 200 · quote.components[]Each item

      object

      Unknown fields are not accepted.

      7 fields

      • Response 200 · quote.components[].discountCreditsRequired

        number

      • Response 200 · quote.components[].discountedCreditsRequired

        number

      • Response 200 · quote.components[].finalCreditsRequired

        number

      • Response 200 · quote.components[].keyRequired

        string

      • Response 200 · quote.components[].labelRequired

        string

      • Response 200 · quote.components[].publicCreditsRequired

        number

      • Response 200 · quote.components[].quantityOptional

        number

  • Response 200 · quote.discountCreditsOptional

    number

  • Response 200 · quote.expiresAtOptional

    string

  • Response 200 · quote.operationOptional

    string

  • Response 200 · quote.pricingVersionOptional

    number

  • Response 200 · quote.quoteIdOptional

    string

  • Response 200 · quote.settlementPolicyVersionOptional

    string

  • Response 200 · quote.settlementRoundingCreditsOptional

    number

  • Response 200 · quote.warningCodesOptional

    array<string>
    1 field

    • Response 200 · quote.warningCodes[]Each item

      string

      MV advisory warning codes. Non-fatal: the request still succeeds; these flag degraded, adjusted, or automatically recovered inputs and are projected into public Task warningCodes. Omn review codes (MV_NATIVE_CREATIVE_*, MV_NATIVE_SHOT_INTERNAL_CUT, MV_NATIVE_FRAME_BORDERS) describe the delivered video; their observations and affected scenes are in `quality` of GET /api/v1/tasks/{taskId}/workflow.

• Response 200 · quoteTypeRequired

  "validated_estimate"

• Response 200 · warningCodesRequired

  array<string>
  1 field

  • Response 200 · warningCodes[]Each item

    string

    MV advisory warning codes. Non-fatal: the request still succeeds; these flag degraded, adjusted, or automatically recovered inputs and are projected into public Task warningCodes. Omn review codes (MV_NATIVE_CREATIVE_*, MV_NATIVE_SHOT_INTERNAL_CUT, MV_NATIVE_FRAME_BORDERS) describe the delivered video; their observations and affected scenes are in `quality` of GET /api/v1/tasks/{taskId}/workflow.

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

408 Request Timeout

application/json

• Response 408 · errorRequired

  object
  3 fields

  • Response 408 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 408 · error.messageRequired

    string

    Human readable error message

  • Response 408 · error.detailsOptional

    object

    Additional error details (optional)

• Response 408 · 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/v1/mv/drafts/{id}/preview/preflight' \
  --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/v1/mv/drafts/{id}/preview/preflight", {
  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/v1/mv/drafts/{id}/preview/preflight",
    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