Read Omn MV

GET/api/v2/mv/{mvId}

Authentication · x-api-key

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

Request

mvIdpath · Required

string

MV identifier returned by create or read operations.

historyLimitquery · Optional

integer

Minimum: 1. Maximum: 50.

Responses

200 OK

application/json

Unknown fields are not accepted.

Response 200 · billingRequired

object | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · billing · anyOf 1Alternative
  
  object
  
  Unknown fields are not accepted.
  6 fields
  - Response 200 · billing · anyOf 1.creditsChargedRequired
    
    number | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · billing · anyOf 1.creditsCharged · anyOf 1Alternative
    
    number
    
    Response 200 · billing · anyOf 1.creditsCharged · anyOf 2Alternative
    
    null
  - Response 200 · billing · anyOf 1.creditsReservedRequired
    
    number
  - Response 200 · billing · anyOf 1.refundReasonRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · billing · anyOf 1.refundReason · anyOf 1Alternative
    
    string
    
    Response 200 · billing · anyOf 1.refundReason · anyOf 2Alternative
    
    null
  - Response 200 · billing · anyOf 1.refundedCreditsRequired
    
    number
  - Response 200 · billing · anyOf 1.settlementStatusRequired
    
    "PENDING" | "CHARGED" | "REFUNDED"
    
    Must match at least one alternative.
    
    3 fields / alternatives
    
    Response 200 · billing · anyOf 1.settlementStatus · anyOf 1Alternative
    
    "PENDING"
    
    Response 200 · billing · anyOf 1.settlementStatus · anyOf 2Alternative
    
    "CHARGED"
    
    Response 200 · billing · anyOf 1.settlementStatus · anyOf 3Alternative
    
    "REFUNDED"
  - Response 200 · billing · anyOf 1.refundTypeOptional
    
    "none" | "partial" | "full"
    
    Must match at least one alternative.
    
    3 fields / alternatives
    
    Response 200 · billing · anyOf 1.refundType · anyOf 1Alternative
    
    "none"
    
    Response 200 · billing · anyOf 1.refundType · anyOf 2Alternative
    
    "partial"
    
    Response 200 · billing · anyOf 1.refundType · anyOf 3Alternative
    
    "full"
- Response 200 · billing · anyOf 2Alternative
  
  null
Response 200 · capabilitiesRequired

object

Unknown fields are not accepted.
21 fields
- Response 200 · capabilities.canEditManagedSceneRequired
  
  boolean
- Response 200 · capabilities.canEditSceneFramingRequired
  
  boolean
- Response 200 · capabilities.canEditSceneImageRequired
  
  boolean
- Response 200 · capabilities.canEditScenePromptRequired
  
  boolean
- Response 200 · capabilities.canFinalizeRequired
  
  boolean
- Response 200 · capabilities.canLockCharacterRequired
  
  boolean
- Response 200 · capabilities.canPatchStageOutputRequired
  
  boolean
- Response 200 · capabilities.canRecomposeRequired
  
  boolean
- Response 200 · capabilities.canRefreshFinalUrlRequired
  
  boolean
- Response 200 · capabilities.canRegenerateSceneImageRequired
  
  boolean
- Response 200 · capabilities.canRenderSceneRequired
  
  boolean
- Response 200 · capabilities.canRerenderSceneWithImagesRequired
  
  boolean
- Response 200 · capabilities.canRerenderSceneWithPromptRequired
  
  boolean
- Response 200 · capabilities.canRetryFinalizeRequired
  
  boolean
- Response 200 · capabilities.canSelectRenderingRequired
  
  boolean
- Response 200 · capabilities.canTriggerRenderRequired
  
  boolean
- Response 200 · capabilities.canUseCurrentFinalRequired
  
  boolean
- Response 200 · capabilities.requiresFinalizeRequired
  
  boolean
- Response 200 · capabilities.editShotTypesOptional
  
  array<"narrative" | "lipsync" | "performance" | "dance">
  
  Omn V1 shot-engine MVs only (absent for other MVs): the shot types POST /api/v1/mv/{mvId}/scenes/{idx}/render accepts in shotType on this MV, in a fixed order (narrative, lipsync, performance, dance): the MV's planned shot types except bridge. Each edit is still validated per scene before any charge: the scene must fit the shot type's length and be renderable with its reference images (400 VALIDATION_ERROR otherwise).
  1 field
  - Response 200 · capabilities.editShotTypes[]Each item
    
    "narrative" | "lipsync" | "performance" | "dance"
- Response 200 · capabilities.finalizeActionOptional
  
  "finalize" | "recompose" | "retry_finalize" | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · capabilities.finalizeAction · anyOf 1Alternative
    
    "finalize" | "recompose" | "retry_finalize"
    
    Must match at least one alternative.
    
    3 fields / alternatives
    
    Response 200 · capabilities.finalizeAction · anyOf 1 · anyOf 1Alternative
    
    "finalize"
    
    Response 200 · capabilities.finalizeAction · anyOf 1 · anyOf 2Alternative
    
    "recompose"
    
    Response 200 · capabilities.finalizeAction · anyOf 1 · anyOf 3Alternative
    
    "retry_finalize"
  - Response 200 · capabilities.finalizeAction · anyOf 2Alternative
    
    null
