Read MV workflow and quality review

GET/api/v1/tasks/{taskId}/workflowCopy URL

Authentication · x-api-key

Read the owned operation snapshot, stage progress, credit settlement and optional creative quality evidence. Delivery completion does not imply creative acceptance.

All endpointsRequestResponsesCode

Request

taskIdpath · Required

string

Responses

200 OK

application/json

• Response 200 · activityRequired

  object
  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
    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
  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 · deliveryRequired

  object
  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
  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
    8 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 1.providerCodeRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · issue · anyOf 1.providerCode · anyOf 1Alternative

        string

      • Response 200 · issue · anyOf 1.providerCode · anyOf 2Alternative

        null

    • Response 200 · issue · anyOf 1.providerStageRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · issue · anyOf 1.providerStage · anyOf 1Alternative

        string

      • Response 200 · issue · anyOf 1.providerStage · anyOf 2Alternative

        null

  • Response 200 · issue · anyOf 2Alternative

    null

• Response 200 · lifecycleRequired

  string

• Response 200 · linksRequired

  object
  4 fields

  • Response 200 · links.artifactsRequired

    string

  • Response 200 · links.streamRequired

    string

  • Response 200 · links.summaryRequired

    string

  • Response 200 · links.timelineRequired

    string

• Response 200 · modeRequired

  "fast" | "studio"

• 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
  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
      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
  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
    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 · costsOptional

  object
  10 fields

  • Response 200 · costs.currencyRequired

    "USD"

  • Response 200 · costs.estimatedRequired

    string | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · costs.estimated · anyOf 1Alternative

      string

    • Response 200 · costs.estimated · anyOf 2Alternative

      null

  • Response 200 · costs.finalAmountVerifiedRequired

    false

  • Response 200 · costs.measuredRequired

    string | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · costs.measured · anyOf 1Alternative

      string

    • Response 200 · costs.measured · anyOf 2Alternative

      null

  • Response 200 · costs.providerReportedRequired

    string | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · costs.providerReported · anyOf 1Alternative

      string

    • Response 200 · costs.providerReported · anyOf 2Alternative

      null

  • Response 200 · costs.reconciliationRequired

    "component_sources"

  • Response 200 · costs.unclassifiedRequired

    string | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · costs.unclassified · anyOf 1Alternative

      string

    • Response 200 · costs.unclassified · anyOf 2Alternative

      null

  • Response 200 · costs.unitRequired

    "micro_usd"

  • Response 200 · costs.grossOptional

    string

  • Response 200 · costs.providerRefundOptional

    string

• Response 200 · nativeShotsOptional

  array<object>
  1 field

  • Response 200 · nativeShots[]Each item

    object
    17 fields

    • Response 200 · nativeShots[].acceptedAtRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].acceptedAt · anyOf 1Alternative

        string

        Format: date-time.

      • Response 200 · nativeShots[].acceptedAt · anyOf 2Alternative

        null

    • Response 200 · nativeShots[].accountIdRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].accountId · anyOf 1Alternative

        string

      • Response 200 · nativeShots[].accountId · anyOf 2Alternative

        null

    • Response 200 · nativeShots[].billableDurationSecRequired

      number

    • Response 200 · nativeShots[].capacityClassRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].capacityClass · anyOf 1Alternative

        string

      • Response 200 · nativeShots[].capacityClass · anyOf 2Alternative

        null

    • Response 200 · nativeShots[].durationSecRequired

      number

    • Response 200 · nativeShots[].fullDurationMsRequired

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].fullDurationMs · anyOf 1Alternative

        number

      • Response 200 · nativeShots[].fullDurationMs · anyOf 2Alternative

        null

    • Response 200 · nativeShots[].jobIdRequired

      string

    • Response 200 · nativeShots[].materializedAtRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].materializedAt · anyOf 1Alternative

        string

        Format: date-time.

      • Response 200 · nativeShots[].materializedAt · anyOf 2Alternative

        null

    • Response 200 · nativeShots[].reuseSourceJobIdRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].reuseSourceJobId · anyOf 1Alternative

        string

      • Response 200 · nativeShots[].reuseSourceJobId · anyOf 2Alternative

        null

    • Response 200 · nativeShots[].sceneIndexRequired

      integer

    • Response 200 · nativeShots[].startSecRequired

      number

    • Response 200 · nativeShots[].stateRequired

      string

    • Response 200 · nativeShots[].submissionStepIdsRequired

      array<string>
      1 field

      • Response 200 · nativeShots[].submissionStepIds[]Each item

        string

    • Response 200 · nativeShots[].submitDurationMsRequired

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].submitDurationMs · anyOf 1Alternative

        number

      • Response 200 · nativeShots[].submitDurationMs · anyOf 2Alternative

        null

    • Response 200 · nativeShots[].supplierIdRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].supplierId · anyOf 1Alternative

        string

      • Response 200 · nativeShots[].supplierId · anyOf 2Alternative

        null

    • Response 200 · nativeShots[].dispositionOptional

      "completed" | "failed" | "skipped" | "uncertain" | "processing"

      Default: "completed".

    • Response 200 · nativeShots[].failureCodeOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · nativeShots[].failureCode · anyOf 1Alternative

        string

      • Response 200 · nativeShots[].failureCode · anyOf 2Alternative

        null

• Response 200 · qualityOptional

  object
  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
      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
          1 field

          • Response 200 · quality.findings[].requirementEvidence · anyOf 1See schema

            object

            Expand this value in the interactive reference.

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

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

Wrap lines

cURL

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

Node.js

const response = await fetch("https://api.omnapi.com/api/v1/tasks/{taskId}/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());

Python

import os
import requests

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