Get final MV download URL

GET/api/v1/mv/{mvId}/finalCopy URL

Authentication · x-api-key

Read or refresh the current final MP4 URL. Returns a fresh short-lived presigned URL (60 minutes by default) only when ready=true and the final asset matches the current source composition. Stale or missing finals return ready=false with sourceVersion/finalizedVersion/staleReason/actionHint diagnostics. The response includes `videoUrl`; fetch it directly. `id` identifies the final asset and differs from `mvId`.

All endpointsRequestResponsesCode

Request

mvIdpath · Required

string

MV identifier returned by create or read operations.

Responses

200 OK

application/json

• Response 200 · actionHintRequired

  "wait" | "refresh_final_url" | "retry_finalize" | "recompose_after_edit" | "check_source" | "contact_support" | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · actionHint · anyOf 1Alternative

    "wait" | "refresh_final_url" | "retry_finalize" | "recompose_after_edit" | "check_source" | "contact_support"

    Must match at least one alternative.

    6 fields / alternatives

    • Response 200 · actionHint · anyOf 1 · anyOf 1Alternative

      "wait"

    • Response 200 · actionHint · anyOf 1 · anyOf 2Alternative

      "refresh_final_url"

    • Response 200 · actionHint · anyOf 1 · anyOf 3Alternative

      "retry_finalize"

    • Response 200 · actionHint · anyOf 1 · anyOf 4Alternative

      "recompose_after_edit"

    • Response 200 · actionHint · anyOf 1 · anyOf 5Alternative

      "check_source"

    • Response 200 · actionHint · anyOf 1 · anyOf 6Alternative

      "contact_support"

  • Response 200 · actionHint · anyOf 2Alternative

    null

• Response 200 · expiresInSecRequired

  number | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · expiresInSec · anyOf 1Alternative

    number

  • Response 200 · expiresInSec · anyOf 2Alternative

    null

• Response 200 · failureCodeRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · failureCode · anyOf 1Alternative

    string

  • Response 200 · failureCode · anyOf 2Alternative

    null

• Response 200 · failureMessageRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · failureMessage · anyOf 1Alternative

    string

  • Response 200 · failureMessage · anyOf 2Alternative

    null

• Response 200 · finalizationRequiredRequired

  boolean

• Response 200 · finalizedVersionRequired

  number | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · finalizedVersion · anyOf 1Alternative

    number

  • Response 200 · finalizedVersion · anyOf 2Alternative

    null

• Response 200 · idRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · id · anyOf 1Alternative

    string

  • Response 200 · id · anyOf 2Alternative

    null

• Response 200 · isCurrentRequired

  boolean

• Response 200 · pollAfterSecRequired

  number | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · pollAfterSec · anyOf 1Alternative

    number

  • Response 200 · pollAfterSec · anyOf 2Alternative

    null

• Response 200 · readyRequired

  boolean

• Response 200 · retainedUntilRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · retainedUntil · anyOf 1Alternative

    string

  • Response 200 · retainedUntil · anyOf 2Alternative

    null

• Response 200 · retryableRequired

  boolean

• Response 200 · sourceVersionRequired

  number

• Response 200 · staleReasonRequired

  "missing_final" | "final_processing" | "final_expired" | "source_rendering" | "source_failed" | "source_changed" | "composition_unknown" | "url_unavailable" | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · staleReason · anyOf 1Alternative

    "missing_final" | "final_processing" | "final_expired" | "source_rendering" | "source_failed" | "source_changed" | "composition_unknown" | "url_unavailable"

    Must match at least one alternative.

    8 fields / alternatives

    • Response 200 · staleReason · anyOf 1 · anyOf 1Alternative

      "missing_final"

    • Response 200 · staleReason · anyOf 1 · anyOf 2Alternative

      "final_processing"

    • Response 200 · staleReason · anyOf 1 · anyOf 3Alternative

      "final_expired"

    • Response 200 · staleReason · anyOf 1 · anyOf 4Alternative

      "source_rendering"

    • Response 200 · staleReason · anyOf 1 · anyOf 5Alternative

      "source_failed"

    • Response 200 · staleReason · anyOf 1 · anyOf 6Alternative

      "source_changed"

    • Response 200 · staleReason · anyOf 1 · anyOf 7Alternative

      "composition_unknown"

    • Response 200 · staleReason · anyOf 1 · anyOf 8Alternative

      "url_unavailable"

  • Response 200 · staleReason · anyOf 2Alternative

    null

• Response 200 · statusRequired

  string

• Response 200 · urlExpiresAtRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · urlExpiresAt · anyOf 1Alternative

    string

  • Response 200 · urlExpiresAt · anyOf 2Alternative

    null

• Response 200 · videoUrlRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · videoUrl · anyOf 1Alternative

    string

  • Response 200 · videoUrl · anyOf 2Alternative

    null

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

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

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

Request example

Wrap lines

cURL

curl --globoff --request GET \
  --url 'https://api.omnapi.com/api/v1/mv/{mvId}/final' \
  --header "x-api-key: $OMNAPI_KEY"

Node.js

const response = await fetch("https://api.omnapi.com/api/v1/mv/{mvId}/final", {
  method: "GET",
  headers: {
    "x-api-key": process.env.OMNAPI_KEY,
  },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.text());

Python

import os
import requests

response = requests.request(
    "GET", "https://api.omnapi.com/api/v1/mv/{mvId}/final",
    headers={
        "x-api-key": os.environ["OMNAPI_KEY"],
    },
    timeout=60,
)
response.raise_for_status()
print(response.text)

Set URL and header variables.

Interactive API Explorer → · OpenAPI JSON