- Response 200 · capabilities.upgradeOptional
  
  object
  
  Omn V1 shot-engine MVs only (absent for other MVs): whether POST /api/v1/mv/{mvId}/upgrade can be requested now.
  
  Unknown fields are not accepted.
  4 fields
  - Response 200 · capabilities.upgrade.availableRequired
    
    boolean
    
    True when the MV passes the upgrade's deterministic checks now. POST /api/v1/mv/{mvId}/upgrade/preflight remains authoritative: it also checks every scene against the target tier's shots (scene length, reference images, identity image order), engine and account availability and the price, and can still reject an MV reported as available.
  - Response 200 · capabilities.upgrade.reasonRequired
    
    "not_shot_engine" | "subtitles" | "motion_transfer" | "highest_tier" | "mv_not_complete" | "operation_in_progress" | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · capabilities.upgrade.reason · anyOf 1Alternative
    
    "not_shot_engine" | "subtitles" | "motion_transfer" | "highest_tier" | "mv_not_complete" | "operation_in_progress"
    
    Why the MV cannot be upgraded now, first failing check in this order. not_shot_engine: the MV was not produced by the Omn V1 shot engine; subtitles: the MV has burned-in subtitles; motion_transfer: the MV was planned for motion transfer (Premium V2 dance with generation.motionReferenceVideo on a 16:9 or 9:16 canvas); highest_tier: no higher render tier exists for this MV's contract (ultra MVs). These four never change for the MV, and the upgrade endpoints answer them with 422 MV_ENGINE_UNSUPPORTED (reason not_eligible). mv_not_complete: the MV or its final is not READY yet; operation_in_progress: another operation on this MV (an edit, a composition or an upgrade) is still running. These two are temporary and match 409 MV_PRECONDITION_FAILED with the same details.reason.
    
    Must match at least one alternative.
    
    6 fields / alternatives
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 1Alternative
    
    "not_shot_engine"
    
    1 field
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 1See schema
    
    "not_shot_engine"
    
    Expand this value in the interactive reference.
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 2Alternative
    
    "subtitles"
    
    1 field
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 2See schema
    
    "subtitles"
    
    Expand this value in the interactive reference.
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 3Alternative
    
    "motion_transfer"
    
    1 field
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 3See schema
    
    "motion_transfer"
    
    Expand this value in the interactive reference.
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 4Alternative
    
    "highest_tier"
    
    1 field
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 4See schema
    
    "highest_tier"
    
    Expand this value in the interactive reference.
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 5Alternative
    
    "mv_not_complete"
    
    1 field
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 5See schema
    
    "mv_not_complete"
    
    Expand this value in the interactive reference.
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 6Alternative
    
    "operation_in_progress"
    
    1 field
    
    Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 6See schema
    
    "operation_in_progress"
    
    Expand this value in the interactive reference.
    
    Response 200 · capabilities.upgrade.reason · anyOf 2Alternative
    
    null
  - Response 200 · capabilities.upgrade.minimumDurationSecOptional
    
    number
    
    Effective duration required for a new full-MV upgrade. When an existing MV is shorter, available is false, reason is null and renderTiers is empty. Previously purchased operations still recover with their original key and charge.
    
    Minimum: 1.
  - Response 200 · capabilities.upgrade.resolutionsOptional
    
    array<"540p" | "720p" | "1080p" | "1440p">
    
    1 field
    
    Response 200 · capabilities.upgrade.resolutions[]Each item
    
    "540p" | "720p" | "1080p" | "1440p"
    
    Delivery resolution. Default 540p. 1440p is available only with generation.engineVersion="omn-v1"; other engines return MV_RESOLUTION_INVALID.
Response 200 · characterAnchorRequired

object | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · characterAnchor · anyOf 1Alternative
  
  object
  
  Unknown fields are not accepted.
  1 field
  - Response 200 · characterAnchor · anyOf 1.urlRequired
    
    string
- Response 200 · characterAnchor · anyOf 2Alternative
  
  null
Response 200 · contractVersionRequired

"v2"
Response 200 · costSummaryRequired

object

Unknown fields are not accepted.
5 fields
- Response 200 · costSummary.authorizedCreditsRequired
  
  number
- Response 200 · costSummary.chargedCreditsRequired
  
  number
- Response 200 · costSummary.netSpentCreditsRequired
  
  number
- Response 200 · costSummary.operationCountRequired
  
  number
- Response 200 · costSummary.refundedCreditsRequired
  
  number
Response 200 · createdAtRequired

string
Response 200 · customerActionRequired

