Logo

接口说明与在线调试

下列接口为平台 OpenAI 兼容网关。所有请求经平台转发:你传入的是平台模型名,网关会路由到对应 supplier,并完成计费与用量记录。请先在控制台令牌管理创建 API Key,勿将密钥写入文档、代码仓库或截图。下方可在线调试,请求直达网关,使用 API Key,不使用控制台会话。

对话

Chat Completions

OpenAI 兼容对话补全,流式与非流式均支持,此处调试为非流式 JSON。

HTTP POST /v2/chat/completions

使用您在令牌管理中创建的 API Key,sk_ 开头,在请求头中携带:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

model:模型名称,需与模型广场中已开通、计费类型为对话的模型一致。

messages:对话消息数组,每条含 rolecontent

图像理解也走本接口,图片放在 messages[].content[].image_url.url

图像

Images Generations

文生图接口,计费类型为图像。

HTTP POST /v2/images/generations

请求头与对话接口相同:Authorization: Bearer YOUR_API_KEYContent-Type: application/json

prompt:正向提示词;size:输出尺寸,以模型支持为准。

不同上游返回的图片地址可能带签名或有效期限制。

图像

Images Generations · 异步(腾讯 VOD)

腾讯点播 AIGC 生图仅异步:先 POST 创建任务,再 GET 轮询。需虚拟模型计费类型为图像,并绑定对应上游配置。

步骤 1 POST /v2/images/generations/task
步骤 2 GET /v2/tasks/<task_id>
异步两步(腾讯 VOD) 第一步:POST /v2/images/generations/task,body 含平台 modelprompt;可选 size 映射宽高比。第二步:GET /v2/tasks/{task_id},仅需 Authorization,无需 query model。任务 ID 取自第一步响应中的 idtask_id

上游任务状态字段 Status 常见取值:

  • WAITING:等待中
  • PROCESSING:处理中
  • FINISH:已完成,可查看生成结果 URL 等
  • ABORTED:已终止

计费按平台异步任务策略结算,与同步 /v2/images/generations 不同线路。

语音

Audio Transcriptions

双路径:multipart 同步转写短音频;JSON + 公网 file_urls 异步转写长音频,需第二步 GET 取结果。

同步 POST /v2/audio/transcriptions(multipart)
异步 ① POST /v2/audio/transcriptions(JSON + file_urls)
异步 ② GET /v2/audio/tasks/<task_id>?model=<虚拟模型>
路径一:同步 multipart POST /v2/audio/transcriptionsmultipart/form-data,字段含 modelfile。适用于短音频,一次响应直接返回文本。
路径二:异步 JSON + 轮询 第一步:POST 同路径,Content-Type: application/json,body 含 modelfile_urls(公网可访问音频 URL,或嵌套在 input.file_urls)。第二步:GET /v2/audio/tasks/{task_id}?model=虚拟模型名。异步需 DashScope 线路支持。

task_status 常见值:PENDINGRUNNINGSUCCEEDEDFAILEDCANCELEDUNKNOWN

认证:Authorization: Bearer YOUR_API_KEY。multipart 请勿手写 Content-Type;JSON 请求需显式 application/json

向量

Embeddings

文本向量接口,计费类型为向量。

HTTP POST /v2/embeddings

JSON POST,请求头与对话接口一致。

input:字符串或字符串数组;dimensionsencoding_format 依模型文档填写。

视频

Videos Generations(异步)

文生视频异步统一入口:先 POST 创建任务,再 GET 轮询。适用于 DashScope 与腾讯点播 AIGC。

步骤 1 POST /v2/videos/generations/task
步骤 2 GET /v2/videos/tasks/<task_id>?model=<虚拟模型>
异步两步 第一步:POST /v2/videos/generations/task,从响应中的 idtask_idoutput.task_id 取任务 ID。第二步:GET /v2/videos/tasks/{task_id}?model=虚拟模型名,其中 model 查询参数必填。

第一步 · 请求参数

  • model:字符串,须与模型广场中已开通、计费类型为视频的虚拟模型 code 一致。
  • prompt:字符串,文生视频描述。
  • size:字符串,输出分辨率,例如 1280x7201280*720
  • 若使用阿里云原生结构,也可直接传顶层 input / parameters;网关仍以虚拟模型路由与密钥为准。

task_status 常见值:PENDINGRUNNINGSUCCEEDEDFAILEDCANCELEDUNKNOWN

响应中通常为异步 task_id 而非最终视频。计费在第二步首次成功且可解析时长时按秒计量;重复查询已成功任务不会重复扣费。