Get a Vidu Direct task

GET/api/v1/vidu/tasks/{id}Copy URL

Authentication · x-api-key

Returns OmnAPI task state and pass-through Vidu resource URLs. The published one-hour window is conservative: standard creation URLs may last 24 hours, while finished outputs may expire sooner.

All endpointsRequestResponsesCode

Request

idpath · Required

string

Vidu task identifier returned by task creation.

Responses

200 OK

application/json

• Response 200 · outputUrlTtlHoursRequired

  1

  Conservative download window. Some Vidu creation URLs remain valid for 24 hours, but finished outputs may expire after 1 hour.

• Response 200 · progressRequired

  number

  Minimum: 0. Maximum: 100.

• Response 200 · statusRequired

  "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED"

  Default: "PENDING".

• Response 200 · taskIdRequired

  string

• Response 200 · errorCodeOptional

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · errorCode · anyOf 1Alternative

    string

  • Response 200 · errorCode · anyOf 2Alternative

    null

• Response 200 · errorMessageOptional

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · errorMessage · anyOf 1Alternative

    string

  • Response 200 · errorMessage · anyOf 2Alternative

    null

• Response 200 · outputOptional

  any

• Response 200 · resourcesOptional

  array<object>
  1 field

  • Response 200 · resources[]Each item

    object

    A consumable resource produced by the task.

    19 fields

    • Response 200 · resources[].idRequired

      string

      Stable resource id (OmnAPI resource id).

    • Response 200 · resources[].indexRequired

      number

      Stable zero-based provider result slot. Finalized post-process resources may use a higher reserved slot.

      Minimum: 0.

    • Response 200 · resources[].roleRequired

      "candidate" | "final" | "stem" | "fallback" | "output"

      How clients should interpret the resource. Prefer `final` when present; `candidate` items remain selectable alternatives.

    • Response 200 · resources[].typeRequired

      "MUSIC" | "IMAGE" | "VIDEO" | "AUDIO" | "TEXT" | "METADATA"

      Uppercase resource kind. MUSIC carries a song URL and optional thumbnailUrl; TEXT carries inline content. Optional fields depend on the operation.

    • Response 200 · resources[].assetIdOptional

      string

      Stable OmnAPI-owned asset id when available.

    • Response 200 · resources[].assetStatusOptional

      "READY" | "EXPIRED" | "DELETING" | "DELETED"

    • Response 200 · resources[].byteLengthOptional

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].byteLength · anyOf 1Alternative

        number

        Resource size in bytes.

      • Response 200 · resources[].byteLength · anyOf 2Alternative

        null

    • Response 200 · resources[].contentOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].content · anyOf 1Alternative

        string

        Inline text content (e.g. lyrics).

      • Response 200 · resources[].content · anyOf 2Alternative

        null

    • Response 200 · resources[].contentTypeOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].contentType · anyOf 1Alternative

        string

        Resource content type.

      • Response 200 · resources[].contentType · anyOf 2Alternative

        null

    • Response 200 · resources[].durationOptional

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].duration · anyOf 1Alternative

        number

      • Response 200 · resources[].duration · anyOf 2Alternative

        null

    • Response 200 · resources[].durationSecOptional

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].durationSec · anyOf 1Alternative

        number

        Resource duration in seconds.

      • Response 200 · resources[].durationSec · anyOf 2Alternative

        null

    • Response 200 · resources[].heightOptional

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].height · anyOf 1Alternative

        number

      • Response 200 · resources[].height · anyOf 2Alternative

        null

    • Response 200 · resources[].metadataOptional

      object | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].metadata · anyOf 1Alternative

        object

      • Response 200 · resources[].metadata · anyOf 2Alternative

        null

    • Response 200 · resources[].retainedUntilOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].retainedUntil · anyOf 1Alternative

        string

        Format: date-time.

      • Response 200 · resources[].retainedUntil · anyOf 2Alternative

        null

    • Response 200 · resources[].thumbnailUrlOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].thumbnailUrl · anyOf 1Alternative

        string

      • Response 200 · resources[].thumbnailUrl · anyOf 2Alternative

        null

    • Response 200 · resources[].titleOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].title · anyOf 1Alternative

        string

      • Response 200 · resources[].title · anyOf 2Alternative

        null

    • Response 200 · resources[].urlOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].url · anyOf 1Alternative

        string

        Presigned/public URL.

      • Response 200 · resources[].url · anyOf 2Alternative

        null

    • Response 200 · resources[].urlExpiresAtOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].urlExpiresAt · anyOf 1Alternative

        string

        Format: date-time.

      • Response 200 · resources[].urlExpiresAt · anyOf 2Alternative

        null

    • Response 200 · resources[].widthOptional

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · resources[].width · anyOf 1Alternative

        number

      • Response 200 · resources[].width · anyOf 2Alternative

        null

400 Bad Request

application/json

• Response 400 · errorRequired

  object
  3 fields

  • Response 400 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 400 · error.messageRequired

    string

    Human readable error message

  • Response 400 · error.detailsOptional

    object

    Additional error details (optional)

• Response 400 · successRequired

  false

  Always false for error responses

401 Unauthorized

application/json

• Response 401 · errorRequired

  object
  3 fields

  • Response 401 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 401 · error.messageRequired

    string

    Human readable error message

  • Response 401 · error.detailsOptional

    object

    Additional error details (optional)

• Response 401 · successRequired

  false

  Always false for error responses

403 Forbidden

application/json

• Response 403 · errorRequired

  object
  3 fields

  • Response 403 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 403 · error.messageRequired

    string

    Human readable error message

  • Response 403 · error.detailsOptional

    object

    Additional error details (optional)

• Response 403 · successRequired

  false

  Always false for error responses

404 Not Found

application/json

• Response 404 · errorRequired

  object
  3 fields

  • Response 404 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 404 · error.messageRequired

    string

    Human readable error message

  • Response 404 · error.detailsOptional

    object

    Additional error details (optional)

• Response 404 · successRequired

  false

  Always false for error responses

429 Too Many Requests

Request allowance or task admission capacity exceeded. Follow Retry-After when present; otherwise wait for active tasks and use bounded backoff. Limits do not guarantee throughput. For SSE, this is the HTTP connection response, not an event.

application/json

• Response 429 · errorRequired

  object
  3 fields

  • Response 429 · error.codeRequired

    string

    RATE_LIMITED for request and task admission rejections.

  • Response 429 · error.messageRequired

    string

  • Response 429 · error.detailsOptional

    object

    Optional and scope-dependent. Request limits supply scope/policy/type/limit/current/retryAfterSec. Task admission supplies inFlight/limit/tier, plus scope=apiKey for a key cap. IP rejection can omit details. In-flight rejection does not promise Retry-After.

    8 fields

    • Response 429 · error.details.currentOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.inFlightOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.limitOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.policyOptional

      "operation" | "query"

    • Response 429 · error.details.retryAfterSecOptional

      integer

      Minimum: 1.

    • Response 429 · error.details.scopeOptional

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

    • Response 429 · error.details.tierOptional

      "FREE" | "PREMIUM" | "ENTERPRISE"

    • Response 429 · error.details.typeOptional

      "rps" | "daily" | "monthly"

• Response 429 · successRequired

  false

  Default: false.

500 Internal Server Error

application/json

• Response 500 · errorRequired

  object
  3 fields

  • Response 500 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 500 · error.messageRequired

    string

    Human readable error message

  • Response 500 · error.detailsOptional

    object

    Additional error details (optional)

• Response 500 · successRequired

  false

  Always false for error responses

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

Node.js

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