Read v2 Omn workflow

GET/api/v2/mv/tasks/{id}/workflow

Authentication · x-api-key

Read the saved Omn workflow. Requires task:read scope and ownership; Tasks from a different product return a contract mismatch. Cursor-based events and artifacts retain their original ordering.

Request

idpath · Required

string

Resource identifier returned by the corresponding create operation.

Responses

200 OK

application/json

Unknown fields are not accepted.

Response 200 · activityRequired

object

Unknown fields are not accepted.
8 fields
- Response 200 · activity.deliveryDeadlineAtRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · activity.deliveryDeadlineAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
  - Response 200 · activity.deliveryDeadlineAt · anyOf 2Alternative
    
    null
- Response 200 · activity.labelRequired
  
  string
- Response 200 · activity.lastAdvancedAtRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · activity.lastAdvancedAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
  - Response 200 · activity.lastAdvancedAt · anyOf 2Alternative
    
    null
- Response 200 · activity.lastObservedAtRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · activity.lastObservedAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
  - Response 200 · activity.lastObservedAt · anyOf 2Alternative
    
    null
- Response 200 · activity.nextActionAtRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · activity.nextActionAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
  - Response 200 · activity.nextActionAt · anyOf 2Alternative
    
    null
- Response 200 · activity.phaseRequired
  
  string
- Response 200 · activity.stateRequired
  
  string
- Response 200 · activity.waitingSinceRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · activity.waitingSince · anyOf 1Alternative
    
    string
    
    Format: date-time.
  - Response 200 · activity.waitingSince · anyOf 2Alternative
    
    null
Response 200 · attemptsRequired

array<object>
1 field
- Response 200 · attempts[]Each item
  
  object
  
  Unknown fields are not accepted.
  4 fields
  - Response 200 · attempts[].createdAtRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · attempts[].createdAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
    
    Response 200 · attempts[].createdAt · anyOf 2Alternative
    
    null
  - Response 200 · attempts[].dispositionRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · attempts[].disposition · anyOf 1Alternative
    
    string
    
    Response 200 · attempts[].disposition · anyOf 2Alternative
    
    null
  - Response 200 · attempts[].idRequired
    
    string
  - Response 200 · attempts[].stateRequired
    
    string
Response 200 · billingRequired

object

Unknown fields are not accepted.
6 fields
- Response 200 · billing.debitedRequired
  
  string
- Response 200 · billing.finalRequired
  
  boolean
- Response 200 · billing.netRequired
  
  string
- Response 200 · billing.refundedRequired
  
  string
- Response 200 · billing.settlementRequired
  
  string
- Response 200 · billing.unitRequired
  
  "credit"
Response 200 · completionContractRequired

string
Response 200 · contractVersionRequired

"v2"
Response 200 · deliveryRequired

object

Unknown fields are not accepted.
6 fields
- Response 200 · delivery.assetIdRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · delivery.assetId · anyOf 1Alternative
    
    string
  - Response 200 · delivery.assetId · anyOf 2Alternative
    
    null
- Response 200 · delivery.availabilityVerifiedAtRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · delivery.availabilityVerifiedAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
  - Response 200 · delivery.availabilityVerifiedAt · anyOf 2Alternative
    
    null
- Response 200 · delivery.currentVersionRequired
  
  boolean
- Response 200 · delivery.persistedSegmentCountRequired
  
  integer
- Response 200 · delivery.stateRequired
  
  "none" | "partial" | "ready" | "stale" | "expired" | "deleted"
- Response 200 · delivery.totalSegmentCountRequired
  
  integer | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · delivery.totalSegmentCount · anyOf 1Alternative
    
    integer
  - Response 200 · delivery.totalSegmentCount · anyOf 2Alternative
    
    null
Response 200 · freshnessRequired

object

Unknown fields are not accepted.
6 fields
- Response 200 · freshness.eventCursorRequired
  
  string
- Response 200 · freshness.historyRequired
  
  "tracked" | "legacy_incomplete"
- Response 200 · freshness.missingFactsRequired
  
  array<string>
  1 field
  - Response 200 · freshness.missingFacts[]Each item
    
    string
- Response 200 · freshness.pendingEventsRequired
  
  boolean
- Response 200 · freshness.readAtRequired
  
  string
  
  Format: date-time.
- Response 200 · freshness.sourceRequired
  
  "database_snapshot"
Response 200 · issueRequired

object | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · issue · anyOf 1Alternative
  
  object
  
  Unknown fields are not accepted.
  6 fields
  - Response 200 · issue · anyOf 1.attributionSourceRequired
    
    "provider_code" | "platform_code" | "unknown"
    
    Must match at least one alternative.
    
    3 fields / alternatives
    
    Response 200 · issue · anyOf 1.attributionSource · anyOf 1Alternative
    
    "provider_code"
    
    Response 200 · issue · anyOf 1.attributionSource · anyOf 2Alternative
    
    "platform_code"
    
    Response 200 · issue · anyOf 1.attributionSource · anyOf 3Alternative
    
    "unknown"
  - Response 200 · issue · anyOf 1.categoryRequired
    
    string
  - Response 200 · issue · anyOf 1.codeRequired
    
    string
  - Response 200 · issue · anyOf 1.evidenceIdsRequired
    
    array<string>
    
    1 field
    
    Response 200 · issue · anyOf 1.evidenceIds[]Each item
    
    string
  - Response 200 · issue · anyOf 1.messageRequired
    
    string
  - Response 200 · issue · anyOf 1.phaseRequired
    
    string
- Response 200 · issue · anyOf 2Alternative
  
  null
Response 200 · lifecycleRequired

string
Response 200 · linksRequired

object

Unknown fields are not accepted.
4 fields
- Response 200 · links.artifactsRequired
  
  string
- Response 200 · links.streamRequired
  
  string
- Response 200 · links.summaryRequired
  
  string
- Response 200 · links.timelineRequired
  
  string
Response 200 · mvIdRequired

string | null

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

string
Response 200 · operationIdRequired

string | null

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

integer
Response 200 · progressRequired

object

Unknown fields are not accepted.
4 fields
- Response 200 · progress.modeRequired
  
  "indeterminate" | "measured"
- Response 200 · progress.percentRequired
  
  number | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · progress.percent · anyOf 1Alternative
    
    number
    
    Minimum: 0. Maximum: 100.
  - Response 200 · progress.percent · anyOf 2Alternative
    
    null
- Response 200 · progress.phasesRequired
  
  array<object>
  1 field
  - Response 200 · progress.phases[]Each item
    
    object
    
    Unknown fields are not accepted.
    
    16 fields
    
    Response 200 · progress.phases[].activeTimeMsRequired
    
    number | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · progress.phases[].activeTimeMs · anyOf 1Alternative
    
    number
    
    1 field
    
    Response 200 · progress.phases[].activeTimeMs · anyOf 1See schema
    
    number
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].activeTimeMs · anyOf 2Alternative
    
    null
    
    1 field
    
    Response 200 · progress.phases[].activeTimeMs · anyOf 2See schema
    
    null
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].attemptCountRequired
    
    integer
    
    Response 200 · progress.phases[].completedItemsRequired
    
    integer | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · progress.phases[].completedItems · anyOf 1Alternative
    
    integer
    
    1 field
    
    Response 200 · progress.phases[].completedItems · anyOf 1See schema
    
    integer
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].completedItems · anyOf 2Alternative
    
    null
    
    1 field
    
    Response 200 · progress.phases[].completedItems · anyOf 2See schema
    
    null
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].evidenceIdsRequired
    
    array<string>
    
    1 field
    
    Response 200 · progress.phases[].evidenceIds[]Each item
    
    string
    
    1 field
    
    Response 200 · progress.phases[].evidenceIds[]See schema
    
    string
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].finishedAtRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · progress.phases[].finishedAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
    
    1 field
    
    Response 200 · progress.phases[].finishedAt · anyOf 1See schema
    
    string
    
    Expand this value in the interactive reference.
    
    Format: date-time.
    
    Response 200 · progress.phases[].finishedAt · anyOf 2Alternative
    
    null
    
    1 field
    
    Response 200 · progress.phases[].finishedAt · anyOf 2See schema
    
    null
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].keyRequired
    
    string
    
    Response 200 · progress.phases[].labelRequired
    
    string
    
    Response 200 · progress.phases[].requiredRequired
    
    boolean
    
    Response 200 · progress.phases[].sourceRequired
    
    "runtime" | "resource" | "legacy_steps" | "unobserved"
    
    Response 200 · progress.phases[].startedAtRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · progress.phases[].startedAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
    
    1 field
    
    Response 200 · progress.phases[].startedAt · anyOf 1See schema
    
    string
    
    Expand this value in the interactive reference.
    
    Format: date-time.
    
    Response 200 · progress.phases[].startedAt · anyOf 2Alternative
    
    null
    
    1 field
    
    Response 200 · progress.phases[].startedAt · anyOf 2See schema
    
    null
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].stateRequired
    
    "not_started" | "running" | "waiting" | "completed" | "failed" | "skipped" | "unknown"
    
    Response 200 · progress.phases[].totalItemsRequired
    
    integer | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · progress.phases[].totalItems · anyOf 1Alternative
    
    integer
    
    1 field
    
    Response 200 · progress.phases[].totalItems · anyOf 1See schema
    
    integer
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].totalItems · anyOf 2Alternative
    
    null
    
    1 field
    
    Response 200 · progress.phases[].totalItems · anyOf 2See schema
    
    null
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].unitRequired
    
    string | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · progress.phases[].unit · anyOf 1Alternative
    
    string
    
    1 field
    
    Response 200 · progress.phases[].unit · anyOf 1See schema
    
    string
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].unit · anyOf 2Alternative
    
    null
    
    1 field
    
    Response 200 · progress.phases[].unit · anyOf 2See schema
    
    null
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].wallTimeMsRequired
    
    number | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · progress.phases[].wallTimeMs · anyOf 1Alternative
    
    number
    
    1 field
    
    Response 200 · progress.phases[].wallTimeMs · anyOf 1See schema
    
    number
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].wallTimeMs · anyOf 2Alternative
    
    null
    
    1 field
    
    Response 200 · progress.phases[].wallTimeMs · anyOf 2See schema
    
    null
    
    Expand this value in the interactive reference.
    
    Response 200 · progress.phases[].timingBasisOptional
    
    "native_acceptance_to_asset"
    
    Response 200 · progress.phases[].warningCodesOptional
    
    array<string>
    
    Confirmed non-blocking fallbacks in this phase. Original failed attempts remain in the execution evidence.
    
    1 field
    
    Response 200 · progress.phases[].warningCodes[]Each item
    
    string
    
    1 field
    
    Response 200 · progress.phases[].warningCodes[]See schema
    
    string
    
    Expand this value in the interactive reference.