"review" | "retry" | "fix_input" | "contact_support" | "wait" | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · customerAction · anyOf 1Alternative
  
  "review" | "retry" | "fix_input" | "contact_support" | "wait"
  
  Must match at least one alternative.
  5 fields / alternatives
  - Response 200 · customerAction · anyOf 1 · anyOf 1Alternative
    
    "review"
  - Response 200 · customerAction · anyOf 1 · anyOf 2Alternative
    
    "retry"
  - Response 200 · customerAction · anyOf 1 · anyOf 3Alternative
    
    "fix_input"
  - Response 200 · customerAction · anyOf 1 · anyOf 4Alternative
    
    "contact_support"
  - Response 200 · customerAction · anyOf 1 · anyOf 5Alternative
    
    "wait"
- Response 200 · customerAction · anyOf 2Alternative
  
  null
Response 200 · deliveryStatusRequired

"drafting" | "incomplete" | "rendering" | "packaging" | "ready" | "failed"
Response 200 · failedAtRequired

string | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · failedAt · anyOf 1Alternative
  
  string
- Response 200 · failedAt · anyOf 2Alternative
  
  null
Response 200 · failureCategoryRequired

"customer_input" | "provider_unavailable" | "provider_failed" | "provider_timeout" | "platform_storage_failed" | "subtitle_failed" | "finalization_failed" | "unknown" | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · failureCategory · anyOf 1Alternative
  
  "customer_input" | "provider_unavailable" | "provider_failed" | "provider_timeout" | "platform_storage_failed" | "subtitle_failed" | "finalization_failed" | "unknown"
  
  Must match at least one alternative.
  8 fields / alternatives
  - Response 200 · failureCategory · anyOf 1 · anyOf 1Alternative
    
    "customer_input"
  - Response 200 · failureCategory · anyOf 1 · anyOf 2Alternative
    
    "provider_unavailable"
  - Response 200 · failureCategory · anyOf 1 · anyOf 3Alternative
    
    "provider_failed"
  - Response 200 · failureCategory · anyOf 1 · anyOf 4Alternative
    
    "provider_timeout"
  - Response 200 · failureCategory · anyOf 1 · anyOf 5Alternative
    
    "platform_storage_failed"
  - Response 200 · failureCategory · anyOf 1 · anyOf 6Alternative
    
    "subtitle_failed"
  - Response 200 · failureCategory · anyOf 1 · anyOf 7Alternative
    
    "finalization_failed"
  - Response 200 · failureCategory · anyOf 1 · anyOf 8Alternative
    
    "unknown"
- Response 200 · failureCategory · anyOf 2Alternative
  
  null
Response 200 · failureReasonRequired

object | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · failureReason · anyOf 1Alternative
  
  object
  
  Unknown fields are not accepted.
  2 fields
  - Response 200 · failureReason · anyOf 1.codeRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · failureReason · anyOf 1.code · anyOf 1Alternative
    
    string
    
    Response 200 · failureReason · anyOf 1.code · anyOf 2Alternative
    
    null
  - Response 200 · failureReason · anyOf 1.messageRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · failureReason · anyOf 1.message · anyOf 1Alternative
    
    string
    
    Response 200 · failureReason · anyOf 1.message · anyOf 2Alternative
    
    null
- Response 200 · failureReason · anyOf 2Alternative
  
  null
Response 200 · finalMvRequired

object | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · finalMv · anyOf 1Alternative
  
  object
  
  Unknown fields are not accepted.
  15 fields
  - Response 200 · finalMv · anyOf 1.durationSecRequired
    
    number | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · finalMv · anyOf 1.durationSec · anyOf 1Alternative
    
    number
    
    Response 200 · finalMv · anyOf 1.durationSec · anyOf 2Alternative
    
    null
  - Response 200 · finalMv · anyOf 1.expiresAtRequired
    
    string
  - Response 200 · finalMv · anyOf 1.finalizationRequiredRequired
    
    boolean
  - Response 200 · finalMv · anyOf 1.finalizedVersionRequired
    
    number | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · finalMv · anyOf 1.finalizedVersion · anyOf 1Alternative
    
    number
    
    Response 200 · finalMv · anyOf 1.finalizedVersion · anyOf 2Alternative
    
    null
  - Response 200 · finalMv · anyOf 1.idRequired
    
    string
  - Response 200 · finalMv · anyOf 1.isCurrentRequired
    
    boolean
  - Response 200 · finalMv · anyOf 1.resolutionRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · finalMv · anyOf 1.resolution · anyOf 1Alternative
    
    string
    
    Response 200 · finalMv · anyOf 1.resolution · anyOf 2Alternative
    
    null
  - Response 200 · finalMv · anyOf 1.sourceVersionRequired
    
    number
  - Response 200 · finalMv · anyOf 1.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 · finalMv · anyOf 1.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 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 1Alternative
    
    "missing_final"
    
    1 field
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 1See schema
    
    "missing_final"
    
    Expand this value in the interactive reference.
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 2Alternative
    
    "final_processing"
    
    1 field
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 2See schema
    
    "final_processing"
    
    Expand this value in the interactive reference.
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 3Alternative
    
    "final_expired"
    
    1 field
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 3See schema
    
    "final_expired"
    
    Expand this value in the interactive reference.
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 4Alternative
    
    "source_rendering"
    
    1 field
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 4See schema
    
    "source_rendering"
    
    Expand this value in the interactive reference.
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 5Alternative
    
    "source_failed"
    
    1 field
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 5See schema
    
    "source_failed"
    
    Expand this value in the interactive reference.
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 6Alternative
    
    "source_changed"
    
    1 field
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 6See schema
    
    "source_changed"
    
    Expand this value in the interactive reference.
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 7Alternative
    
    "composition_unknown"
    
    1 field
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 7See schema
    
    "composition_unknown"
    
    Expand this value in the interactive reference.
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 8Alternative
    
    "url_unavailable"
    
    1 field
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 1 · anyOf 8See schema
    
    "url_unavailable"
    
    Expand this value in the interactive reference.
    
    Response 200 · finalMv · anyOf 1.staleReason · anyOf 2Alternative
    
    null
  - Response 200 · finalMv · anyOf 1.statusRequired
    
    "PROCESSING" | "READY" | "EXPIRED"
    
    Must match at least one alternative.
    
    3 fields / alternatives
    
    Response 200 · finalMv · anyOf 1.status · anyOf 1Alternative
    
    "PROCESSING"
    
    Response 200 · finalMv · anyOf 1.status · anyOf 2Alternative
    
    "READY"
    
    Response 200 · finalMv · anyOf 1.status · anyOf 3Alternative
    
    "EXPIRED"
  - Response 200 · finalMv · anyOf 1.videoUrlRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · finalMv · anyOf 1.videoUrl · anyOf 1Alternative
    
    string
    
    Response 200 · finalMv · anyOf 1.videoUrl · anyOf 2Alternative
    
    null
  - Response 200 · finalMv · anyOf 1.assetIdOptional
    
    string
  - Response 200 · finalMv · anyOf 1.assetStatusOptional
    
    "READY" | "EXPIRED" | "DELETING" | "DELETED"
    
    Must match at least one alternative.
    
    4 fields / alternatives
    
    Response 200 · finalMv · anyOf 1.assetStatus · anyOf 1Alternative
    
    "READY"
    
    Response 200 · finalMv · anyOf 1.assetStatus · anyOf 2Alternative
    
    "EXPIRED"
    
    Response 200 · finalMv · anyOf 1.assetStatus · anyOf 3Alternative
    
    "DELETING"
    
    Response 200 · finalMv · anyOf 1.assetStatus · anyOf 4Alternative
    
    "DELETED"
  - Response 200 · finalMv · anyOf 1.retainedUntilOptional
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · finalMv · anyOf 1.retainedUntil · anyOf 1Alternative
    
    string
    
    Response 200 · finalMv · anyOf 1.retainedUntil · anyOf 2Alternative
    
    null
  - Response 200 · finalMv · anyOf 1.urlExpiresAtOptional
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · finalMv · anyOf 1.urlExpiresAt · anyOf 1Alternative
    
    string
    
    Response 200 · finalMv · anyOf 1.urlExpiresAt · anyOf 2Alternative
    
    null
- Response 200 · finalMv · anyOf 2Alternative
  
  null
Response 200 · finalUrlRequired

string | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · finalUrl · anyOf 1Alternative
  
  string
- Response 200 · finalUrl · 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 · generationTaskIdRequired

string | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · generationTaskId · anyOf 1Alternative
  
  string
- Response 200 · generationTaskId · anyOf 2Alternative
  
  null
Response 200 · lastErrorCodeRequired

string | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · lastErrorCode · anyOf 1Alternative
  
  string
- Response 200 · lastErrorCode · anyOf 2Alternative
  
  null
Response 200 · lastErrorMessageRequired

string | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · lastErrorMessage · anyOf 1Alternative
  
  string
- Response 200 · lastErrorMessage · anyOf 2Alternative
  
  null
Response 200 · mvIdRequired

string
Response 200 · progressRequired

number

Minimum: 0. Maximum: 100.
Response 200 · promptRequired

string | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · prompt · anyOf 1Alternative
  
  string
- Response 200 · prompt · anyOf 2Alternative
  
  null
Response 200 · referenceImagesRequired

array<object>
1 field
- Response 200 · referenceImages[]Each item
  
  object
  
  Unknown fields are not accepted.
  2 fields
  - Response 200 · referenceImages[].sourceRequired
    
    "user" | "auto_visual_board"
  - Response 200 · referenceImages[].urlRequired
    
    string
Response 200 · refundableRequired

boolean
Response 200 · retryableRequired

boolean
Response 200 · scenesRequired

