Preview restoring all scenes from the last delivered Omn video

GET/api/v2/mv/{mvId}/final-restoreCopy URL

Authentication · x-api-key

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

Scope: task:read

Billing and effects: Free preview of the last retained delivered video.

Recovery: Read the current resource before retrying a mutation; do not assume this operation supports Idempotency-Key.

Follow this operation’s workflow → · All permission rules

Omn music video endpoint. Check capabilities and preflight before purchasing. How Music Video requests work

All endpointsRequestResponsesCode

Request

Path parameters

mvIdpath · Required

string

MV identifier returned by create or read operations.

Responses

Read the HTTP status and body together. A receipt confirms acceptance; poll the returned Task or product view for terminal execution and media delivery. Example IDs and credit amounts are illustrative, not a price quote.

HTTP 200 · Last delivered video preview

Complete JSON example (optional fields may be omitted).

{
  "mvId": "018f47a0-7b38-7000-8000-000000000002",
  "finalId": "018f47a0-7b38-7000-8000-000000000003",
  "contractVersion": "v2",
  "expectedVersion": 2,
  "snapshotSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sourceVersion": 1,
  "sceneCount": 2,
  "changedScenes": [
    0,
    1
  ],
  "durationSec": 16,
  "retainedUntil": "2026-11-03T00:00:00.000Z",
  "videoUrl": "https://media.example.com/last-final.mp4",
  "creditsRequired": 0
}

HTTP 401 · Request rejected; correct the key before retrying

Complete JSON example (optional fields may be omitted).

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}

200 OK

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

Only the listed fields are accepted in this object.

• Response 200 · changedScenesRequired

  array<string | integer>

  Zero-based scene indices whose current selections would change.

  1 field

  • Response 200 · changedScenes[]Each item

    string | integer

    Use a complete option below; the value must satisfy at least one option.

    2 options

    • Response 200 · Option 1 — stringOption

      string

      Numeric string accepted by coercion; the converted value must satisfy the numeric constraints. Prefer a JSON number.

      Format: integer.

    • Response 200 · Option 2 — integerOption

      integer

• Response 200 · contractVersionRequired

  "v2"

  Public contract version used to interpret this resource. Do not combine field names from different versions.

• Response 200 · creditsRequiredRequired

  0

  Restoring existing scene selections is free and creates no Task.

• Response 200 · durationSecRequired

  number

  Duration in seconds for the containing media, selection or operation. Use validated duration when authorizing a purchase.

• Response 200 · expectedVersionRequired

  string | integer

  Current project version; submit it unchanged when confirming this preview.

  Use a complete option below; the value must satisfy at least one option.

  2 options

  • Response 200 · Option 1 — stringOption

    string

    Numeric string accepted by coercion; the converted value must satisfy the numeric constraints. Prefer a JSON number.

    Format: integer.

  • Response 200 · Option 2 — integerOption

    integer

    Current project version; submit it unchanged when confirming this preview.

• Response 200 · finalIdRequired

  string

  Identifier of the retained delivered video reused by this restore.

• Response 200 · mvIdRequired

  string

  Music video identifier. Use this returned value for subsequent video reads and edits; keep the Task ID separately.

• Response 200 · retainedUntilRequired

  string

  Earliest asset retention deadline. Restore does not extend it.

• Response 200 · sceneCountRequired

  string | integer

  Total number of scene selections in the complete delivered video.

  Use a complete option below; the value must satisfy at least one option.

  2 options

  • Response 200 · Option 1 — stringOption

    string

    Numeric string accepted by coercion; the converted value must satisfy the numeric constraints. Prefer a JSON number.

    Format: integer.

  • Response 200 · Option 2 — integerOption

    integer

    Total number of scene selections in the complete delivered video.

• Response 200 · snapshotSha256Required

  string

  Confirmation fingerprint for this final, its complete scene selections and retention records; not a video byte hash.

• Response 200 · sourceVersionRequired

  string | integer | null

  Version of the source scenes used to assess whether a final output is current.

  Use a complete option below; the value must satisfy at least one option.

  2 options

  • Response 200 · Option 1 — string | integerOption

    string | integer

    Use a complete option below; the value must satisfy at least one option.

    2 options

    • Response 200 · Option 1 — stringOption

      string

      Numeric string accepted by coercion; the converted value must satisfy the numeric constraints. Prefer a JSON number.

      Format: integer.

    • Response 200 · Option 2 — integerOption

      integer

  • Response 200 · Option 2 — nullOption

    null

