List Tasks

GET/api/v1/tasksCopy URL

Authentication · x-api-key

List the current user's tasks, optionally filtered by status / providerCode / appSlug. Keyset pagination is the default; pass `nextCursor` back as `cursor`. Legacy offset pagination requires `cursorMode=false` and is capped at offset 10000.

All endpointsRequestResponsesCode

Request

statusquery · Optional

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

providerCodequery · Optional

string

modelCodequery · Optional

string

featureCodequery · Optional

string

dateFromquery · Optional

string

dateToquery · Optional

string

appSlugquery · Optional

string

tagquery · Optional

string

Minimum characters: 1. Maximum characters: 100.

limitquery · Optional

number

Maximum number of items to return.

Minimum: 1. Maximum: 50. Default: 20.

offsetquery · Optional

number

Zero-based pagination offset.

Minimum: 0. Maximum: 10000. Default: 0.

cursorModequery · Optional

boolean

Default: true.

cursorquery · Optional

string

Responses

200 OK

application/json

Unknown fields are not accepted.

• Response 200 · itemsRequired

  array<object>
  1 field

  • Response 200 · items[]Each item

    object

    Unknown fields are not accepted.

    22 fields

    • Response 200 · items[].createdAtRequired

      Date | string | number

      Task creation timestamp

      Must match at least one alternative.

      4 fields / alternatives

      • Response 200 · items[].createdAt · anyOf 1Alternative

        Date

        Task creation timestamp

      • Response 200 · items[].createdAt · anyOf 2Alternative

        string

        Format: date-time.

      • Response 200 · items[].createdAt · anyOf 3Alternative

        string

        Format: date.

      • Response 200 · items[].createdAt · anyOf 4Alternative

        number

    • Response 200 · items[].creditsChargedRequired

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].creditsCharged · anyOf 1Alternative

        number

        Credits actually charged

        Minimum: 0.

      • Response 200 · items[].creditsCharged · anyOf 2Alternative

        null

    • Response 200 · items[].creditsRequiredRequired

      number

      Credits deducted to start the task

      Minimum: 0.

    • Response 200 · items[].errorMessageRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].errorMessage · anyOf 1Alternative

        string

        Error message if task failed

      • Response 200 · items[].errorMessage · anyOf 2Alternative

        null

    • Response 200 · items[].featureRequired

      object | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].feature · anyOf 1Alternative

        object
        2 fields

        • Response 200 · items[].feature · anyOf 1.codeRequired

          string

          Feature code

          1 field

          • Response 200 · items[].feature · anyOf 1.codeSee schema

            string

            Expand this value in the interactive reference.

        • Response 200 · items[].feature · anyOf 1.nameRequired

          string

          Feature name

          1 field

          • Response 200 · items[].feature · anyOf 1.nameSee schema

            string

            Expand this value in the interactive reference.

      • Response 200 · items[].feature · anyOf 2Alternative

        null

    • Response 200 · items[].featureCodeRequired

      string

      Feature code

    • Response 200 · items[].inputParametersRequired

      any

      Task input parameters

    • Response 200 · items[].metadataRequired

      any | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

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

        any

        Additional metadata

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

        null

    • Response 200 · items[].modelRequired

      object | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].model · anyOf 1Alternative

        object
        3 fields

        • Response 200 · items[].model · anyOf 1.codeRequired

          string

          Model code

          1 field

          • Response 200 · items[].model · anyOf 1.codeSee schema

            string

            Expand this value in the interactive reference.

        • Response 200 · items[].model · anyOf 1.nameRequired

          string

          Model display name

          1 field

          • Response 200 · items[].model · anyOf 1.nameSee schema

            string

            Expand this value in the interactive reference.

        • Response 200 · items[].model · anyOf 1.versionRequired

          string

          Model version

          1 field

          • Response 200 · items[].model · anyOf 1.versionSee schema

            string

            Expand this value in the interactive reference.

      • Response 200 · items[].model · anyOf 2Alternative

        null

    • Response 200 · items[].modelCodeRequired

      string

      Model code

    • Response 200 · items[].pricingRequired

      object | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].pricing · anyOf 1Alternative

        object

        Unknown fields are not accepted.

        2 fields

        • Response 200 · items[].pricing · anyOf 1.componentsRequired

          array<object>
          1 field

          • Response 200 · items[].pricing · anyOf 1.componentsSee schema

            array<object>

            Expand this value in the interactive reference.

        • Response 200 · items[].pricing · anyOf 1.quoteVersionRequired

          number

          Pricing quote version stored with the task.

          Minimum: 1.

          1 field

          • Response 200 · items[].pricing · anyOf 1.quoteVersionSee schema

            number

            Expand this value in the interactive reference.

            Minimum: 1.

      • Response 200 · items[].pricing · anyOf 2Alternative

        null

    • Response 200 · items[].processingCompletedAtRequired

      Date | string | number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].processingCompletedAt · anyOf 1Alternative

        Date | string | number

        Processing completion timestamp

        Must match at least one alternative.

        4 fields / alternatives

        • Response 200 · items[].processingCompletedAt · anyOf 1 · anyOf 1Alternative

          Date

          Processing completion timestamp

          1 field

          • Response 200 · items[].processingCompletedAt · anyOf 1 · anyOf 1See schema

            Date

            Expand this value in the interactive reference.

        • Response 200 · items[].processingCompletedAt · anyOf 1 · anyOf 2Alternative

          string

          Format: date-time.

          1 field

          • Response 200 · items[].processingCompletedAt · anyOf 1 · anyOf 2See schema

            string

            Expand this value in the interactive reference.

            Format: date-time.

        • Response 200 · items[].processingCompletedAt · anyOf 1 · anyOf 3Alternative

          string

          Format: date.

          1 field

          • Response 200 · items[].processingCompletedAt · anyOf 1 · anyOf 3See schema

            string

            Expand this value in the interactive reference.

            Format: date.

        • Response 200 · items[].processingCompletedAt · anyOf 1 · anyOf 4Alternative

          number
          1 field

          • Response 200 · items[].processingCompletedAt · anyOf 1 · anyOf 4See schema

            number

            Expand this value in the interactive reference.

      • Response 200 · items[].processingCompletedAt · anyOf 2Alternative

        null

    • Response 200 · items[].processingDurationRequired

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].processingDuration · anyOf 1Alternative

        number

        Processing duration in milliseconds

      • Response 200 · items[].processingDuration · anyOf 2Alternative

        null

    • Response 200 · items[].processingDurationTextRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].processingDurationText · anyOf 1Alternative

        string

        Human-readable processing duration, e.g. 16.2s

      • Response 200 · items[].processingDurationText · anyOf 2Alternative

        null

    • Response 200 · items[].processingStartedAtRequired

      Date | string | number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].processingStartedAt · anyOf 1Alternative

        Date | string | number

        Processing start timestamp

        Must match at least one alternative.

        4 fields / alternatives

        • Response 200 · items[].processingStartedAt · anyOf 1 · anyOf 1Alternative

          Date

          Processing start timestamp

          1 field

          • Response 200 · items[].processingStartedAt · anyOf 1 · anyOf 1See schema

            Date

            Expand this value in the interactive reference.

        • Response 200 · items[].processingStartedAt · anyOf 1 · anyOf 2Alternative

          string

          Format: date-time.

          1 field

          • Response 200 · items[].processingStartedAt · anyOf 1 · anyOf 2See schema

            string

            Expand this value in the interactive reference.

            Format: date-time.

        • Response 200 · items[].processingStartedAt · anyOf 1 · anyOf 3Alternative

          string

          Format: date.

          1 field

          • Response 200 · items[].processingStartedAt · anyOf 1 · anyOf 3See schema

            string

            Expand this value in the interactive reference.

            Format: date.

        • Response 200 · items[].processingStartedAt · anyOf 1 · anyOf 4Alternative

          number
          1 field

          • Response 200 · items[].processingStartedAt · anyOf 1 · anyOf 4See schema

            number

            Expand this value in the interactive reference.

      • Response 200 · items[].processingStartedAt · anyOf 2Alternative

        null

    • Response 200 · items[].progressRequired

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].progress · anyOf 1Alternative

        number

        Task progress percentage (0-100)

        Minimum: 0. Maximum: 100.

      • Response 200 · items[].progress · anyOf 2Alternative

        null

    • Response 200 · items[].providerRequired

      object | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].provider · anyOf 1Alternative

        object
        2 fields

        • Response 200 · items[].provider · anyOf 1.codeRequired

          string

          Provider code

          1 field

          • Response 200 · items[].provider · anyOf 1.codeSee schema

            string

            Expand this value in the interactive reference.

        • Response 200 · items[].provider · anyOf 1.nameRequired

          string

          Provider display name

          1 field

          • Response 200 · items[].provider · anyOf 1.nameSee schema

            string

            Expand this value in the interactive reference.

      • Response 200 · items[].provider · anyOf 2Alternative

        null

    • Response 200 · items[].providerCodeRequired

      string

      Provider code

    • Response 200 · items[].statusRequired

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

      Default: "PENDING".

    • Response 200 · items[].tagsRequired

      any | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

      • Response 200 · items[].tags · anyOf 1Alternative

        any

        Structured task tags

      • Response 200 · items[].tags · anyOf 2Alternative

        null

    • Response 200 · items[].taskIdRequired

      string

      Task unique identifier

    • Response 200 · items[].updatedAtRequired

      Date | string | number

      Last update timestamp

      Must match at least one alternative.

      4 fields / alternatives

      • Response 200 · items[].updatedAt · anyOf 1Alternative

        Date

        Last update timestamp

      • Response 200 · items[].updatedAt · anyOf 2Alternative

        string

        Format: date-time.

      • Response 200 · items[].updatedAt · anyOf 3Alternative

        string

        Format: date.

      • Response 200 · items[].updatedAt · anyOf 4Alternative

        number

• Response 200 · limitRequired

  number

  Page size

  Minimum: 1.

• Response 200 · offsetRequired

  number

  Offset

  Minimum: 0.

• Response 200 · hasMoreOptional

  boolean

  Whether there are more tasks (cursor mode)

• Response 200 · nextCursorOptional

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · nextCursor · anyOf 1Alternative

    string

    Cursor for next page (cursor mode)

  • Response 200 · nextCursor · anyOf 2Alternative

    null

• Response 200 · totalOptional

  number

  Total number of tasks (offset mode only)

  Minimum: 0.

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

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

Node.js

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