List MV operations and costs

GET/api/v1/mv/{mvId}/operationsCopy URL

Authentication · x-api-key

Returns quote/task linkage and charged, refunded, and net credits for this MV.

All endpointsRequestResponsesCode

Request

mvIdpath · Required

string

MV identifier returned by create or read operations.

limitquery · Optional

integer

Minimum: 1. Maximum: 100. Default: 50.

Responses

200 OK

application/json

• Response 200 · costSummaryRequired

  object
  5 fields

  • Response 200 · costSummary.authorizedCreditsRequired

    number

  • Response 200 · costSummary.chargedCreditsRequired

    number

  • Response 200 · costSummary.netSpentCreditsRequired

    number

  • Response 200 · costSummary.operationCountRequired

    number

  • Response 200 · costSummary.refundedCreditsRequired

    number

• Response 200 · itemsRequired

  array<object>
  1 field

  • Response 200 · items[]Each item

    object
    15 fields

    • Response 200 · items[].authorizedCreditsRequired

      number

    • Response 200 · items[].chargedCreditsRequired

      number

    • Response 200 · items[].createdAtRequired

      string

    • Response 200 · items[].expectedVersionRequired

      number | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

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

        number

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

        null

    • Response 200 · items[].netCreditsRequired

      number

    • Response 200 · items[].operationRequired

      string

    • Response 200 · items[].operationIdRequired

      string

    • Response 200 · items[].quoteIdRequired

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

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

        string

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

        null

    • Response 200 · items[].refundedCreditsRequired

      number

    • Response 200 · items[].settlementStatusRequired

      "PENDING" | "CHARGED" | "REFUNDED"

    • Response 200 · items[].taskIdRequired

      string

    • Response 200 · items[].taskStatusRequired

      string

    • Response 200 · items[].deliveryDeadlineAtOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

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

        string

        Format: date-time.

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

        null

    • Response 200 · items[].estimatedStartAtOptional

      string | null

      May be null. Must match at least one alternative.

      2 fields / alternatives

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

        string

        Active economy Omn generations with shots waiting for the off-peak window: when shot purchasing is expected to start (now while shots may still start, until 07:40 Beijing time; otherwise the next window's 00:00 Beijing time).

        Format: date-time.

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

        null

    • Response 200 · items[].progressOptional

      string | integer

      Minimum: 0. Maximum: 100. Must match at least one alternative.

      2 fields / alternatives

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

        string

        Format: integer. Default: 0.

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

        integer

        Minimum: 0. Maximum: 100.

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/mv/{mvId}/operations' \
  --header "x-api-key: $OMNAPI_KEY"

Node.js

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