• Response 200 · videoUrlRequired

  string

  Short-lived preview URL for the last delivered video. Do not send the API key when downloading.

• Response 200 · creativeOptional

  object

  Normalized creative intent for this operation. Interpret it using the resource contractVersion and its documented creative modes.

  Use a complete option below; the value must satisfy at least one option.

  5 options

  • Response 200 · Option 1 — preset = "auto"Option

    object

    Only the listed fields are accepted in this object.

    2 fields

    • Response 200 · creative.presetRequired

      "auto"

      Normalized creative preset for this stored plan. Interpret it within its API contract version.

    • Response 200 · creative.singingOptional

      "allowed" | "forbidden"

      Interpreted singing requirement or permission in this creative plan; explicit forbidden intent must remain forbidden.

      Default: "allowed".

  • Response 200 · Option 2 — preset = "mood"Option

    object

    Only the listed fields are accepted in this object.

    2 fields

    • Response 200 · creative.presetRequired

      "mood"

      Normalized creative preset for this stored plan. Interpret it within its API contract version.

    • Response 200 · creative.singingOptional

      "allowed" | "forbidden"

      Interpreted singing requirement or permission in this creative plan; explicit forbidden intent must remain forbidden.

      Default: "allowed".

  • Response 200 · Option 3 — preset = "story"; storySource = "lyrics" | "prompt"Option

    object

    Only the listed fields are accepted in this object.

    3 fields

    • Response 200 · creative.presetRequired

      "story"

      Normalized creative preset for this stored plan. Interpret it within its API contract version.

    • Response 200 · creative.storySourceRequired

      "lyrics" | "prompt"

      Source of the story direction: lyrics uses the song text; prompt uses the supplied creative brief.

      Default: "lyrics".

    • Response 200 · creative.singingOptional

      "allowed" | "forbidden"

      Interpreted singing requirement or permission in this creative plan; explicit forbidden intent must remain forbidden.

      Default: "allowed".

  • Response 200 · Option 4 — preset = "sing" | "sing_perform" (+4 more values)Option

    object

    Only the listed fields are accepted in this object.

    1 field

    • Response 200 · creative.presetRequired

      "sing" | "sing_perform" | "perform" | "dance" | "sing_dance" | "sing_play"

      Normalized creative preset for this stored plan. Interpret it within its API contract version.

      Default: "sing".

  • Response 200 · Option 5 — mode = "auto" | "story" (+6 more values)Option

    object

    Creative intent, independent of output resolution.

    Only the listed fields are accepted in this object.

    6 fields

    • Response 200 · creative.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.briefOptional

      string

      Describe the desired story, subjects, action and mood. Required for a brief-led story.

      Maximum characters: 3000.

    • Response 200 · creative.charactersOptional

      object

      Whether characters may appear and the desired count.

      Only the listed fields are accepted in this object.

      2 fields

      • Response 200 · creative.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.characters.countOptional

        string | integer

        Desired number of main characters (1 or 2); cannot be combined with forbidden.

        Minimum: 1. Maximum: 2. Use a complete option below; the value must satisfy at least one option.

        2 options

        • Response 200 · Option 1 — stringOption

          string

          Numeric string accepted by coercion; the converted value must satisfy the numeric constraints (minimum 1, maximum 2). Prefer a JSON number.

          Format: integer.

        • Response 200 · Option 2 — integerOption

          integer

          Desired number of main characters (1 or 2); cannot be combined with forbidden.

          Minimum: 1. Maximum: 2.

    • Response 200 · creative.continuityOptional

      object

      Optional reuse of a creative project/revision. Omit for an independent request; selected revisions must belong to the same audio and project.

      Only the listed fields are accepted in this object.

      4 fields

      • Response 200 · creative.continuity.boundaryPolicyOptional

        "standalone" | "excerpt"

        How the selected range is presented: excerpt preserves its relationship to the song; standalone treats it as an independent piece. Default excerpt.

        Default: "standalone".

      • Response 200 · creative.continuity.projectIdOptional

        string

        Creative project identifier returned by the project list. Reuse only a project owned by your account and matching this audio.

        Minimum characters: 1. Maximum characters: 128.

      • Response 200 · creative.continuity.revisionIdOptional

        string

        Creative revision identifier returned by the project list. Reusing it preserves the chosen direction; an incompatible audio source or mode returns a conflict.

        Minimum characters: 1. Maximum characters: 128.

      • Response 200 · creative.continuity.sourceScopeOptional

        "full_song" | "fragment" | "unknown"

        Declared source extent: full_song, fragment or unknown. Default unknown; this declaration does not replace media validation.

        Default: "full_song".

    • Response 200 · creative.optionsOptional

      object

      Mode-specific choices; irrelevant options are rejected.

      Only the listed fields are accepted in this object.

      3 fields

      • Response 200 · creative.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.options.instrumentOptional

        string

        Instrument to feature in perform or sing_play.

        Minimum characters: 1. Maximum characters: 100.

      • Response 200 · creative.options.storySourceOptional

        "lyrics" | "brief"

        Required for story: lyrics uses song evidence; brief uses creative.brief.

        Default: "lyrics".

    • Response 200 · creative.styleOptional

      string

      Visual treatment passed to director planning and shot generation.

      Maximum characters: 1000.