array<object>
1 field
- Response 200 · scenes[]Each item
  
  object
  
  Unknown fields are not accepted.
  16 fields
  - Response 200 · scenes[].endSecRequired
    
    number
  - Response 200 · scenes[].framingRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].framing · anyOf 1Alternative
    
    string
    
    Response 200 · scenes[].framing · anyOf 2Alternative
    
    null
  - Response 200 · scenes[].imagePromptRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].imagePrompt · anyOf 1Alternative
    
    string
    
    Response 200 · scenes[].imagePrompt · anyOf 2Alternative
    
    null
  - Response 200 · scenes[].imageUrlRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].imageUrl · anyOf 1Alternative
    
    string
    
    Response 200 · scenes[].imageUrl · anyOf 2Alternative
    
    null
  - Response 200 · scenes[].indexRequired
    
    number
  - Response 200 · scenes[].lyricsWindowRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].lyricsWindow · anyOf 1Alternative
    
    string
    
    Response 200 · scenes[].lyricsWindow · anyOf 2Alternative
    
    null
  - Response 200 · scenes[].promptRequired
    
    string
  - Response 200 · scenes[].renderingHistoryRequired
    
    array<object>
    
    1 field
    
    Response 200 · scenes[].renderingHistory[]Each item
    
    object
    
    Unknown fields are not accepted.
    
    13 fields
    
    Response 200 · scenes[].renderingHistory[].createdAtRequired
    
    string
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].createdAtSee schema
    
    string
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].renderingHistory[].durationSecRequired
    
    number
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].durationSecSee schema
    
    number
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].renderingHistory[].idRequired
    
    string
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].idSee schema
    
    string
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].renderingHistory[].isSelectableRequired
    
    boolean
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].isSelectableSee schema
    
    boolean
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].renderingHistory[].isSelectedRequired
    
    boolean
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].isSelectedSee schema
    
    boolean
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].renderingHistory[].videoUrlRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].videoUrlSee schema
    
    string | null
    
    Expand this value in the interactive reference.
    
    May be null. Must match at least one alternative.
    
    Response 200 · scenes[].renderingHistory[].assetIdOptional
    
    string
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].assetIdSee schema
    
    string
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].renderingHistory[].assetStatusOptional
    
    "READY" | "EXPIRED" | "DELETING" | "DELETED"
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].assetStatusSee schema
    
    "READY" | "EXPIRED" | "DELETING" | "DELETED"
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].renderingHistory[].promptOptional
    
    string | null
    
    May be null. Must match at least one alternative.
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].promptSee schema
    
    string | null
    
    Expand this value in the interactive reference.
    
    May be null. Must match at least one alternative.
    
    Response 200 · scenes[].renderingHistory[].referenceImagesOptional
    
    array<string>
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].referenceImagesSee schema
    
    array<string>
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].renderingHistory[].retainedUntilOptional
    
    string | null
    
    May be null. Must match at least one alternative.
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].retainedUntilSee schema
    
    string | null
    
    Expand this value in the interactive reference.
    
    May be null. Must match at least one alternative.
    
    Response 200 · scenes[].renderingHistory[].shotTypeOptional
    
    "narrative" | "lipsync" | "performance" | "dance" | "bridge" | null
    
    May be null. Must match at least one alternative.
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].shotTypeSee schema
    
    "narrative" | "lipsync" | "performance" | "dance" | "bridge" | null
    
    Expand this value in the interactive reference.
    
    May be null. Must match at least one alternative.
    
    Response 200 · scenes[].renderingHistory[].urlExpiresAtOptional
    
    string | null
    
    May be null. Must match at least one alternative.
    
    1 field
    
    Response 200 · scenes[].renderingHistory[].urlExpiresAtSee schema
    
    string | null
    
    Expand this value in the interactive reference.
    
    May be null. Must match at least one alternative.
  - Response 200 · scenes[].startSecRequired
    
    number
  - Response 200 · scenes[].statusRequired
    
    "PLANNED" | "IMAGE_READY" | "RENDERING" | "READY" | "FAILED" | "STALE"
  - Response 200 · scenes[].videoPromptRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].videoPrompt · anyOf 1Alternative
    
    string
    
    Response 200 · scenes[].videoPrompt · anyOf 2Alternative
    
    null
  - Response 200 · scenes[].videoUrlRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].videoUrl · anyOf 1Alternative
    
    string
    
    Response 200 · scenes[].videoUrl · anyOf 2Alternative
    
    null
  - Response 200 · scenes[].imageAssetIdOptional
    
    string
  - Response 200 · scenes[].imageRetainedUntilOptional
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].imageRetainedUntil · anyOf 1Alternative
    
    string
    
    Response 200 · scenes[].imageRetainedUntil · anyOf 2Alternative
    
    null
  - Response 200 · scenes[].imageUrlExpiresAtOptional
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].imageUrlExpiresAt · anyOf 1Alternative
    
    string
    
    Response 200 · scenes[].imageUrlExpiresAt · anyOf 2Alternative
    
    null
  - Response 200 · scenes[].sourceJobOptional
    
    object | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · scenes[].sourceJob · anyOf 1Alternative
    
    object
    
    Unknown fields are not accepted.
    
    6 fields
    
    Response 200 · scenes[].sourceJob · anyOf 1.createdAtRequired
    
    string
    
    1 field
    
    Response 200 · scenes[].sourceJob · anyOf 1.createdAtSee schema
    
    string
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].sourceJob · anyOf 1.errorCodeRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    1 field
    
    Response 200 · scenes[].sourceJob · anyOf 1.errorCodeSee schema
    
    string | null
    
    Expand this value in the interactive reference.
    
    May be null. Must match at least one alternative.
    
    Response 200 · scenes[].sourceJob · anyOf 1.errorMessageRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    1 field
    
    Response 200 · scenes[].sourceJob · anyOf 1.errorMessageSee schema
    
    string | null
    
    Expand this value in the interactive reference.
    
    May be null. Must match at least one alternative.
    
    Response 200 · scenes[].sourceJob · anyOf 1.idRequired
    
    string
    
    1 field
    
    Response 200 · scenes[].sourceJob · anyOf 1.idSee schema
    
    string
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].sourceJob · anyOf 1.isComposableRequired
    
    boolean
    
    1 field
    
    Response 200 · scenes[].sourceJob · anyOf 1.isComposableSee schema
    
    boolean
    
    Expand this value in the interactive reference.
    
    Response 200 · scenes[].sourceJob · anyOf 1.statusRequired
    
    "PLANNED" | "IMAGE_READY" | "RENDERING" | "READY" | "FAILED" | "STALE"
    
    Must match at least one alternative.
    
    1 field
    
    Response 200 · scenes[].sourceJob · anyOf 1.statusSee schema
    
    "PLANNED" | "IMAGE_READY" | "RENDERING" | "READY" | "FAILED" | "STALE"
    
    Expand this value in the interactive reference.
    
    Must match at least one alternative.
    
    Response 200 · scenes[].sourceJob · anyOf 2Alternative
    
    null
