开发者文档

一分钟快速接入 API

通过可直接运行的示例快速发起请求，并根据实际业务场景选择最佳接入方案。

获取 API Key

无法识别的模型：inferway/qwen3.8-27b-uncensored

该模型未在可用目录中启用。请从上方选择器挑选一个模型。

按需导航

选择您当下需要完成的任务

选择已发布模型选择模型后显示对应协议与示例。API 参考OpenAI 兼容路径保持精简、行为确定；账户、账单、用量统计和智能体相关的操作，由一组独立的自有端点提供。

标准流程

从零开始完成一次已验证的 API 调用

客户端接入指南

开发工具集成

Pi CursorClaude CodeCodexHermesOpenCodeClineKimi CodeMiMo CodeZCodeQoder

API 端点参考

OpenAI 兼容路径保持精简、行为确定；账户、账单、用量统计和智能体相关的操作，由一组独立的自有端点提供。

OpenAI 兼容接口/v1/chat/completions

支持对话交互、工具调用、结构化输出与流式响应，可直接搭配各类官方 SDK 使用。

异步交互接口/v1/interactions

用于视频生成：提交一次即持久化的后台任务，随后轮询直至成片可取回。

控制台管理接口/v1/keys · /v1/billing · /v1/usage · /v1/requests

用于服务端的 API 密钥管理、余额与账单查询、用量统计及请求元数据审计。

端点路径	请求方法	功能说明
/v1/chat/completions	POST	OpenAI 兼容的对话补全接口
/v1/interactions	POST	异步视频生成任务（同一路由下的五种操作）
/v1/models	GET	获取已发布模型列表及能力、价格元数据
/v1/mcp/sse · /v1/mcp/messages	GET · POST	MCP 服务协议接入端点（已上线）
/v1/keys	GET / POST / DELETE	管理直连 API 密钥
/v1/billing	GET	钱包余额与近期用量统计
/v1/billing/transactions	GET	钱包充值与消费交易明细
/v1/billing/checkout	POST	创建在线充值收银台会话
/v1/usage	GET	按时间聚合的 Token 用量统计
/v1/requests	GET	请求元数据历史明细（不含交互正文）
/health	GET	网关与核心后端健康检查
/v1/stats	GET	服务聚合统计数据

异步交互：一个路由，五种操作

视频生成不会在请求内直接返回成片。所有调用都发往 POST /v1/interactions，并在请求体的 op 字段中指明操作；任务本身持久化，连接中断不会丢失已扣费的工作。

op 取值	功能说明
prepare_upload	为一张输入图片申请一次性上传凭证：JPEG、PNG 或 WebP，单张不超过 10 MiB。
create	提交生成任务，返回 interaction ID。下单时按所选时长冻结额度，成片后才扣费，生成失败不收费。
get	读取持久化状态与当前阶段；成片交付落定后，返回结果及其下载地址。
cancel	尽力而为地取消排队中或执行中的任务。
list	按分页和状态过滤查询历史交互任务列表。

mode 必须为 background。同步与流式模式一律以 422 拒绝，本路由没有实时返回的变体。
create 操作必须携带 Idempotency-Key。同一 Key 配同一请求会返回原始回执且不重复扣费；同一 Key 配不同请求则以 409 失败拒绝。
model、mode、duration_seconds 与 prompt 都是请求体的顶层字段。duration_seconds 为必填，且只接受已公布的整秒档位——计费正是按它结算。
使用 get 操作轮询直至状态进入终态。我们自己的控制台每 2 秒轮询一次；本接口不提供 Webhook，也没有长轮询。

公开支持的端点是 POST /v1/chat/completions、POST /v1/interactions 和 GET /v1/models。旧版 POST /v1/completions 不提供：它返回 501（未实现），并在错误信息里指明应改用的 chat completions 路由。POST /v1/messages（Anthropic 格式）已提供并对 API key 开放：每个请求都需带 anthropic-version: 2023-06-01 头。