- Response 200 · progress.reasonRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · progress.reason · anyOf 1Alternative
    
    string
  - Response 200 · progress.reason · anyOf 2Alternative
    
    null
Response 200 · recoveryRequired

object

Unknown fields are not accepted.
8 fields
- Response 200 · recovery.decisionCodeRequired
  
  string
- Response 200 · recovery.nextActionRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · recovery.nextAction · anyOf 1Alternative
    
    string
  - Response 200 · recovery.nextAction · anyOf 2Alternative
    
    null
- Response 200 · recovery.nextActionAtRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · recovery.nextActionAt · anyOf 1Alternative
    
    string
    
    Format: date-time.
  - Response 200 · recovery.nextActionAt · anyOf 2Alternative
    
    null
- Response 200 · recovery.originalTaskCanContinueRequired
  
  boolean
- Response 200 · recovery.providerResubmissionLimitRequired
  
  integer
- Response 200 · recovery.providerResubmissionLimitScopeRequired
  
  "segment" | "task"
- Response 200 · recovery.providerResubmissionsRequired
  
  integer
- Response 200 · recovery.stateRequired
  
  "not_needed" | "scheduled" | "reconciling" | "manual" | "stopped" | "unknown"
Response 200 · revisionRequired

string
Response 200 · schemaVersionRequired

"mv-workflow.v1"
Response 200 · sourceVersionRequired

integer | null

May be null. Must match at least one alternative.
2 fields / alternatives
- Response 200 · sourceVersion · anyOf 1Alternative
  
  integer
- Response 200 · sourceVersion · anyOf 2Alternative
  
  null
Response 200 · summaryRequired

string
Response 200 · taskIdRequired

string
Response 200 · terminalRequired

boolean
Response 200 · workItemsRequired

array<object>
1 field
- Response 200 · workItems[]Each item
  
  object
  
  Unknown fields are not accepted.
  6 fields
  - Response 200 · workItems[].attemptCountRequired
    
    integer | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · workItems[].attemptCount · anyOf 1Alternative
    
    integer
    
    Response 200 · workItems[].attemptCount · anyOf 2Alternative
    
    null
  - Response 200 · workItems[].idRequired
    
    string
  - Response 200 · workItems[].indexRequired
    
    integer
  - Response 200 · workItems[].kindRequired
    
    "segment" | "scene"
  - Response 200 · workItems[].persistedRequired
    
    boolean
  - Response 200 · workItems[].stateRequired
    
    string