• Response 200 · outputOptional

  object

  Operation-specific output. Use the typed fields shown here. If this is an open JSON object, follow the selected product operation reference; for Tasks prefer resources, and for Vidu see /guides/vidu-operations/.

  Only the listed fields are accepted in this object.

  4 fields

  • Response 200 · output.aspectRatioOptional

    "16:9" | "9:16" | "1:1" | "4:3" | "3:4" | "3:2" | "2:3" | "21:9"

    Delivery aspect ratio; defaults to 16:9. Motion references require 16:9 or 9:16.

  • Response 200 · output.postprocessOptional

    object

    Optional video post-processing preferences for the requested MV output.

    Only the listed fields are accepted in this object.

    2 fields

    • Response 200 · output.postprocess.modeOptional

      "auto" | "tiny-long" | "tc2" | "full"

      Post-processing mode; auto selects the policy automatically.

      Default: "auto".

    • Response 200 · output.postprocess.priorityOptional

      "balanced" | "speed" | "preserve-appearance" | "detail-stability"

      Post-processing preference: balanced, speed, appearance preservation, or detail stability.

      Default: "balanced".

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

  object

  Resolved video post-processing policy, when available for this MV.

  Only the listed fields are accepted in this object.

  9 fields

  • Response 200 · postprocess.confidenceRequired

    "explicit" | "rule" | "default"

    Selection basis confidence: explicit choice, matched rule, or default.

    Default: "explicit".

  • Response 200 · postprocess.intentCategoryRequired

    string | null

    Recognized creative-intent category, or null when none applies.

    May be null.

  • Response 200 · postprocess.policyVersionRequired

    string

    Version of the policy used to select post-processing.

  • Response 200 · postprocess.reasonRequired

    string

    Explanation of why this post-processing mode was selected.

  • Response 200 · postprocess.reasonCodeRequired

    string

    Machine-readable reason for the selected post-processing mode.

  • Response 200 · postprocess.requestedModeRequired

    "auto" | "tiny-long" | "tc2" | "full"

    Requested post-processing mode, including auto for automatic selection.

    Default: "auto".

  • Response 200 · postprocess.selectedModeRequired

    "tiny-long" | "tc2" | "full"

    Resolved post-processing mode: tiny-long, tc2, or full.

    Default: "tiny-long".

  • Response 200 · postprocess.signalsRequired

    array<string>

    Creative-intent signals considered by the selection policy.

    1 field

    • Response 200 · postprocess.signals[]Each item

      string

  • Response 200 · postprocess.sourceRequired

    "manual" | "priority" | "intent" | "default"

    Selection basis: explicit mode, priority preference, creative intent, or default.

    Default: "manual".