Response 200 · sourceRequired

object

Unknown fields are not accepted.
7 fields
- Response 200 · source.durationSecRequired
  
  number
- Response 200 · source.typeRequired
  
  "suno" | "audio"
- Response 200 · source.audioUrlOptional
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · source.audioUrl · anyOf 1Alternative
    
    string
  - Response 200 · source.audioUrl · anyOf 2Alternative
    
    null
- Response 200 · source.clipIdOptional
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · source.clipId · anyOf 1Alternative
    
    string
  - Response 200 · source.clipId · anyOf 2Alternative
    
    null
- Response 200 · source.lyricsOptional
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · source.lyrics · anyOf 1Alternative
    
    string
  - Response 200 · source.lyrics · anyOf 2Alternative
    
    null
- Response 200 · source.rangeOptional
  
  object | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · source.range · anyOf 1Alternative
    
    object
    
    Unknown fields are not accepted.
    
    2 fields
    
    Response 200 · source.range · anyOf 1.endSecOptional
    
    number
    
    Minimum: 0.
    
    Response 200 · source.range · anyOf 1.startSecOptional
    
    number
    
    Minimum: 0.
  - Response 200 · source.range · anyOf 2Alternative
    
    null
- Response 200 · source.sourceDurationSecOptional
  
  number | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · source.sourceDurationSec · anyOf 1Alternative
    
    number
  - Response 200 · source.sourceDurationSec · anyOf 2Alternative
    
    null
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

"PENDING" | "GENERATING" | "ACTION_REQUIRED" | "READY" | "RENDERING" | "FINALIZING" | "COMPLETED" | "EDITING" | "FAILED" | "ARCHIVED" | "DELETED"
Response 200 · titleRequired

string | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · title · anyOf 1Alternative
  
  string
- Response 200 · title · anyOf 2Alternative
  
  null
Response 200 · updatedAtRequired

string
Response 200 · versionRequired

number
Response 200 · warningCodesRequired

array<string>
1 field
- Response 200 · warningCodes[]Each item
  
  string
  
  MV advisory warning codes. MV_CREATIVE_PLANNING_FROM_UNVERIFIED_TRANSCRIPT means recognized text was used for creative planning; MV_CREATIVE_PLANNING_WITHOUT_LYRICS means no usable lyric semantics were used. These two codes are mutually exclusive in the final plan. Customer lyrics with machine-estimated timing use MV_AUDIO_SUBTITLE_TIMING_UNVERIFIED instead. 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 · 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 · highlightOptional

object | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · highlight · anyOf 1Alternative
  
  object
  
  Unknown fields are not accepted.
  3 fields
  - Response 200 · highlight · anyOf 1.durationSecRequired
    
    number
  - Response 200 · highlight · anyOf 1.startSecRequired
    
    number
  - Response 200 · highlight · anyOf 1.urlRequired
    
    string
- Response 200 · highlight · anyOf 2Alternative
  
  null
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 · qualityReviewUrlOptional

string | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · qualityReviewUrl · anyOf 1Alternative
  
  string
- Response 200 · qualityReviewUrl · anyOf 2Alternative
  
  null
Response 200 · qualityStatusOptional

