术语表
帮助文档中常见概念、字段与错误术语说明
本文档解释帮助文档中常见的概念与字段。
接入与鉴权
| 术语 | 说明 |
|---|---|
| API Key / 令牌 | 以 sk- 开头的访问密钥，通过 Authorization: Bearer 传递 |
| Base URL | 网关部署地址，如 https://www.yunsell.com |
| Bearer Token | HTTP 鉴权方式：Authorization: Bearer sk-xxx |
| Session | 管理台登录会话，用于 /api/* 和部分 content 下载接口 |
模型相关
| 术语 | 说明 |
|---|---|
| model | 模型 ID，请求体或路径中的模型标识，须为 /v1/models 返回的 data[].id |
| supported_endpoint_types | 模型支持的端点类型，决定该模型可用于哪些能力 |
openai | 支持 Chat / Completions |
openai-response | 支持 /v1/responses |
image-generation | 支持 /v1/images/* |
openai-video | 支持视频生成相关接口 |
| owned_by | 模型归属标识（供应商标识） |
| tags | 模型标签（若有） |
文本相关
| 术语 | 说明 |
|---|---|
| SSE | Server-Sent Events，流式响应格式，Content-Type: text/event-stream |
| stream | 请求字段，设为 true 时返回 SSE 流 |
| finish_reason | 生成结束原因：stop、length、tool_calls、content_filter |
| tool_calls | 模型发起的函数/工具调用 |
| usage | Token 用量对象，含 prompt_tokens、completion_tokens 等 |
图像相关
| 术语 | 说明 |
|---|---|
| response_format | 图像返回格式：url（默认）或 b64_json |
| revised_prompt | 部分模型改写后的 prompt |
| quota | 按次计费的消耗额度（图像 usage.quota） |
视频相关
| 术语 | 说明 |
|---|---|
| task_id | 视频任务公开 ID，形如 task_xxxxxxxx |
| 异步任务 | 创建后立即返回 task_id，需轮询状态后下载 |
| status | 任务状态：queued → in_progress → completed / failed |
| progress | 任务进度，0–100 |
| mode | yunsellai 多模态视频的生成模式（t2v、first_frame、ref_image 等） |
| assets | yunsellai 请求中的资产数组，[{ "role": "...", "url": "..." }] |
| variant | content 下载参数：video（默认）或 thumbnail（封面） |
| remixed_from_video_id | 部分渠道在任务完成时返回的视频结果 URL |
yunsellai 视频 mode
| mode | 说明 |
|---|---|
t2v | 文生视频 |
i2v | 图生视频 |
first_frame | 首帧生成视频 |
first_last_frame | 首尾帧生成视频 |
ref_image | 参考图生成视频 |
video_extend | 视频续写 |
video_edit | 视频智能编辑 |
音频相关
| 术语 | 说明 |
|---|---|
| voice | TTS 音色代码，来自 /v1/audio/voice/{model} 的 data[].code |
| response_format | 音频输出格式：mp3、wav、opus 等 |
| 渠道音色 | name 与 code 相同，来自渠道配置 |
| 平台音色库 | name 为展示名，code 为 voice_key |
Skills 相关
| 术语 | 说明 |
|---|---|
| Skills | 基于 V1 API 的技能包（yunsell-ai-skills），含 SKILL.md，供 Agent 对话内调用 |
| yunsell-ai-skills | 云擎数智 官方技能包名称，覆盖图像、视频、音频生成 |
| YUNSELL_BASE_URL | Skills 使用的网关地址环境变量 |
| YUNSELL_API_KEY | Skills 使用的 API Key 环境变量 |
| 支持平台 | Claude、Cursor、Codex、OpenClaw、Hermes、NemoClaw 等 Agent 客户端 |
MCP 相关
| 术语 | 说明 |
|---|---|
| MCP | Model Context Protocol，另一种 Agent 接入方式，通过 /mcp 端点调用 Tool |
| Tool | MCP 暴露的可调用能力，如 generate_image、create_video |
| mcpServers | 客户端 MCP 配置键名，建议使用 yunsell |
| Mcp-Session-Id | Streamable HTTP 会话 ID，后续请求须携带 |
| next_poll_after_sec | 视频轮询建议间隔（默认 10 秒） |
错误相关
| 术语 | 说明 |
|---|---|
| 标准错误 | { "error": { "message", "type", "code" } } 格式 |
| 任务类错误 | { "code", "message" } 格式，常见于视频任务 |
| 网关扩展错误 | { "success": false, "message" } 格式，常见于模型列表 |
详见 通用约定 · 错误响应。
计费相关
| 术语 | 说明 |
|---|---|
| Token 计费 | 按输入/输出 Token 计费，见于文本类 usage |
| 按次计费 | 按请求次数计费，见于图像 usage.quota |
| 按秒计费 | 视频类可能按生成时长计费（依模型配置） |