• Response 200 · requestedOutputOptional

  object

  Output settings requested at purchase. Compare with the delivered output when reviewing the result.

  Only the listed fields are accepted in this object.

  4 fields

  • Response 200 · requestedOutput.aspectRatioOptional

    "16:9" | "9:16" | "1:1" | "4:3" | "3:4" | "3:2" | "2:3" | "21:9"

    Delivery aspect ratio; defaults to 16:9. Motion references require 16:9 or 9:16.

  • Response 200 · requestedOutput.postprocessOptional

    object

    Optional video post-processing preferences for the requested MV output.

    Only the listed fields are accepted in this object.

    2 fields

    • Response 200 · requestedOutput.postprocess.modeOptional

      "auto" | "tiny-long" | "tc2" | "full"

      Post-processing mode; auto selects the policy automatically.

      Default: "auto".

    • Response 200 · requestedOutput.postprocess.priorityOptional

      "balanced" | "speed" | "preserve-appearance" | "detail-stability"

      Post-processing preference: balanced, speed, appearance preservation, or detail stability.

      Default: "balanced".

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

400 Bad Request

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 400 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 400 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 400 · successRequired

  false

  Always false for error responses

401 Unauthorized

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 401 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 401 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 401 · successRequired

  false

  Always false for error responses

402 Payment Required

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 402 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 402 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 402 · successRequired

  false

  Always false for error responses

403 Forbidden

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 403 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 403 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 403 · successRequired

  false

  Always false for error responses

404 Not Found

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 404 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 404 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 404 · successRequired

  false

  Always false for error responses

409 Conflict

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 409 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 409 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 409 · successRequired

  false

  Always false for error responses

413 Payload Too Large

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 413 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 413 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 413 · successRequired

  false

  Always false for error responses

422 Unprocessable Entity

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 422 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 422 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• 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

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 429 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  3 fields

  • Response 429 · error.codeRequired

    string

    RATE_LIMITED for request and task admission rejections.

  • Response 429 · error.messageRequired

    string

    Human-readable explanation. Wording may change; use the machine-readable code for programmatic decisions.

  • Response 429 · error.detailsOptional

    object

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    9 fields

    • Response 429 · error.details.currentOptional

      integer

      Current count for the rate-limit window identified by policy and scope.

      Minimum: 0.

    • Response 429 · error.details.inFlightOptional

      integer

      Current accepted tasks counted against the relevant account or API-key admission limit.

      Minimum: 0.

    • Response 429 · error.details.limitOptional

      integer

      Maximum count allowed by this response context. A limit is not a throughput guarantee.

      Minimum: 0.

    • Response 429 · error.details.policyOptional

      "operation" | "query"

      Allowance bucket: query for resource reads, operation for task-producing or operation requests. See the rate-limit response headers.

    • Response 429 · error.details.retryAfterSecOptional

      integer

      Suggested delay in seconds before another request. Honor the Retry-After header when present; use bounded backoff.

      Minimum: 1.

    • Response 429 · error.details.scopeOptional

      "user" | "api-key" | "ip" | "apiKey"

      Entity whose allowance was exceeded, such as the user, API key or IP address.

    • Response 429 · error.details.tierOptional

      "FREE" | "PREMIUM" | "ENTERPRISE"

      Account allowance tier used for this admission or rate-limit decision.

    • Response 429 · error.details.typeOptional

      "rps" | "daily" | "monthly"

      Admission limit that rejected the request: rps (continuously refilled requests-per-second bucket), daily or monthly UTC request budget. Interpret with policy, scope and retryAfterSec.

    • Response 429 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 429 · successRequired

  false

  Whether this response reports a successful action; false accompanies the structured error object.

  Default: false.

500 Internal Server Error

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 500 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 500 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 500 · successRequired

  false

  Always false for error responses

502 Bad Gateway

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 502 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 502 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 502 · successRequired

  false

  Always false for error responses

503 Service Unavailable

application/json

Required, optional and null

Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.

• Response 503 · errorRequired

  object

  Structured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.

  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

    Optional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.

    1 field

    • Response 503 · error.details[key]Each value

      any JSON value

      Key pattern: ^(.*)$.

• Response 503 · successRequired

  false

  Always false for error responses

Request example

Wrap lines

cURL

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

Node.js

const response = await fetch("https://api.omnapi.com/api/v2/mv/{mvId}/final-restore", {
  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/v2/mv/{mvId}/final-restore",
    headers={
        "x-api-key": os.environ["OMNAPI_KEY"],
    },
    timeout=60,
)
response.raise_for_status()
print(response.text)

Replace URL placeholders such as {taskId} with IDs from actual responses, and set the header environment variables shown above.

Workflow and next steps → · Recover an uncertain request

Interactive API Explorer → · OpenAPI JSON