"pending" | "not_evaluated" | "human_review_required" | "needs_revision"

Creative acceptance, independent of delivery status. Completion does not imply a passing score.
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.
Response 200 · terminationReasonOptional

"cancelled" | "failed" | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · terminationReason · anyOf 1Alternative
  
  "cancelled" | "failed"
  
  Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · terminationReason · anyOf 1 · anyOf 1Alternative
    
    "cancelled"
  - Response 200 · terminationReason · anyOf 1 · anyOf 2Alternative
    
    "failed"
- Response 200 · terminationReason · 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

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

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

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

import os
import requests

response = requests.request(
    "GET", "https://api.omnapi.com/api/v2/mv/{mvId}",
    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

Read Omn MV

Request

Responses

Response 200 · billingRequired

Response 200 · billing · anyOf 1Alternative

Response 200 · billing · anyOf 1.creditsChargedRequired

Response 200 · billing · anyOf 1.creditsCharged · anyOf 1Alternative

Response 200 · billing · anyOf 1.creditsCharged · anyOf 2Alternative

Response 200 · billing · anyOf 1.creditsReservedRequired

Response 200 · billing · anyOf 1.refundReasonRequired

Response 200 · billing · anyOf 1.refundReason · anyOf 1Alternative

Response 200 · billing · anyOf 1.refundReason · anyOf 2Alternative

Response 200 · billing · anyOf 1.refundedCreditsRequired

Response 200 · billing · anyOf 1.settlementStatusRequired

Response 200 · billing · anyOf 1.settlementStatus · anyOf 1Alternative

Response 200 · billing · anyOf 1.settlementStatus · anyOf 2Alternative

Response 200 · billing · anyOf 1.settlementStatus · anyOf 3Alternative

Response 200 · billing · anyOf 1.refundTypeOptional

Response 200 · billing · anyOf 1.refundType · anyOf 1Alternative

Response 200 · billing · anyOf 1.refundType · anyOf 2Alternative

Response 200 · billing · anyOf 1.refundType · anyOf 3Alternative

Response 200 · billing · anyOf 2Alternative

Response 200 · capabilitiesRequired

Response 200 · capabilities.canEditManagedSceneRequired

Response 200 · capabilities.canEditSceneFramingRequired

Response 200 · capabilities.canEditSceneImageRequired

Response 200 · capabilities.canEditScenePromptRequired

Response 200 · capabilities.canFinalizeRequired

Response 200 · capabilities.canLockCharacterRequired

Response 200 · capabilities.canPatchStageOutputRequired

Response 200 · capabilities.canRecomposeRequired

Response 200 · capabilities.canRefreshFinalUrlRequired

Response 200 · capabilities.canRegenerateSceneImageRequired

Response 200 · capabilities.canRenderSceneRequired

Response 200 · capabilities.canRerenderSceneWithImagesRequired

Response 200 · capabilities.canRerenderSceneWithPromptRequired

Response 200 · capabilities.canRetryFinalizeRequired

Response 200 · capabilities.canSelectRenderingRequired

Response 200 · capabilities.canTriggerRenderRequired

Response 200 · capabilities.canUseCurrentFinalRequired

Response 200 · capabilities.requiresFinalizeRequired

Response 200 · capabilities.editShotTypesOptional

Response 200 · capabilities.editShotTypes[]Each item

Response 200 · capabilities.finalizeActionOptional

Response 200 · capabilities.finalizeAction · anyOf 1Alternative

Response 200 · capabilities.finalizeAction · anyOf 1 · anyOf 1Alternative

Response 200 · capabilities.finalizeAction · anyOf 1 · anyOf 2Alternative

Response 200 · capabilities.finalizeAction · anyOf 1 · anyOf 3Alternative

Response 200 · capabilities.finalizeAction · anyOf 2Alternative

Response 200 · capabilities.upgradeOptional

Response 200 · capabilities.upgrade.availableRequired

Response 200 · capabilities.upgrade.reasonRequired

Response 200 · capabilities.upgrade.reason · anyOf 1Alternative

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 1Alternative

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 1See schema

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 2Alternative

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 2See schema

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 3Alternative

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 3See schema

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 4Alternative

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 4See schema

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 5Alternative

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 5See schema

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 6Alternative

Response 200 · capabilities.upgrade.reason · anyOf 1 · anyOf 6See schema

Response 200 · capabilities.upgrade.reason · anyOf 2Alternative

Response 200 · capabilities.upgrade.minimumDurationSecOptional

Response 200 · capabilities.upgrade.resolutionsOptional

Response 200 · capabilities.upgrade.resolutions[]Each item

Response 200 · characterAnchorRequired

Response 200 · characterAnchor · anyOf 1Alternative

Response 200 · characterAnchor · anyOf 1.urlRequired

Response 200 · characterAnchor · anyOf 2Alternative

Response 200 · contractVersionRequired

Response 200 · costSummaryRequired

Response 200 · costSummary.authorizedCreditsRequired

Response 200 · costSummary.chargedCreditsRequired

Response 200 · costSummary.netSpentCreditsRequired

Response 200 · costSummary.operationCountRequired

Response 200 · costSummary.refundedCreditsRequired

Response 200 · `billing`Required

Response 200 · `billing · anyOf 1`Alternative

Response 200 · `billing · anyOf 1.creditsCharged`Required

Response 200 · `billing · anyOf 1.creditsCharged · anyOf 1`Alternative

Response 200 · `billing · anyOf 1.creditsCharged · anyOf 2`Alternative

Response 200 · `billing · anyOf 1.creditsReserved`Required

Response 200 · `billing · anyOf 1.refundReason`Required

Response 200 · `billing · anyOf 1.refundReason · anyOf 1`Alternative

Response 200 · `billing · anyOf 1.refundReason · anyOf 2`Alternative

Response 200 · `billing · anyOf 1.refundedCredits`Required

Response 200 · `billing · anyOf 1.settlementStatus`Required

Response 200 · `billing · anyOf 1.settlementStatus · anyOf 1`Alternative

Response 200 · `billing · anyOf 1.settlementStatus · anyOf 2`Alternative

Response 200 · `billing · anyOf 1.settlementStatus · anyOf 3`Alternative

Response 200 · `billing · anyOf 1.refundType`Optional

Response 200 · `billing · anyOf 1.refundType · anyOf 1`Alternative

Response 200 · `billing · anyOf 1.refundType · anyOf 2`Alternative

Response 200 · `billing · anyOf 1.refundType · anyOf 3`Alternative

Response 200 · `billing · anyOf 2`Alternative

Response 200 · `capabilities`Required

Response 200 · `capabilities.canEditManagedScene`Required

Response 200 · `capabilities.canEditSceneFraming`Required

Response 200 · `capabilities.canEditSceneImage`Required

Response 200 · `capabilities.canEditScenePrompt`Required

Response 200 · `capabilities.canFinalize`Required

Response 200 · `capabilities.canLockCharacter`Required

Response 200 · `capabilities.canPatchStageOutput`Required

Response 200 · `capabilities.canRecompose`Required

Response 200 · `capabilities.canRefreshFinalUrl`Required

Response 200 · `capabilities.canRegenerateSceneImage`Required

Response 200 · `capabilities.canRenderScene`Required

Response 200 · `capabilities.canRerenderSceneWithImages`Required

Response 200 · `capabilities.canRerenderSceneWithPrompt`Required

Response 200 · `capabilities.canRetryFinalize`Required

Response 200 · `capabilities.canSelectRendering`Required

Response 200 · `capabilities.canTriggerRender`Required

Response 200 · `capabilities.canUseCurrentFinal`Required

Response 200 · `capabilities.requiresFinalize`Required

Response 200 · `capabilities.editShotTypes`Optional

Response 200 · `capabilities.editShotTypes[]`Each item

Response 200 · `capabilities.finalizeAction`Optional

Response 200 · `capabilities.finalizeAction · anyOf 1`Alternative

Response 200 · `capabilities.finalizeAction · anyOf 1 · anyOf 1`Alternative

Response 200 · `capabilities.finalizeAction · anyOf 1 · anyOf 2`Alternative

Response 200 · `capabilities.finalizeAction · anyOf 1 · anyOf 3`Alternative

Response 200 · `capabilities.finalizeAction · anyOf 2`Alternative

Response 200 · `capabilities.upgrade`Optional

Response 200 · `capabilities.upgrade.available`Required

Response 200 · `capabilities.upgrade.reason`Required

Response 200 · `capabilities.upgrade.reason · anyOf 1`Alternative

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 1`Alternative

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 1`See schema

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 2`Alternative

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 2`See schema

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 3`Alternative

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 3`See schema

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 4`Alternative

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 4`See schema

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 5`Alternative

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 5`See schema

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 6`Alternative

Response 200 · `capabilities.upgrade.reason · anyOf 1 · anyOf 6`See schema

Response 200 · `capabilities.upgrade.reason · anyOf 2`Alternative

Response 200 · `capabilities.upgrade.minimumDurationSec`Optional

Response 200 · `capabilities.upgrade.resolutions`Optional

Response 200 · `capabilities.upgrade.resolutions[]`Each item

Response 200 · `characterAnchor`Required

Response 200 · `characterAnchor · anyOf 1`Alternative

Response 200 · `characterAnchor · anyOf 1.url`Required

Response 200 · `characterAnchor · anyOf 2`Alternative

Response 200 · `contractVersion`Required

Response 200 · `costSummary`Required

Response 200 · `costSummary.authorizedCredits`Required

Response 200 · `costSummary.chargedCredits`Required

Response 200 · `costSummary.netSpentCredits`Required

Response 200 · `costSummary.operationCount`Required

Response 200 · `costSummary.refundedCredits`Required

Response 200 · `createdAt`Required

Response 200 · `customerAction`Required

Response 200 · `customerAction · anyOf 1`Alternative