Response 200 · workItemsScopeRequired

"mv_resource"
Response 200 · workflowVersionRequired

string
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 · qualityOptional

object

Unknown fields are not accepted.
16 fields
- Response 200 · quality.assessmentRequired
  
  "not_evaluated" | "needs_revision" | "human_review_required"
- Response 200 · quality.automaticRegenerationRequired
  
  false
- Response 200 · quality.coverageRequired
  
  string
- Response 200 · quality.evaluatorRequired
  
  string | null
  
  May be null. Must match at least one alternative.
  2 fields / alternatives
  - Response 200 · quality.evaluator · anyOf 1Alternative
    
    string
  - Response 200 · quality.evaluator · anyOf 2Alternative
    
    null
- Response 200 · quality.findingsRequired
  
  array<object>
  1 field
  - Response 200 · quality.findings[]Each item
    
    object
    
    Unknown fields are not accepted.
    
    8 fields
    
    Response 200 · quality.findings[].categoryRequired
    
    string
    
    Response 200 · quality.findings[].observationRequired
    
    string
    
    Response 200 · quality.findings[].sceneIndexesRequired
    
    array<integer>
    
    1 field
    
    Response 200 · quality.findings[].sceneIndexes[]Each item
    
    integer
    
    1 field
    
    Response 200 · quality.findings[].sceneIndexes[]See schema
    
    integer
    
    Expand this value in the interactive reference.
    
    Response 200 · quality.findings[].severityRequired
    
    string
    
    Response 200 · quality.findings[].verificationRequired
    
    string
    
    Response 200 · quality.findings[].basisOptional
    
    "user_requirement" | "director_plan" | "aesthetic" | "technical_observation"
    
    Response 200 · quality.findings[].releaseBlockingOptional
    
    false
    
    Response 200 · quality.findings[].requirementEvidenceOptional
    
    object | null
    
    May be null. Must match at least one alternative.
    
    2 fields / alternatives
    
    Response 200 · quality.findings[].requirementEvidence · anyOf 1Alternative
    
    object
    
    Unknown fields are not accepted.
    
    1 field
    
    Response 200 · quality.findings[].requirementEvidence · anyOf 1See schema
    
    object
    
    Expand this value in the interactive reference.
    
    Unknown fields are not accepted.
    
    Response 200 · quality.findings[].requirementEvidence · anyOf 2Alternative
    
    null
    
    1 field
    
    Response 200 · quality.findings[].requirementEvidence · anyOf 2See schema
    
    null
    
    Expand this value in the interactive reference.
- Response 200 · quality.frameBorderSceneIndexesRequired
  
  array<integer>
  1 field
  - Response 200 · quality.frameBorderSceneIndexes[]Each item
    
    integer
- Response 200 · quality.internalCutSceneIndexesRequired
  
  array<integer>
  1 field
  - Response 200 · quality.internalCutSceneIndexes[]Each item
    
    integer
- Response 200 · quality.lipSyncRequired
  
  "not_evaluated"
- Response 200 · quality.musicSyncRequired
  
  "not_evaluated"
- Response 200 · quality.observedMajorCountRequired
  
  integer
- Response 200 · quality.playbackReviewSceneIndexesRequired
  
  array<integer>
  1 field
  - Response 200 · quality.playbackReviewSceneIndexes[]Each item
    
    integer
- Response 200 · quality.reviewedSceneCountRequired
  
  integer
- Response 200 · quality.scopeRequired
  
  "this_operation"
- Response 200 · quality.suggestedRepairSceneIndexesRequired
  
  array<integer>
  1 field
  - Response 200 · quality.suggestedRepairSceneIndexes[]Each item
    
    integer
- Response 200 · quality.unreviewedSceneCountRequired
  
  integer
- Response 200 · quality.shotChecksOptional
  
  array<object>
  1 field
  - Response 200 · quality.shotChecks[]Each item
    
    object
    
    Unknown fields are not accepted.
    
    5 fields
    
    Response 200 · quality.shotChecks[].checkRequired
    
    string
    
    Response 200 · quality.shotChecks[].evaluatedScenesRequired
    
    integer
    
    Response 200 · quality.shotChecks[].failedScenesRequired
    
    integer
    
    Response 200 · quality.shotChecks[].notApplicableScenesRequired
    
    integer
    
    Response 200 · quality.shotChecks[].unevaluatedScenesRequired
    
    integer
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 · warningCodesOptional

array<string>

