接入文档
通径提供 OpenAI 兼容的 REST 接口。所有请求使用 HTTPS,请求体与响应均为 JSON。
BASE/v1
快速开始
- 在 控制台 创建一个令牌(以
sk-开头)。 - 把客户端的 Base URL 设置为上方地址。
- 提交视频任务,然后用返回的
id轮询状态,直到status为succeeded。
鉴权
在请求头中携带令牌:
Authorization: Bearer sk-xxxxxxxxxxxxxxxx
令牌等同于你的账户余额,请只在服务端保存,不要写进前端代码或提交到代码仓库。泄露后请立即在控制台禁用并重新创建。
创建视频任务
POST/v1/videos
兼容别名:/v1/videos/generations。任务为异步执行,接口立即返回任务 ID。
| 参数 | 说明 |
|---|---|
| model | 必填。模型 ID,见 模型广场。 |
| prompt | 必填(或提供 content)。画面描述,最长 8000 字。 |
| duration | 整数秒,须在该模型支持的时长内;seconds 为同义字段。 |
| resolution | 如 720P、1080P、2K,须在该模型价目表内;省略时使用默认分辨率。 |
| ratio | 画幅,如 16:9、9:16、1:1、adaptive(视模型而定)。 |
| first_frame / last_frame | 首帧、尾帧图片 URL。 |
| reference_image | 参考图片 URL;部分模型支持 image_urls 数组(最多 9 张)。 |
| reference_video / reference_audio | 参考视频、音频 URL(视模型而定)。 |
| content | 高级用法:多模态数组,元素为 text / image_url / video_url / audio_url。 |
响应
{
"id": "tsk_8f2c1a9d0b7e4c31",
"object": "video.generation",
"model": "MiniMax-H3",
"status": "processing",
"billing_status": "frozen",
"locked_price": 3.0,
"charged": 0
}
通径不会转发 callback_url 等回调字段,请通过查询接口获取结果。
查询任务
GET/v1/videos/{id}
status 取值:queued 排队中、processing 生成中、succeeded 成功、failed 失败。建议每 5–10 秒查询一次。
{
"id": "tsk_8f2c1a9d0b7e4c31",
"status": "succeeded",
"billing_status": "settled",
"charged": 3.0,
"url": "/v1/files/tsk_8f2c1a9d0b7e4c31?exp=...&sig=..."
}
url 是本站签发的签名链接,24 小时内有效,无需携带令牌即可播放或下载;过期后再次查询任务即可拿到新链接。
GET/v1/videos/{id}/content
成功后 302 跳转到成片签名链接,便于直接下载。
对话补全
POST/v1/chat/completions
与 OpenAI 格式一致,目前仅支持非流式(stream: false)。未设置 max_tokens 时按模型上限冻结,调用结束后按实际 tokens 结算。
模型列表
GET/v1/models
无需鉴权。返回每个模型的计费方式、价格、支持的时长与分辨率,以及 available(是否可用)。
| 模型 ID | 类型 | 状态 |
|---|---|---|
| 加载中… | ||
余额查询
GET/v1/wallet
{
"available": 96.5,
"frozen": 3.0,
"total": 99.5,
"currency": "CNY_CREDIT",
"unit": "积分"
}
计费规则
- 提交任务时按报价冻结积分(
locked_price),冻结部分不可用于其他请求。 - 视频成功后按报价结算;失败、超时或服务中断时全额退回。
- 对话按实际
usage结算,多冻结的部分立即退回。 - 所有冻结、扣费、退回都会在控制台「积分流水」中留下记录。
错误码
错误响应格式:{"error": {"message": "...", "code": "..."}}
| HTTP | 含义 |
|---|---|
| 400 | 参数错误,例如分辨率或时长不在价目表内。 |
| 401 | 令牌无效或已禁用。 |
| 402 | 可用余额不足。 |
| 403 | 账号已禁用,或签名链接无效。 |
| 404 | 任务或模型不存在。 |
| 409 | 成片尚未就绪。 |
| 413 | 请求体过大(JSON 上限 2 MB)。 |
| 429 | 请求过于频繁(每个令牌每分钟 60 次提交)。 |
| 502 / 503 | 上游暂时不可用,或模型维护中;此类失败不会扣费。 |
安全建议
- 为不同项目分别创建令牌,便于单独禁用和核对用量。
- 令牌只放在服务端环境变量中,前端通过你自己的后端转发请求。
- 签名成片链接可以直接分享,但会在 24 小时后失效。