Get subtitle task

GET/api/v1/subtitles/{id}Copy URL

Authentication · x-api-key

Get subtitle extraction task status and artifacts.

All endpointsRequestResponsesCode

Request

idpath · Required

string

Resource identifier returned by the corresponding create operation.

Responses

200 OK

application/json

Unknown fields are not accepted.

• Response 200 · progressRequired

  number

  Minimum: 0. Maximum: 100.

• Response 200 · statusRequired

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

  Default: "PENDING".

• Response 200 · taskIdRequired

  string

• Response 200 · artifactsOptional

  object

  Unknown fields are not accepted.

  8 fields

  • Response 200 · artifacts.jsonRequired

    object

    Unknown fields are not accepted.

    3 fields

    • Response 200 · artifacts.json.urlRequired

      string

    • Response 200 · artifacts.json.expiresAtOptional

      string

    • Response 200 · artifacts.json.retentionDaysOptional

      number

  • Response 200 · artifacts.jsonUrlRequired

    string

  • Response 200 · artifacts.srtRequired

    object

    Unknown fields are not accepted.

    3 fields

    • Response 200 · artifacts.srt.urlRequired

      string

    • Response 200 · artifacts.srt.expiresAtOptional

      string

    • Response 200 · artifacts.srt.retentionDaysOptional

      number

  • Response 200 · artifacts.srtUrlRequired

    string

  • Response 200 · artifacts.lrcOptional

    object

    Unknown fields are not accepted.

    3 fields

    • Response 200 · artifacts.lrc.urlRequired

      string

    • Response 200 · artifacts.lrc.expiresAtOptional

      string

    • Response 200 · artifacts.lrc.retentionDaysOptional

      number

  • Response 200 · artifacts.lrcUrlOptional

    string

  • Response 200 · artifacts.vttOptional

    object

    Unknown fields are not accepted.

    3 fields

    • Response 200 · artifacts.vtt.urlRequired

      string

    • Response 200 · artifacts.vtt.expiresAtOptional

      string

    • Response 200 · artifacts.vtt.retentionDaysOptional

      number

  • Response 200 · artifacts.vttUrlOptional

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

  string

• Response 200 · timelineOptional

  object

  Unknown fields are not accepted.

  2 fields

  • Response 200 · timeline.linesRequired

    array<object>
    1 field

    • Response 200 · timeline.lines[]Each item

      object

      Unknown fields are not accepted.

      4 fields

      • Response 200 · timeline.lines[].endSecRequired

        number

      • Response 200 · timeline.lines[].startSecRequired

        number

      • Response 200 · timeline.lines[].textRequired

        string

      • Response 200 · timeline.lines[].sectionOptional

        string

  • Response 200 · timeline.wordsRequired

    array<object>
    1 field

    • Response 200 · timeline.words[]Each item

      object

      Unknown fields are not accepted.

      3 fields

      • Response 200 · timeline.words[].endSecRequired

        number

      • Response 200 · timeline.words[].startSecRequired

        number

      • Response 200 · timeline.words[].textRequired

        string

• Response 200 · warningsOptional

  array<string>
  1 field

  • Response 200 · warnings[]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

Request example

Wrap lines

cURL

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

Node.js

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