Maximum items: 16.
1 field
- Response 200 · warningCodes[]Each item
  
  string

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

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

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

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/tasks/{id}/workflow' \
  --header "x-api-key: $OMNAPI_KEY"

const response = await fetch("https://api.omnapi.com/api/v2/mv/tasks/{id}/workflow", {
  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/tasks/{id}/workflow",
    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 v2 Omn workflow

Request

Responses

Response 200 · activityRequired

Response 200 · activity.deliveryDeadlineAtRequired

Response 200 · activity.deliveryDeadlineAt · anyOf 1Alternative

Response 200 · activity.deliveryDeadlineAt · anyOf 2Alternative

Response 200 · activity.labelRequired

Response 200 · activity.lastAdvancedAtRequired

Response 200 · activity.lastAdvancedAt · anyOf 1Alternative

Response 200 · activity.lastAdvancedAt · anyOf 2Alternative

Response 200 · activity.lastObservedAtRequired

Response 200 · activity.lastObservedAt · anyOf 1Alternative

Response 200 · activity.lastObservedAt · anyOf 2Alternative

Response 200 · activity.nextActionAtRequired

Response 200 · activity.nextActionAt · anyOf 1Alternative

Response 200 · activity.nextActionAt · anyOf 2Alternative

Response 200 · activity.phaseRequired

Response 200 · activity.stateRequired

Response 200 · activity.waitingSinceRequired

Response 200 · activity.waitingSince · anyOf 1Alternative

Response 200 · activity.waitingSince · anyOf 2Alternative

Response 200 · attemptsRequired

Response 200 · attempts[]Each item

Response 200 · attempts[].createdAtRequired

Response 200 · attempts[].createdAt · anyOf 1Alternative

Response 200 · attempts[].createdAt · anyOf 2Alternative

Response 200 · attempts[].dispositionRequired

Response 200 · attempts[].disposition · anyOf 1Alternative

Response 200 · attempts[].disposition · anyOf 2Alternative

Response 200 · attempts[].idRequired

Response 200 · attempts[].stateRequired

Response 200 · billingRequired

Response 200 · billing.debitedRequired

Response 200 · billing.finalRequired

Response 200 · billing.netRequired

Response 200 · billing.refundedRequired

Response 200 · billing.settlementRequired

Response 200 · billing.unitRequired

Response 200 · completionContractRequired

Response 200 · contractVersionRequired

Response 200 · deliveryRequired

Response 200 · delivery.assetIdRequired

Response 200 · delivery.assetId · anyOf 1Alternative

Response 200 · delivery.assetId · anyOf 2Alternative

Response 200 · delivery.availabilityVerifiedAtRequired

Response 200 · delivery.availabilityVerifiedAt · anyOf 1Alternative

Response 200 · delivery.availabilityVerifiedAt · anyOf 2Alternative

Response 200 · delivery.currentVersionRequired

Response 200 · delivery.persistedSegmentCountRequired

Response 200 · delivery.stateRequired

Response 200 · delivery.totalSegmentCountRequired

Response 200 · delivery.totalSegmentCount · anyOf 1Alternative

Response 200 · delivery.totalSegmentCount · anyOf 2Alternative

Response 200 · freshnessRequired

Response 200 · freshness.eventCursorRequired

Response 200 · freshness.historyRequired

Response 200 · freshness.missingFactsRequired

Response 200 · freshness.missingFacts[]Each item

Response 200 · freshness.pendingEventsRequired

Response 200 · freshness.readAtRequired

Response 200 · freshness.sourceRequired

Response 200 · issueRequired

Response 200 · issue · anyOf 1Alternative

Response 200 · issue · anyOf 1.attributionSourceRequired

Response 200 · issue · anyOf 1.attributionSource · anyOf 1Alternative

Response 200 · issue · anyOf 1.attributionSource · anyOf 2Alternative

Response 200 · issue · anyOf 1.attributionSource · anyOf 3Alternative

Response 200 · issue · anyOf 1.categoryRequired

Response 200 · issue · anyOf 1.codeRequired

Response 200 · issue · anyOf 1.evidenceIdsRequired

Response 200 · issue · anyOf 1.evidenceIds[]Each item

Response 200 · issue · anyOf 1.messageRequired

Response 200 · issue · anyOf 1.phaseRequired

Response 200 · issue · anyOf 2Alternative

Response 200 · lifecycleRequired

Response 200 · linksRequired

Response 200 · links.artifactsRequired

Response 200 · links.streamRequired

Response 200 · links.summaryRequired

Response 200 · `activity`Required

Response 200 · `activity.deliveryDeadlineAt`Required

Response 200 · `activity.deliveryDeadlineAt · anyOf 1`Alternative

Response 200 · `activity.deliveryDeadlineAt · anyOf 2`Alternative

Response 200 · `activity.label`Required

Response 200 · `activity.lastAdvancedAt`Required

Response 200 · `activity.lastAdvancedAt · anyOf 1`Alternative

Response 200 · `activity.lastAdvancedAt · anyOf 2`Alternative

Response 200 · `activity.lastObservedAt`Required

Response 200 · `activity.lastObservedAt · anyOf 1`Alternative

Response 200 · `activity.lastObservedAt · anyOf 2`Alternative

Response 200 · `activity.nextActionAt`Required

Response 200 · `activity.nextActionAt · anyOf 1`Alternative

Response 200 · `activity.nextActionAt · anyOf 2`Alternative

Response 200 · `activity.phase`Required

Response 200 · `activity.state`Required

Response 200 · `activity.waitingSince`Required

Response 200 · `activity.waitingSince · anyOf 1`Alternative

Response 200 · `activity.waitingSince · anyOf 2`Alternative

Response 200 · `attempts`Required

Response 200 · `attempts[]`Each item

Response 200 · `attempts[].createdAt`Required

Response 200 · `attempts[].createdAt · anyOf 1`Alternative

Response 200 · `attempts[].createdAt · anyOf 2`Alternative

Response 200 · `attempts[].disposition`Required

Response 200 · `attempts[].disposition · anyOf 1`Alternative

Response 200 · `attempts[].disposition · anyOf 2`Alternative

Response 200 · `attempts[].id`Required

Response 200 · `attempts[].state`Required

Response 200 · `billing`Required

Response 200 · `billing.debited`Required

Response 200 · `billing.final`Required

Response 200 · `billing.net`Required

Response 200 · `billing.refunded`Required

Response 200 · `billing.settlement`Required

Response 200 · `billing.unit`Required

Response 200 · `completionContract`Required

Response 200 · `contractVersion`Required

Response 200 · `delivery`Required

Response 200 · `delivery.assetId`Required

Response 200 · `delivery.assetId · anyOf 1`Alternative

Response 200 · `delivery.assetId · anyOf 2`Alternative

Response 200 · `delivery.availabilityVerifiedAt`Required

Response 200 · `delivery.availabilityVerifiedAt · anyOf 1`Alternative

Response 200 · `delivery.availabilityVerifiedAt · anyOf 2`Alternative

Response 200 · `delivery.currentVersion`Required

Response 200 · `delivery.persistedSegmentCount`Required

Response 200 · `delivery.state`Required

Response 200 · `delivery.totalSegmentCount`Required

Response 200 · `delivery.totalSegmentCount · anyOf 1`Alternative

Response 200 · `delivery.totalSegmentCount · anyOf 2`Alternative

Response 200 · `freshness`Required

Response 200 · `freshness.eventCursor`Required

Response 200 · `freshness.history`Required

Response 200 · `freshness.missingFacts`Required

Response 200 · `freshness.missingFacts[]`Each item

Response 200 · `freshness.pendingEvents`Required

Response 200 · `freshness.readAt`Required

Response 200 · `freshness.source`Required

Response 200 · `issue`Required

Response 200 · `issue · anyOf 1`Alternative

Response 200 · `issue · anyOf 1.attributionSource`Required

Response 200 · `issue · anyOf 1.attributionSource · anyOf 1`Alternative

Response 200 · `issue · anyOf 1.attributionSource · anyOf 2`Alternative

Response 200 · `issue · anyOf 1.attributionSource · anyOf 3`Alternative

Response 200 · `issue · anyOf 1.category`Required

Response 200 · `issue · anyOf 1.code`Required

Response 200 · `issue · anyOf 1.evidenceIds`Required

Response 200 · `issue · anyOf 1.evidenceIds[]`Each item

Response 200 · `issue · anyOf 1.message`Required

Response 200 · `issue · anyOf 1.phase`Required

Response 200 · `issue · anyOf 2`Alternative

Response 200 · `lifecycle`Required

Response 200 · `links`Required

Response 200 · `links.artifacts`Required

Response 200 · `links.stream`Required

Response 200 · `links.summary`Required

Response 200 · `links.timeline`Required

Response 200 · `mvId`Required

Response 200 · `mvId · anyOf 1`Alternative