模型

选择模型，查看其已发布的能力事实。API 示例和工具配置会使用同一个模型。

查找模型支持工具调用

当前没有可选模型。

认证与鉴权

API 密钥 密钥统一以 inferway_live_… 开头，签发给服务端负载使用。
密钥有效期 在控制台新建密钥时，可以定一个固定的到期时间，也可以设成首次调用后过一段时间到期。倒计时从密钥第一次真正用于请求时开始，查询模型列表、查看视频任务进度都不算；开始后既不会暂停，也不会重置。倒计时还没开始的密钥轮换后，新密钥沿用同样的倒计时。密钥过期后，请求会收到 401，和无效密钥一样。
浏览器应用安全规范 切勿把直连密钥暴露在客户端，请求应走您自有的后端代理。

错误代码

Inferway 返回 OpenAI 兼容的错误对象：{"error": { "type": "...", "message": "...", "code": "..." }}

错误码目录（实时）

/v1/chat/completions 与 /v1/agent/chat 可能返回的全部错误码，直接取自网关自己的目录，不是抄写。每一行都带 HTTP 状态、是否可以安全重试，以及 API 实际发出的原文。结账、账单与密钥管理相关的端点会返回它们各自的错误码，不在本表中。

错误码	HTTP 状态码	可否重试	错误含义
account_benefits_restricted	403	不可	此账户的免费文本额度暂时受限，不会扣减已充值余额；如需复核请联系支持。
admission_paused	503	可以，先退避	服务调整期间暂停接收付费请求，请稍后重试；这个请求本身没有问题。
authentication_error	401	不可	身份验证失败。
conflict	409	不可	与资源的当前状态冲突。
context_length_exceeded	400	不可	提示词超出了模型的上下文窗口。请缩短或压缩对话后重试。
free_quota_exhausted	429	可以，先退避	免费额度已用完，请稍后再试。
free_tier_unavailable	503	可以，先退避	免费通道暂时不可用，请稍后再试。
internal_error	500	不可	网关内部错误
internal_tool_failure	500	不可	内部工具出错。
invalid_image_input	400	不可	The image input was invalid. Check the image rejection code and message.
invalid_request	400	不可	请求格式错误或参数非法
malformed_upstream	502	不可	上游服务返回了无效的响应。
model_unavailable	503	可以，先退避	该模型暂停服务，其他模型不受影响，请稍后再试。
payment_required	402	不可	余额不足，请到控制台的「账单与钱包」页充值。
playground_allowance_exhausted	402	不可	Your daily Playground allowance is used up. Top up at https://inferway.ai/console/billing to continue, or try again after 00:00 UTC.
promotional_credit_not_supported	402	不可	此模型可用充值本金、充值赠金、邀请奖励和反馈奖励支付，不能使用注册赠金、运营赠金和历史发放的赠金。充值后即可使用。
rate_limited	429	可以，先退避	超出速率限制或并发限额
service_unavailable	503	不可	服务出现故障，实时状态见 inferway.ai/status。
upstream_rejected	422	不可	上游服务拒绝了这个请求。
upstream_timeout	504	可以，先退避	上游服务响应超时，请重试。
upstream_unavailable	503	可以，先退避	服务暂时不可用。

错误码、状态与重试策略取自 GET /v1/public/errors

平台速率与配额

以下是平台公开的请求窗口与账户配额，不代表任何未选模型的生成能力或保留策略。

适用对象	限额	时间窗口
匿名试玩	90	每分钟（每 IP）
匿名试玩	500	每小时
匿名试玩	1,000	每滚动 24 小时
账户充值后	按账户正式配额	自动解除访客体验限制，可在控制台查看专属配额

下一步建议

创建或轮换 API 密钥在控制台管理 API 密钥 查看请求元数据不存储任何正文，也能核对状态、延迟、Token 消耗与所用模型。关注服务健康度上线前先查看逐服务可用率与事故记录。

获取 API Key 查看系统状态