跳转到主要内容
PRODUCT DOCUMENTS

快速找到所需文档,高效完成接入与排障

浏览产品文档与友盟 Skill,展开目录并阅读正文。

接口参考

核心端点

方法

路径

说明

POST

/api/llm/listModels

获取可用模型列表

POST

/api/llm/chat

非流式聊天,一次性返回完整结果

POST

/api/llm/chat/stream

SSE 流式聊天,逐字推送 delta

POST

/api/llm/chat/video/result

查询视频生成任务结果(配合视频模型的两步调用,可反复轮询)

POST

/api/llm/sessions/list

查询用户的历史会话列表(支持 Bearer API-Key 或登录态)

POST

/api/llm/sessions/messages

查询某个会话的全部对话轮次(body 传 {"sessionId":"sess-xxx"})

OpenAI 兼容端点

供官方 OpenAI SDK、LangChain 等以 OpenAI 协议为前提的客户端直接接入。 这组端点返回真实 HTTP 状态码与 OpenAI 原生错误体, 与上方网关自有端点(恒 200 + success/sCode)契约不同,请勿混用。

方法

路径

说明

POST

/api/llm/v1/chat/completions

Chat Completions,对应 client.chat.completions.create(),支持 stream

POST

/api/llm/v1/responses

Responses API(官方新推荐),对应 client.responses.create(),支持 stream

GET

/api/llm/v1/models

模型列表,对应 client.models.list()(需携带 API Key)

POST

/api/llm/v1/videos

提交视频生成任务,对应 client.videos.create(),约 1 秒返回任务对象

GET

/api/llm/v1/videos/{id}

查询视频任务,对应 client.videos.retrieve(),可反复轮询(不重复计费)

请求体(核心字段)

适用于上方网关自有端点(/api/llm/chat 等);OpenAI 兼容端点请直接用标准 OpenAI 入参。

字段

类型

说明

messages

array

必填,OpenAI 兼容的 messages 数组

model

string

模型名,缺省 auto(智能路由)

sessionId

string

可选,用于多轮对话续接历史

enableThinking

bool

可选,是否启用思考模式

loadHistory

bool

可选,是否自动加载 sessionId 对应的历史,缺省 true

imageParams

object

可选,仅图像生成模型(如 doubao-seedream-5-0-pro-260628)生效:size/quality/n,缺省 1024x1024 / low / 1

videoParams

object

可选,仅视频生成模型生效:resolution(480P / 720P / 1080P)、ratio(16:9 / 9:16 / 1:1)、duration(5 / 10,单位秒),缺省 720P / 16:9 / 5 秒

视频生成模型:两步调用

视频生成是耗时异步任务(实测 2~4 分钟),所以 API 接入拆成两步: 先提交拿任务ID,再用任务ID轮询结果。 提交用的就是你已经在用的 /api/llm/chat,不需要学习新的提交接口; 只有“查结果”是一个新端点。

步骤

调用

说明

1

POST /api/llm/chat

传视频模型名 + videoParams,约 1 秒内返回,拿到 request_id(即任务ID),此时 status 为 PENDING

2

POST /api/llm/chat/video/result

body 传 {"requestId": "上一步拿到的 request_id"}(也可传 video_task_id,两个 ID 等效),轮询至 status 为 SUCCEEDED 后从 video_url 取结果

两步的响应体结构完全一致(都在 data 里返回下述字段),你只需要写一套解析逻辑:

字段

说明

request_id

网关任务ID,推荐用它轮询。形式为 req- 前缀 + 32 位十六进制,如 req-8ac31d4b9acc4bd1bca4e1cc888e0a85

video_task_id

上游厂商的任务ID(形式因厂商而异,如 UUID)。也可直接拿它轮询,与 request_id等效;另可用于报障时溯源

status

PENDING 已提交待开始 / RUNNING 生成中 / SUCCEEDED 成功 / FAILED 失败

video_url

视频地址,仅 SUCCEEDED 后非空

video_urls

全部视频地址数组(单条时与 video_url 一致)

credits

本次消耗的算力点,任务完成后才有值

video_resolution / video_duration_seconds / video_count

实际生成参数,可用于对账

error_message

FAILED 时的失败原因