API 参考 / 模型

查看模型规格

getModel

GET/v1/models/{id}

下面的接口说明为英文原文。

Read accessible specifications for one model

Markdown 文件在 Playground 试运行文档版本 r15

鉴权

在请求头带上项目 Key，例如 Authorization: Bearer $VIZO_API_KEY。Key 只放在服务端。

路径参数

路径参数
字段	说明
idstring必填	资源 ID，收到后立即保存。

响应

200 OK

字段说明

entriesobject[], 可为 null必填

entries 的字段

capabilityVersionstring必填

inputSchemaany必填

modelIdstring必填

operationstring必填

pricingobject必填

pricing 的字段

asOfdate-time必填

cnyobject必填

cny 的字段

cny 的字段
amountstring可选	格式`^(0\|[1-9][0-9]*)([.][0-9]+)?$`
basisstring可选	`nominal_usdcurrent_standard_pack`
pack_price_versionstring可选
quoted_atdate-time可选
statusstring必填	`availableunavailable`
tax_includedboolean必填	`false`

comparisonobject可选

comparison 的字段

officialobject必填

official 的字段

official 的字段
amountstring可选
asOfstring必填
componentsobject[], 可为 null可选
currencystring可选
officialListUrlstring必填
taxBasisstring可选
unitstring可选

officialRequestAmountstring可选

ourAmountstring可选

referencePackobject可选

referencePack 的字段

referencePack 的字段
currencystring必填
idstring必填
principalMinorstring必填
purchasedUnitsstring必填
taxBasisstring必填
versionstring必填

savingsPercentstring可选

creditsstring必填

kindstring必填

priceVersionstring必填

usdobject必填

usd 的字段

usd 的字段
amountstring可选	格式`^(0\|[1-9][0-9]*)([.][0-9]+)?$`
basisstring可选	`nominal_usdcurrent_standard_pack`
pack_price_versionstring可选
quoted_atdate-time可选
statusstring必填	`availableunavailable`
tax_includedboolean必填	`false`

referenceVideoboolean可选

routeIdstring必填

next_cursorstring可选

作为 cursor 传入以读取下一页。最后一页为空。

错误

所有错误使用同一种响应体。联系支持时请附上 request_id。

错误响应体

字段

说明

errorobject必填

错误详情。

error 的字段

error 的字段
codestring必填	稳定的错误码，用它判断分支。
messagestring必填	可读的说明，不要解析它。
request_idstring必填	联系支持时请附上。
retryableboolean必填	仅 429 和 503 为 true。即便如此，重发创建请求前也要先查看近期任务。
task_idstring可选	错误所属的任务（如果有）。

错误
状态码	含义与处理
401	Key 缺失、格式错误、已过期或已撤销。在服务端更正 Key 后继续。
403	Key 权限、邮箱验证、预算上限或账户限制阻止了操作。检查 Key 类型、权限和项目预算。
404	模型或资源不存在，或不在当前项目范围内。确认项目、ID 和模型是否已开通。
422	字段或取值无效。对照字段表和模型页修改请求。
500	服务端出错，任务可能已经受理。不要直接重发，先查看近期任务。
503	服务暂时不可用。创建请求要先查看近期任务，确认没有受理，再重新提交。

请求示例

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());

响应 200

{
  "entries": [
    {
      "capabilityVersion": "string",
      "inputSchema": {},
      "modelId": "string",
      "operation": "string",
      "pricing": {
        "asOf": "2026-11-02T08:00:00Z",
        "cny": {
          "amount": null,
          "basis": null,
          "pack_price_version": null,
          "quoted_at": null,
          "status": null,
          "tax_included": null
        },
        "comparison": {
          "official": null,
          "officialRequestAmount": null,
          "ourAmount": null,
          "referencePack": null,
          "savingsPercent": null
        },
        "credits": "1400.000",
        "kind": "string",
        "priceVersion": "string",
        "usd": {
          "amount": null,
          "basis": null,
          "pack_price_version": null,
          "quoted_at": null,
          "status": null,
          "tax_included": null
        }
      },
      "referenceVideo": false,
      "routeId": "string"
    }
  ],
  "next_cursor": ""
}

响应 401

{
  "error": {
    "code": "invalid_credentials",
    "message": "API key is missing, malformed, expired or revoked.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}

响应 403

{
  "error": {
    "code": "scope_denied",
    "message": "The key does not allow this operation for this project.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}

响应 404

{
  "error": {
    "code": "resource_not_found",
    "message": "The resource is not available to this project.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}

响应 422

{
  "error": {
    "code": "invalid_input",
    "message": "Input does not match the published schema.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}

响应 500

{
  "error": {
    "code": "request_failed",
    "message": "The request failed. Check recent generations before submitting again.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}

响应 503

{
  "error": {
    "code": "temporarily_unavailable",
    "message": "Service is temporarily unavailable.",
    "retryable": true,
    "request_id": "9f2c41d07ab3e5c8"
  }
}