Get Fast MV availability

GET/api/v1/mv/fast/availabilityCopy URL

Authentication · x-api-key

Check whether Fast MV creation is currently available. Use the requested managedVersion and honor retryAfterSec before trying again. `gateEnabled` remains in the public contract and is fixed to true; `unknown` and `unavailable` block paid creates before direct debit.

All endpointsRequestResponsesCode

Request

managedVersionquery · Optional

"oneclick-v1" | "premium-v2"

Responses

200 OK

application/json

• Response 200 · admissionStateRequired

  "AVAILABLE" | "DEGRADED" | "BACKPRESSURED" | "UNAVAILABLE"

• Response 200 · checkedAtRequired

  string

• Response 200 · checksRequired

  array<object>
  1 field

  • Response 200 · checks[]Each item

    object
    3 fields

    • Response 200 · checks[].messageRequired

      string

    • Response 200 · checks[].nameRequired

      string

    • Response 200 · checks[].statusRequired

      "pass" | "warn" | "fail" | "unknown"

• Response 200 · gateEnabledRequired

  true

  Paid-create availability gate; fixed to true in the current public contract.

• Response 200 · guidanceRequired

  string

• Response 200 · managedVersionRequired

  "oneclick-v1" | "premium-v2"

  Managed Fast MV engine version. Existing clients default to oneclick-v1; premium-v2 must be selected explicitly.

• Response 200 · messageRequired

  string

• Response 200 · metricsRequired

  object
  12 fields

  • Response 200 · metrics.avgTerminalDurationSecRequired

    number | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · metrics.avgTerminalDurationSec · anyOf 1Alternative

      number

    • Response 200 · metrics.avgTerminalDurationSec · anyOf 2Alternative

      null

  • Response 200 · metrics.failedCountRequired

    number

  • Response 200 · metrics.failureRateRequired

    number

  • Response 200 · metrics.predictedDeliveryWaitSecRequired

    number | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · metrics.predictedDeliveryWaitSec · anyOf 1Alternative

      number

    • Response 200 · metrics.predictedDeliveryWaitSec · anyOf 2Alternative

      null

  • Response 200 · metrics.predictedQueueWaitSecRequired

    number | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · metrics.predictedQueueWaitSec · anyOf 1Alternative

      number

    • Response 200 · metrics.predictedQueueWaitSec · anyOf 2Alternative

      null

  • Response 200 · metrics.processingCountRequired

    number

  • Response 200 · metrics.projectCountRequired

    number

  • Response 200 · metrics.readyCountRequired

    number

  • Response 200 · metrics.readyRateRequired

    number

  • Response 200 · metrics.recentServiceRatePerMinuteRequired

    number | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · metrics.recentServiceRatePerMinute · anyOf 1Alternative

      number

    • Response 200 · metrics.recentServiceRatePerMinute · anyOf 2Alternative

      null

  • Response 200 · metrics.staleProcessingCountRequired

    number

  • Response 200 · metrics.terminalCountRequired

    number

• Response 200 · retryAfterSecRequired

  number | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · retryAfterSec · anyOf 1Alternative

    number

  • Response 200 · retryAfterSec · anyOf 2Alternative

    null

• Response 200 · statusRequired

  "available" | "degraded" | "unavailable" | "unknown"

• Response 200 · windowMinutesRequired

  number

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

Node.js

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