Skip to content
Docs version r8
OpenAPIJSONYAML
API reference / Models

Get a model

getModel
GET/v1/models/{id}

Read accessible specifications for one model

Markdown fileTry in PlaygroundDocs version r8

Authentication

Send your project key in the request header, for example Authorization: Bearer $VIZO_API_KEY. Keep the key on your server.

Path parameters

Path parameters
FieldDescription
idstringRequired

Resource ID. Save it as soon as you receive it.

Responses

200 OK

200 OK
FieldDescription
entriesobject[], can be nullRequired
Fields of entries
Fields of entries
asOfdate-timeRequired
featuresstring[], can be nullRequired
inputSchemaanyRequired
mediaTypestringRequired
modelIdstringRequired
tiersobject[], can be nullRequired
Fields of tiers
Fields of tiers
idstringRequired
matchmap<string, any>Required
pricingobjectRequired
Fields of pricing
Fields of pricing
comparisonobjectOptional
Fields of comparison
Fields of comparison
officialobjectRequired
officialRequestAmountstringOptional
ourAmountstringOptional
referencePackobjectOptional
savingsPercentstringOptional
creditsstringRequired
imageobjectOptional
Fields of image
Fields of image
extra_input_creditsstringOptional
free_input_imagesintegerRequired
large_creditsstringOptional
max_outputsintegerRequired
output_creditsstringRequired
kindstringRequired
rateobjectOptional
Fields of rate
Fields of rate
auto_durationbooleanRequired
counts_inputbooleanRequired
credits_per_secondstringRequired
max_input_secondsintegerRequired
max_secondsintegerRequired
min_secondsintegerRequired
usdobjectRequired
Fields of usd
Fields of usd
amountstringOptional
Pattern^(0|[1-9][0-9]*)([.][0-9]+)?$
as_ofdate-timeOptional
basisstringOptional
current_standard_pack
statusstringRequired

Available when a current USD reference pack supplies the estimate; unavailable when no valid reference exists. This is a display estimate, not the charge.

availableunavailable
tax_includedbooleanRequired
false
next_cursorstringOptional

Pass as cursor to read the next page. Empty on the last page.

Errors

Errors share one body. Include the request_id when you contact support.

Error body

Error body
FieldDescription
errorobjectRequired

Details of the error.

Fields of error
Fields of error
codestringRequired

Stable request error code. invalid_input rejects the request schema; invalid_credentials/scope_denied reject authentication/authorization; ip_not_allowed/model_not_allowed reject API key IP/model restrictions; resource_not_found hides missing or inaccessible resources; conflict rejects incompatible state; insufficient_balance/budget_exceeded/spending_blocked reject funding; balance_negative (402) refuses new tasks while the organization owes Credits from a charge above its hold, until a top-up repays them; rate_limited/concurrency_limited ask for a later retry; temporarily_unavailable is transient service capacity; request_failed covers other HTTP failures. tier_not_sold, draft_not_found, draft_expired and input_duration_out_of_range reject model-specific input. input_media_invalid rejects a detected format/type mismatch; input_media_too_large rejects a probed byte size above the model limit. storage_quota_exceeded rejects an upload when the organization's storage is full. See errors for field-level details.

invalid_inputinvalid_credentialsinsufficient_balancebalance_negativescope_deniedresource_not_foundconflictrate_limitedconcurrency_limitedtemporarily_unavailablerequest_failedip_not_allowedmodel_not_allowedtier_not_solddraft_not_founddraft_expiredinput_duration_out_of_rangeinput_media_invalidinput_media_too_largebudget_exceededspending_blockedstorage_quota_exceeded
errorsobject[], can be nullOptional
Fields of errors
Fields of errors
pathstringRequired
rulestringRequired
messagestringRequired

Readable explanation. Do not parse it.

request_idstringRequired

Include this when you contact support.

retryablebooleanRequired

True for 429 and 503 only. Even then, check recent tasks before you send a create request again.

task_idstringOptional

The task this error belongs to, when one exists.

Errors
StatusWhat it means and what to do
401

The key is missing, malformed, expired or revoked. Correct the key on your server, then continue.

403

The key scope, email verification, a budget or an account restriction blocks this. Check the key type, scopes and project budget.

404

The model or resource does not exist or is outside this project. Check the project, the ID and that the model is enabled.

422

A field or value is invalid. Compare the request with the field table and the model page.

500

The server failed and the task may already be accepted. Do not resend; list recent tasks first.

503

The service is temporarily unavailable. For a create request, list recent tasks and confirm none was accepted before you submit again.

Request example

cURL
curl "https://api.vizoapi.com/v1/models/$MODEL_ID" \
  -H "Authorization: Bearer $VIZO_API_KEY"
Python
import os, requests

model_id = "…"
res = requests.get(
    f"https://api.vizoapi.com/v1/models/{model_id}",
    headers={"Authorization": f"Bearer {os.environ['VIZO_API_KEY']}"},
    timeout=60,
)
print(res.status_code, res.json())
Node.js
const model_id = "…";
const res = await fetch(`https://api.vizoapi.com/v1/models/${model_id}`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VIZO_API_KEY}`,
  },
});
console.log(res.status, await res.json());
Response 200
{
  "entries": [
    {
      "asOf": "2026-11-02T08:00:00Z",
      "features": [
        "string"
      ],
      "inputSchema": {},
      "mediaType": "string",
      "modelId": "string",
      "tiers": [
        {
          "id": null,
          "match": null,
          "pricing": null
        }
      ]
    }
  ],
  "next_cursor": ""
}
Response 401
{
  "error": {
    "code": "invalid_credentials",
    "message": "API key is missing, malformed, expired or revoked.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 403
{
  "error": {
    "code": "scope_denied",
    "message": "The key does not allow this operation for this project.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 404
{
  "error": {
    "code": "resource_not_found",
    "message": "The resource is not available to this project.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 422
{
  "error": {
    "code": "invalid_input",
    "message": "Input does not match the published schema.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 500
{
  "error": {
    "code": "request_failed",
    "message": "The request failed. Check recent generations before submitting again.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 503
{
  "error": {
    "code": "temporarily_unavailable",
    "message": "Service is temporarily unavailable.",
    "retryable": true,
    "request_id": "9f2c41d07ab3e5c8"
  }
}