# 官方公告📢 Source: https://docs.jiekou.ai/docs/announcement/announcement ## 【重要通知】部分多模态模型计划下线的通知 尊敬的用户： 为持续优化平台服务效率，聚焦核心产品能力提升，提供更先进、优质、规范的服务，接口AI 将对部分多模态模型进行计划下线处理。**下架模型及相应替换模型列表**如下： | **下架模型** | **下架时间** | **替换模型** | **备注** | | :--------------------------- | :--------- | :------- | :----- | | Qwen-Image 文生图 | 2026-09-30 | — | — | | Qwen-Image 图像编辑 | 2026-09-30 | — | — | | Midjourney 文生图 | 2026-09-30 | — | — | | Midjourney 变化 | 2026-09-30 | — | — | | Midjourney 高清 | 2026-09-30 | — | — | | Midjourney 重新执行 | 2026-09-30 | — | — | | Midjourney 扩图 | 2026-09-30 | — | — | | Midjourney 区域重绘 | 2026-09-30 | — | — | | Midjourney 重塑 | 2026-09-30 | — | — | | Midjourney 移除背景 | 2026-09-30 | — | — | | Wan 2.5 Preview 文生视频 | 2026-09-30 | — | — | | Wan 2.5 Preview 图生视频 | 2026-09-30 | — | — | | Wan 2.6 文生视频 | 2026-09-30 | — | — | | Wan 2.6 图生视频 | 2026-09-30 | — | — | | Wan 2.6 参考生视频 | 2026-09-30 | — | — | | Minimax Hailuo 2.3 文生视频 | 2026-09-30 | — | — | | Minimax Hailuo 2.3 图生视频 | 2026-09-30 | — | — | | Minimax Hailuo 2.3 Fast 图生视频 | 2026-09-30 | — | — | | OpenAI Sora 2 文生视频 | 2026-09-30 | — | — | | OpenAI Sora 2 图生视频 | 2026-09-30 | — | — | | Heygen Video-translate | 2026-09-30 | — | — | | 万相 Wan 2.7 图生视频 | 2026-09-30 | — | — | | 万相 Wan 2.7 文生视频 | 2026-09-30 | — | — | | 万相 Wan 2.7 参考生视频 | 2026-09-30 | — | — | | 万相 Wan 2.7 视频编辑 | 2026-09-30 | — | — | | MiniMax Music | 2026-09-30 | — | — | | MiniMax Lyrics | 2026-09-30 | — | — | | MOSS TTS | 2026-09-30 | — | — | 请在下线前停止使用上述模型并调整相关业务。停服后原 API 调用将返回错误代码。为避免业务中断，请及时联系我们处理迁移事宜。感谢您的理解与支持。 **jiekou.ai 团队** 2026 年 9 月 1 日 *** ## 【重要通知】部分多模态模型计划下线的通知 尊敬的用户： 为持续优化平台服务效率，聚焦核心产品能力提升，提供更先进、优质、规范的服务，接口AI 将对部分多模态模型进行计划下线处理。**下架模型及相应替换模型列表**如下： | **下架模型** | **下架时间** | **替换模型** | **备注** | | :------------------------------ | :--------- | :------------------------------ | :----- | | FLUX.1 Kontext Dev | 2026-08-19 | Qwen-Image 文生图 | — | | FLUX.1 Kontext Pro | 2026-08-19 | Qwen-Image 文生图 | — | | FLUX.1 Kontext Max | 2026-08-19 | Qwen-Image 文生图 | — | | Flux 2 Dev 生图 | 2026-08-19 | Qwen-Image 文生图 | — | | Flux 2 Flex 生图 | 2026-08-19 | Qwen-Image 文生图 | — | | Flux 2 Pro 生图 | 2026-08-19 | Qwen-Image 文生图 | — | | Z Image Turbo 图像生成 | 2026-08-19 | Qwen-Image 文生图 | — | | Z Image Turbo LoRA 图像生成 | 2026-08-19 | Qwen-Image 文生图 | — | | Wan 2.1 文生视频 | 2026-08-19 | Seedance 2.0 | — | | Wan 2.1 图生视频 | 2026-08-19 | Seedance 2.0 | — | | Wan 2.2 文生视频 | 2026-08-19 | Seedance 2.0 | — | | Wan 2.2 图生视频 | 2026-08-19 | Seedance 2.0 | — | | Seedance 1.5 Pro 文生视频 | 2026-08-19 | Seedance 2.0 | — | | Seedance 1.5 Pro 图生视频 | 2026-08-19 | Seedance 2.0 | — | | MiniMax Speech-2.6-hd 同步语音合成 | 2026-08-19 | MiniMax Speech 2.8 HD 同步语音合成 | — | | MiniMax Speech-2.6-hd 异步语音合成 | 2026-08-19 | MiniMax Speech 2.8 HD 异步语音合成 | — | | MiniMax Speech-2.6-turbo 同步语音合成 | 2026-08-19 | MiniMax Speech 2.8 Turbo 同步语音合成 | — | | MiniMax Speech-2.6-turbo 异步语音合成 | 2026-08-19 | MiniMax Speech 2.8 Turbo 异步语音合成 | — | 请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码，为避免业务中断，请立即联系我们处理技术迁移事宜。感谢您的理解与支持。 **jiekou.ai 团队** 2026 年 8 月 3 日 *** ## 【重要通知】jiekou.ai 访问方式及 Base URL 更新 尊敬的用户： 为提升国内网络环境下的 API 调用稳定性与速度，jiekou.ai 正式上线国内直连 Base URL。该域名无需任何 VPN 或代理，国内用户可直接使用。 Base URL 调整说明： * 国内直连（无需 VPN，推荐国内用户使用）： [https://api.highwayapi.ai/openai](https://api.highwayapi.ai/openai) * 原域名（海外用户或已配置 VPN 时使用）： [https://api.jiekou.ai/openai](https://api.jiekou.ai/openai) 原域名将继续稳定服务，调用方式、认证信息、速率限制等均保持不变，现有集成方案无需调整。 兼容的 API Endpoint： * /chat/completions（OpenAI 聊天补全兼容） * /completions（文本补全） * /anthropic（Anthropic 模型请求） 以上 Endpoint 可通过两个域名中任意一个进行访问，功能与返回格式完全一致。 我们将持续保障接口服务的稳定性与可用性，并承诺服务永久可访问。 如在使用过程中遇到任何问题，请及时联系我们。感谢您的理解与支持！ jiekou.ai 团队 2026 年 5 月 20 日 *** ## 🎉 接口AI 正式上线公告 🎉 亲爱的开发者与 AI 爱好者们， 我们很高兴地宣布，接口AI 正式上线啦！🚀 作为一站式大模型 API 接口平台，我们致力于为您提供 企业级稳定性 的 开源 & 闭源模型 服务，涵盖最新、最强大的 AI 技术，助您轻松集成智能能力到您的产品中！
🌟 核心优势 ✅ 丰富模型库：支持最新开源与闭源模型，持续更新，满足多样化需求 ✅ 稳定可靠：企业级服务保障，高可用、低延迟，专注您的业务而非运维 ✅ 灵活计费：按需调用，透明计价，成本可控
🎁 上线福利 1️⃣ 新用户礼遇：注册即赠体验额度，零门槛试用强大模型！ 2️⃣ 邀请返券：成功邀请好友，双方均可获得额外代金券！ 3️⃣ 充值返利： 好友充值后，您还可额外获赠邀请奖励券（奖励与好友充值额度相关） 👉 具体规则详见 [活动页](https://jiekou.vip/referral)
🚀 立即体验 👉 访问官网：[https://www.jiekou.vip](https://www.jiekou.vip) 👉 注册即送福利，开启高效 AI 集成之旅！ 我们期待与您共同探索 AI 的无限可能！如有任何问题或建议，欢迎随时联系客服团队 💌 JieKou.AI 团队敬上 2025 年 9 月 29 日 # Prompt caching Source: https://docs.jiekou.ai/docs/feature/prompt-caching ## Anthropic Anthropic 模型支持 **显式 Prompt caching**。 在本平台， 无论是 OpenAI chat/completions 协议，还是 Anthropic v1/messages 协议，均可使用 `"cache_control": {"type": "ephemeral"}` 指定需要缓存的内容。 ```json theme={null} { "model": "claude-sonnet-4-5-20250929", "max_tokens": 4096, "messages": [ { "role": "user", "content": [ { "type": "text", "text": "HUGE TEXT BODY", "cache_control": { "type": "ephemeral" } }, { "type": "text", "text": "Name all the characters in the above book" } ] } ] } ``` ⚠️ cache\_control 是我们扩展的字段，在 OpenAI 官方 SDK 协议中不包含此属性，因此在调用时需显式添加。 通过响应可验证缓存创建/命中情况 ```json OpenAI /chat/completions theme={null} { "prompt_tokens": 7039, "completion_tokens": 650, "total_tokens": 7689, "prompt_tokens_details": { "cached_tokens": 7019, "cache_creation_input_tokens": 7019, # 👈 cache created "cache_read_input_tokens": 0 } } --- { "prompt_tokens": 7042, "completion_tokens": 572, "total_tokens": 7614, "prompt_tokens_details": { "audio_tokens": 0, "cached_tokens": 7019, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 7019 # 👈 cache read } } ``` ```json Anthropic /v1/messages theme={null} {"cache_creation_input_tokens":188086,"cache_read_input_tokens":0,"input_tokens":21,"output_tokens":393} # 👈 cache created {"cache_creation_input_tokens":0,"cache_read_input_tokens":188086,"input_tokens":21,"output_tokens":393} # 👈 cache read ``` ⚠️⚠️⚠️ 对于 Anthropic 模型，使用 Prompt caching 最小 Input Tokens 要求如下 * Claude Opus 4.1、Claude Opus 4、Claude Sonnet 4.5、Claude Sonnet 4、Claude Sonnet 3.7 为 1024 tokens * Claude Haiku 4.5、Claude Haiku 3.5 和 Claude Haiku 3 为 2048 tokens ## OpenAI 及 OpenAI 兼容模型 通常，这些模型可能支持隐式缓存。 当用户反复使用相同的 Prompt 前缀访问同一模型，有一定概率命中缓存。 ``` // Round 1 { "model": "gpt-4", "messages": [ { "role": "system", "content": "HUGE TEXT BODY: Complete API documentation, code style guide, best practices (5000+ lines)" }, { "role": "user", "content": "How do I authenticate API requests?" } ] } // Round 2 - Documentation cached { "model": "gpt-4", "messages": [ { "role": "system", "content": "HUGE TEXT BODY: Complete API documentation, code style guide, best practices (5000+ lines)" }, { "role": "user", "content": "How do I authenticate API requests?" }, { "role": "assistant", "content": "Use Bearer token in Authorization header..." }, { "role": "user", "content": "What about rate limiting?" } ] } ``` 以下为缓存命中的用量示例 ```json theme={null} { "prompt_tokens": 3003, "completion_tokens": 1564, "total_tokens": 4567, "prompt_tokens_details": { "cached_tokens": 2025 # 👈 cache hitted } } ``` ## Gemini 目前仅支持隐式缓存。隐式缓存无需手动设置或额外的 cache\_control 配置。当用户反复使用相同的 Prompt 前缀访问同一模型，有一定概率命中缓存。 注意点如下 * 平均 TTL（缓存存活时间）为 3-5 分钟，但可能会有所变化（例如可能仅为几秒） * Gemini 2.5 Flash 要求最小输入为 1024 tokens，Gemini 2.5 Pro 要求最小为 4096 tokens 以下为缓存命中的用量示例： ``` { "prompt_tokens": 2004, "completion_tokens": 1564, "total_tokens": 3568, "prompt_tokens_details": { "cached_tokens": 1994 # 👈 cache hitted } } ``` 输入示例参考 **OpenAI 模型及 OpenAI 兼容模型** 即可。 # CC Switch Source: https://docs.jiekou.ai/docs/integration/cc-switch CC Switch 是一款跨平台的 AI 编码工具配置管理器，把分散在各个工具里的模型服务商配置集中到一处，让你无需手动编辑配置文件，就能在不同 API 后端之间一键切换。它同时支持 Claude Code、Claude Desktop、Codex、Gemini CLI 等多款主流工具，适合需要在多个模型服务之间频繁切换的个人开发者与团队。 通过对接接口 AI，你可以在 CC Switch 中为 Claude Code 等 Agent 接入国内可直连的 API 服务。无需改动任何项目代码，只需在自定义配置里新建供应商，填写对应的接入地址与密钥并保存即可。 ## CC Switch 关键介绍 ### 可视化配置管理 所有服务商配置集中存放在本地数据库中，通过平台界面增删改查，不必再手动编辑 JSON 配置文件或反复设置环境变量。 ### 一键切换 内置 50 余种服务商预设，切换只需点击一次，各 Agent 切换后无需重启即可生效。 ### 多工具统一管理 * Claude Code、Claude Desktop * Codex、Gemini CLI * OpenCode、OpenClaw、Hermes 等 * MCP 服务、提示词与 Skills 跨应用同步 ### 跨平台支持 支持 Windows、macOS 和 Linux 系统，主流发行版均可使用。 ### 配置安全保障 采用原子写入并自动生成备份，配置文件与备份统一存放在 `~/.cc-switch/` 目录下，切换过程中不会损坏原有配置。 ## 如何将接口 AI 接入 CC Switch 只需 3 步配置，即可完成接入。 ### 1. 获取 API Key 1. 登录官网 [jiekou.vip](https://jiekou.vip) 注册并进入管理后台，点击右上方“我的”，在下拉列表中选择“API 密钥管理”。 2. 点击“添加”，输入密钥名称。建议填写便于识别的名称，例如 `CCSwitch`，方便后续在控制台区分不同用途的密钥。 3. 点击复制并记录生成的 Key。控制台不可再次查看，请在后续配置中使用并妥善保存。 接口AI API 密钥管理 接口AI 创建 API Key ### 2. 在 CC Switch 中添加服务商 1. 打开 CC Switch，在左侧选择 **Claude Code**，点击右上角“添加服务商”。 2. 在预设列表中选择“自定义配置”，填写服务商名称，例如“接口AI”。 3. 接入地址填写 Base URL： * Anthropic 系列模型：`https://api.highway.ai/anthropic` * OpenAI 系列模型：`https://api.highway.ai/openai` 4. API 密钥填写上一步复制的 Key，获取模型列表并选择要调用的模型。 5. 保存后选中该条目，点击“启用”，即可在系统托盘中看到当前生效的服务商。 CC Switch 创建 01 **Anthropic 模型配置：** CC Switch Anthropic 模型配置 **OpenAI 模型配置：** CC Switch OpenAI 模型配置 ### 3. 验证配置是否生效 打开终端运行 `claude`，正常进入对话即表示对接成功。Claude Code 切换服务商后无需重启，直接新建会话即可生效。 如果出现以下错误，请按对应方式排查： * **404**：检查接入地址尾部路径是否多写或少写。 * **401 或 403**：回到接口 AI 后台确认密钥状态是否正常。 CC Switch Validate # Chatbox Source: https://docs.jiekou.ai/docs/integration/chatbox Chatbox 是一个开源的对话应用框架，内置对接大语言模型（如 ChatGPT）的功能，可用于快速搭建基于 AI 的智能聊天工具。 Chatbox 支持丰富的自定义配置，适合个人开发者以及企业开发场景，能够灵活应用于客户服务、知识问答、内容创作、团队协作等场景。 通过对接 JieKou.AI，你可以轻松接入多种开源、闭源大模型，包括 GPT-5、Gemini 2.5、以及其他兼容 OpenAI 接口的模型，享受更高的灵活性和扩展性。 ## Chatbox 关键介绍 1. 开源框架 Chatbox 是完全开源的项目，代码可审计，可根据你的需求进行二次开发，支持扩展更多功能。 2. 支持多模型接入 默认支持 OpenAI 官方的 GPT 系列模型，同时开放接口配置，允许接入其他兼容模型，灵活满足不同场景需求。 3. 丰富的功能场景 * 搭建智能聊天机器人 * 人工智能内容生成（如文案写作、代码生成） * 企业知识管理对话助手 * 客户服务 FAQ * 多语言翻译与对话支持 4. 跨平台支持 客户端和服务端均可灵活部署，支持浏览器运行，也支持本地化部署，兼容性强。 ## 为什么选择 JieKou.AI 对接 Chatbox？ 1. 统一标准接口 jiekou.ai 完全兼容 OpenAI 官方 API 格式，无需重新编写代码，仅需替换 API 地址即可完成快速迁移。 2. 多模型支持 除 GPT 系列模型外，还支持其他如中文大模型等多种开源和专有模型，满足更多业务场景需求。 3. 高性价比 提供灵活的计费模式，帮助企业降低智能对话相关的运营成本。 4. 稳定可靠 稳定的技术架构与服务支持，保障模型调用的高可用性体验。 如何对接 JieKou.AI 与 Chatbox？ 只需 3 步配置，即可实现对接： 1. 获取 API Key * 登录 jiekou.ai 官网 注册并进入管理后台，点击右上方“我的”，在下拉列表中选择“API 密钥管理” * 点击“添加”，输入密钥名称 * 点击复制，并记录下生成的 Key(控制台不可再次查看)，在后续配置中使用 2. 按如下图配置，即可实现 Chatbox 与 JieKou.AI 的无缝对接 # Claude Code Source: https://docs.jiekou.ai/docs/integration/claudecode Claude Code 是 Anthropic 推出的，一款运行于您终端的智能体（Agentic）编程工具，它能够理解您的代码库，并通过执行常规任务来帮助您更快地编程。 本站提供了 Anthropic SDK 兼容的 LLM API 服务，您可以轻松地在 Claude Code 中使用多种大语言模型来完成任务。请参考下面指南完成接入过程。 1. 安装 Claude Code 在终端执行以下命令安装 Claude Code ⚠️ 在安装 Claude Code 前，请确保您的本地环境已安装 Node.js 18 或更高版本 ```bash theme={null} npm install -g @anthropic-ai/claude-code ``` 2. 开启一个终端会话 ```bash theme={null} { export ANTHROPIC_BASE_URL="https://api.highwayapi.ai/anthropic" export ANTHROPIC_AUTH_TOKEN="" # 设置本平台支持的模型 export ANTHROPIC_MODEL="claude-opus-4-1-20250805" export ANTHROPIC_SMALL_FAST_MODEL="claude-sonnet-4-20250514" } ``` 接下来进入项目文件目录，启动 Claude Code 即可 ```bash theme={null} cd claude . ``` # OpenAI Codex CLI Source: https://docs.jiekou.ai/docs/integration/codex ## Codex CLI Codex CLI 是 OpenAI 推出的一款编程终端智能体，它可以在您的计算机上本地运行。 1. 安装 在终端执行以下命令安装 Codex CLI ```bash theme={null} npm install -g @openai/codex ``` MacOS 用户可以使用 Homebrew ```bash theme={null} brew install codex ``` 2. 配置使用本平台模型（MacOS/Linux） 打开 `~/.codex/config.toml`，做如下配置 ``` model = "gpt-5" model_provider = "jiekou" [model_providers.jiekou] name = "JIEKOU using Chat Completions" base_url = "https://api.highwayapi.ai/openai/v1" env_key = "OPENAI_API_KEY" wire_api = "chat" query_params = {} ``` 更细节配置方式可以查阅 [官方文档](https://github.com/openai/codex/blob/main/docs/config.md)。 3. 运行 Codex CLI 配置本站 ApiKey 为环境变量并运行 codex ```bash theme={null} OPENAI_API_KEY= codex ``` ## Codex VSCode extension 您也可以在 VSCode 中使用 Codex，先按照上一节指引配置好 `~/.codex/config.toml`，接着执行如下命令 ```bash theme={null} { cat << 'EOF' | tee $HOME/.codex/pcodex.sh #!/bin/bash OPENAI_API_KEY=sk_xxx /opt/homebrew/bin/codex "$@" EOF chmod +x $HOME/.codex/pcodex.sh } ``` 再在 VSCode settings.json 中添加如下配置 ```json theme={null} { "chatgpt.cliExecutable": "/home/path/.codex/pcodex.sh" } ``` 注意请将 `/home/path` 替换为实际 Home 目录路径 # DeepChat Source: https://docs.jiekou.ai/docs/integration/deepchat DeepChat 是一款企业级智能对话平台，基于先进的大语言模型（LLM）技术，为用户提供流畅自然的对话体验。 专注于为以下场景提供解决方案： * 个人知识管理：整合个人文档、笔记和知识，实现智能问答和内容生成。 * 企业知识库：连接企业内部知识资源，为团队成员提供智能信息检索。 * 自定义对话场景：通过灵活的模型配置和提示词工程，打造适合特定领域的对话体验。 通过对接 JieKou.AI，你可以轻松接入多种海内外大模型，包括 Claude-haiku-4-5、Gemini-2.5-flash、Gpt-5以及其他兼容模型，享受更高的灵活性和扩展性。 只需1分钟，带你轻松配置JieKou.AI × DeepChat 。 # JieKou.AI × DeepChat 配置教程 ## 配置前置条件 ### (1) 获取 API 密钥注册 注册并登录 JieKou.AI，注册时填写邀请码【YGHNZ0】可得 \$2 注册奖励。 打开【API key】管理页面，点击添加按钮，输入自定义密钥名称，生成API密钥。 ### (2) 生成并保存 API 密钥 !注意:密钥在服务端是加密存储，创建后无法再次查看，请妥善保存好密钥；若遗失需要在控制台上删除并创建一个新的密钥。 ### (3) 获取需要使用的模型 ID 在 JieKou.AI 的模型广场找到想用的模型，复制模型id。 * Claude-sonnet-4-5 * Gpt-5 * Gpt-4o * Gemini-2.5-pro 其他模型ID、最大上下文及价格可参考：模型广场 ## 软件配置及使用 ### (1) 下载并配置服务商 进入 DeepChat 官网，下载并安装软件。 打开软件，在【选择服务商】中，开启【JieKou.AI】选项，并将此前复制的API密钥粘贴至【API 密钥】输入框。 ### (2) 配置所需模型，即可开启畅聊 在 DeepChat【服务商设置】中选择 JieKou.AI并配置模型列表，选择【添加模型】，填入模型id，点击确认。 现在，你可以在 DeepChat 畅用海外大模型啦！ # DeepSearcher Source: https://docs.jiekou.ai/docs/integration/deepsearcher DeepSearcher 结合了尖端的 LLM（OpenAI o1、o3-mini、DeepSeek、Grok 3、Claude 4 Sonnet、Llama 4、QwQ 等）和向量数据库（Milvus、Zilliz Cloud 等），基于私有数据执行搜索、评估和推理，提供高度准确的答案和全面的报告。 **非常适合用于：** 企业知识管理、智能问答系统和信息检索场景。 Example Image1 ## 1.获取JieKou.AI配置信息 ### （1）获取 API 密钥注册 注册并登录 JieKou.AI，注册时填写邀请码【YGHNZ0】可得 \$2 注册奖励。 Example Image2 打开【API key】管理页面，点击添加按钮，输入自定义密钥名称，生成API密钥。 Example Image3 Example Image4 ### （2）生成并保存 API 密钥 !注意:密钥在服务端是加密存储，创建后无法再次查看，请妥善保存好密钥；若遗失需要在控制台上删除并创建一个新的密钥。 Example Image5 ### （3）获取需要使用的模型 ID 在 JieKou.AI 的模型广场找到想用的模型，复制模型id和基础URL。 Example Image6 * Gemini-3-pro-preview * Gemini-2.5-pro * Claude-sonnet-4-5 * Gpt-5.1 * Gpt-4o 其他模型ID、最大上下文及价格可参考：[模型广场](https://jiekou.vip/models-console/library?auth_res=success\&is_reg=false) ## 2.安装DeepSearcher 具体安装指南参考：[https://github.com/zilliztech/deep-searcher](https://github.com/zilliztech/deep-searcher) （1）克隆仓库 ``` git clone https://github.com/zilliztech/deep-searcher.git cd deep-searcher ``` （2）创建一个虚拟环境并激活它 ``` #MAKE SURE the python version is greater than or equal to 3.10 python3 -m venv .venv source .venv/bin/activate ``` （3）安装依赖 ``` pip install -e . ``` ## 3.修改示例代码以接入 JieKou.AI 模型 示例代码位于 `examples/basic_example.py`。可以使用此示例来运行 DeepSearcher。 （1）配置 API Key 将您刚刚获取的 API Key 设置到本地环境变量`JIEKOU_API_KEY`中。 ``` export JIEKOU_API_KEY="您的 JIEKOU API Key" ``` （2）配置LLM与Embedding模型 在示例代码的 `config = Configuration()` 这一行后添加代码 ``` config.set_provider_config("llm", "JiekouAI", {"model": "claude-sonnet-4-5-20250929"}) config.set_provider_config("embedding", "JiekouAIEmbedding", {"model": "qwen/qwen3-embedding-8b"}) ``` （3）配置需要检索的文件路径与 prompt 从指定的本地路径加载文件，并将其内容存储到的集合中。修改调用 `load_from_local_files` 处的代码。 您可以使用项目提供的 `examples/data/WhatisMilvus.pdf` 文件，也可以使用您自己的文件。 如需执行时删除并重新创建该集合，可将 `force_new_collection` 设置为 `True` ``` load_from_local_files( paths_or_directory=os.path.join(current_dir, "data/WhatisMilvus.pdf"), collection_name="milvus_docs", collection_description="All Milvus Documents", force_new_collection=True, # If you want to drop origin collection and create a new collection every time,set force_new_collection to True ) question="Write a report comparing Milvus with other vector databases." ``` （4）运行示例代码在项目根目录下运行： ``` python examples/basic_example.py ``` # LangBot Source: https://docs.jiekou.ai/docs/integration/langbot LangBot 是一个开源的大语言模型（LLM）原生即时通信机器人平台，旨在提供开箱即用的 IM 机器人开发体验，具有 Agent、RAG、MCP 等多种 LLM 应用功能，适配飞书、钉钉、QQ 、企业微信、Discord、Slack 等全球主流即时通信平台，并提供丰富的 API 接口，支持自定义开发。 在JieKou.AI 提供的模型 API 服务加持下，LangBot 可接入 Claude-sonnet-4-5、Gpt-5、Gpt-4o、Gemini-2.5-pro 等海内外主流模型，用户可按需选择，适配不同场景调用需求。 # JieKou.AI × LangBot 配置教程 ## 1.获取API key 访问[JieKou.AI](https://jiekou.vip/),注册并登录。 填写邀请码【YGHNZ0】可得 \$2 注册奖励。 ### **（1）获取 API 密钥** 打开【API key】管理页面，点击添加按钮，输入自定义密钥名称，生成API密钥。 ### **（2）生成并保存 API 密钥** \*\*!!注意：\*\*密钥在服务端是加密存储，创建后无法再次查看，请妥善保存好密钥；若遗失需要在控制台上删除并创建一个新的密钥。 ### **（3）获取【模型 ID】** **推荐使用的模型 ID：** * Claude-sonnet-4-5 * Gpt-5 * Gpt-4o * Gemini-2.5-pro 其他模型 ID、最大上下文及价格可参考[模型广场](https://jiekou.vip/models-console/library)。 ## 2.部署并配置 LangBot 通过 Docker 可以方便地将 LangBot 部署到 Windows, Mac, Linux 上。 部署前，请先确保 Git、 Docker 和 Docker Compose 已安装。 项目地址：*[https://github.com/RockChinQ/LangBot](https://github.com/RockChinQ/LangBot)* ### **（1）通过 Docker 部署 LangBot** Git 克隆本项目： ``` git clone https://github.com/langbot-app/LangBot cd LangBot/docker ``` 启动容器： ``` docker compose up ``` * 如果你的主机位于中国大陆，可以把上方命令的`https://github.com/langbot-app/LangBot`改为`https://gitcode.com/RockChinQ/LangBot`以使用国内镜像源。 * 如果你的主机位于中国大陆，可以考虑把 `docker-compose.yaml` 文件中的镜像名称改为`docker.langbot.app/langbot-public/rockchin/langbot:latest`以使用我们提供的镜像源。 * 推荐设置 Docker 容器代理，以便保证 LangBot 在运行期间的网络访问通畅。 ### **（2）创建配置文件** 首次启动会输出创建配置文件的提示，请继续按照文件配置。 容器会映射 5300 端口供 WebUI 使用，您可以访问 [http://127.0.0.1:5300](http://127.0.0.1:5300) 查看 WebUI。 还会映射 2280-2290 端口供使用 OneBot 协议的消息平台适配器反向连接。 ### **（3）配置对话模型** 打开 LangBot，点击模型配置，模型提供商选择 **接口AI**。 按以下信息配置模型。 * 模型名称：从 JieKou.AI 官网复制的所需模型名称 * 模型提供商：接口AI * 请求 URL：*[https://api.highwayapi.ai/openai](https://api.highwayapi.ai/openai)* * API Key：从 JieKou.AI 官网保存的密钥 ## **3.接入平台** LangBot 支持将聊天机器人接入到 QQ、微信公众平台、飞书等平台，以钉钉为例， LangBot 接入教程如下。 ### **（1）创建机器人** 进入钉钉开发者后台，登录并且进入组织。 地址：*[https://open-dev.dingtalk.com/](https://open-dev.dingtalk.com/)* 点击上方的【应用开发】，选择【创建应用】，填写机器人的基本信息并保存。 进入机器人的后台，比如我们有机器人 langbot2 ,那么它的管理页面是这样的： ### **（2）配置机器人** 选择【添加应用能力】，为应用添加机器人能力。 点击左侧【机器人】选项卡，填写机器人配置信息，完成名称、简介、消息名称等基础配置，配置完成后，点击发布。 发布成功之后，点击左侧最下方的【版本管理与发布】，配置应用版本号及版本描述。 如果是第一次创建机器人，那么右边是空的，需要点击【创建新版本】，在其中设置信息，然后设置【应用可见范围】，点击保存。 【事件订阅】选择【Stream 模式】，无需注册公网回调地址。 点击【凭证与基础信息】，记录 Client ID 和 Client Secret， 点击左侧机器人，记录下 RobotCode 和 机器人名称。 以上配置项记录下来后，填到 LangBot 机器人配置表单中，点击[卡片平台](https://open-dev.dingtalk.com/fe/card?spm=ding_open_doc.document.0.0.33cf2281L0fXsV)模板列表复制绑定的对应的模板id填入卡片模板id。 启动 LangBot ，编辑机器人，绑定流水线（初始会有一个 ChatPipeline 流水线），平台选择钉钉。 编辑流水线，在 AI 能力配置中，选择内置 Agent，并选择此前绑定好的所需模型。 ### **（3）添加机器人** 在钉钉搜索刚刚配置的机器人名称，点击机器人即可和机器人聊天。 如果想要将机器人添加到群里，可以点击钉钉群的【群管理】选择【添加机器人】，然后搜索机器人名称即可在群聊中使用。 # OpenClaw Source: https://docs.jiekou.ai/docs/integration/openclaw OpenClaw 是一个开源的个人 AI 助手平台，主打“真正帮你做事”而不只是聊天：它可以运行在你的本地设备上，接入 WhatsApp、Telegram、Slack、飞书 等聊天工具，并结合邮件、日历、浏览器、文件系统和脚本执行能力，帮助你完成自动化任务；同时支持持久记忆、多模型接入和技能扩展，适合希望拥有一个可控、可定制、能实际执行工作的私人 AI 助手的用户。 # 安装 这里使用较简单的安装方式，其他请参考官方文档 [https://docs.openclaw.ai/](https://docs.openclaw.ai/) ## 系统要求 * Node >=22 * macOS、Linux 或通过 WSL2 的 Windows * pnpm 仅在从源代码构建时需要 ## 快速安装 ```bash theme={null} curl -fsSL https://openclaw.ai/install.sh | bash ``` # 接入 接口AI API 修改 `~/.openclaw/openclaw.json` 配置文件，字段值可根据需求修改 * models 字段 ```json theme={null} "models": { "mode": "merge", "providers": { "": { "baseUrl": "", "apiKey": "", "api": "", "models": [ { "id": "", "name": "", "reasoning": false, "input": [ "text" ], "cost": { "input": 0, "output": 0, "cacheRead": 0, "cacheWrite": 0 }, "contextWindow": , "maxTokens": } ] } } } ``` * agent 字段 ```json theme={null} "agents": { "defaults": { "model": { "primary": "/" }, "models": { "/": { "alias": "" } }, "workspace": "/.openclaw/workspace", "compaction": { "mode": "safeguard" }, "maxConcurrent": 4, "subagents": { "maxConcurrent": 8 } } } ``` * 示例： ```json theme={null} "models": { "mode": "merge", "providers": { "Jiekou": { "baseUrl": "https://api.highwayapi.ai/openai/v1", "apiKey": "sk_xxxxxxxxxxxxxxxxxx", "api": "openai-completions", "models": [ { "id": "gpt-5.4", "name": "gpt-5.4 (Custom Provider)", "reasoning": false, "input": [ "text" ], "cost": { "input": 0, "output": 0, "cacheRead": 0, "cacheWrite": 0 }, "contextWindow": 16000, "maxTokens": 4096 } ] } } }, "agents": { "defaults": { "model": { "primary": "jiekou/gpt-5.4" }, "models": { "Jiekou/gpt-5.4": { "alias": "gpt-5.4" } }, "workspace": "/Users/0000/.openclaw/workspace", "compaction": { "mode": "safeguard" }, "maxConcurrent": 4, "subagents": { "maxConcurrent": 8 } } }, ``` # OpenCode Source: https://docs.jiekou.ai/docs/integration/opencode OpenCode 是一款面向开发者的开源 AI 编程智能体（Coding Agent），主打“终端原生”体验：通过 TUI/CLI 在命令行内完成需求讨论、代码生成、重构、解释与调试等工作流。它强调“模型无关”，可接入 Claude、GPT、Gemini 等多家模型服务，也支持对接本地或 OpenAI 兼容接口，便于在成本、效果与隐私之间自由取舍。OpenCode 还提供可扩展的插件/工具机制与配置体系，能把项目上下文、命令执行等能力纳入自动化流程，适合重度终端用户与希望自定义 AI 编程工作流的团队使用。 # 安装及接入 ## 安装 ```bash theme={null} curl -fsSL https://opencode.ai/install | bash ``` 其他安装方式见 OpenCode 官方网站：[https://opencode.ai/docs/#install](https://opencode.ai/docs/#install) ## 启动 OpenCode ```bash theme={null} cd /path/to/project # 进入项目路径 opencode # 启动 OpenCode ``` ## 接入 JieKou API * 全局配置：\~/.config/opencode/opencode.json * 项目配置：项目根目录下的 opencode.json （若没有 opencode.json，可以手动创建） 配置如下： ```JSON theme={null} { "$schema": "https://opencode.ai/config.json", "provider": { "myprovider": { "npm": "@ai-sdk/openai-compatible", "name": "JieKou", "options": { "baseURL": "https://api.highwayapi.ai/openai/v1" }, "models": { "claude-sonnet-4-5-20250929": { "name": "claude-sonnet-4-5-20250929" }, "gpt-5.2": { "name": "gpt-5.2" }, } } } } ``` 配置第三方供应商时，需要注意选择正确的 npm 包： | **npm 包** | **API 类型** | **适用场景** | | ------------------------- | ------------------- | ----------------- | | @ai-sdk/openai-compatible | Chat Completion API | GPT、Claude 等大部分模型 | | @ai-sdk/openai | Response API | Codex 系列模型 | **注意：** Codex 模型（如 gpt-5.1-codex）需要使用 @ai-sdk/openai（Response API），其他模型使用 @ai-sdk/openai-compatible（Chat Completion API）。 ## 配置 KEY 进入 opencode，使用 `/connect` 选择供应商后，填写 API KEY，enter 确定 opencode_input_api_key ## 开始使用 连接供应商后，可使用 `/models` 命令选择模型 opencode_choose_model # 其他用法 ## 示例：本地 MCP 配置（以计算 MCP 为例） 1. 使用 python + MCP SDK 编写计算器 mcp server 代码，并保存到本地路径中 ```python theme={null} import asyncio import math from mcp.server import Server from mcp.server.stdio import stdio_server from mcp.types import Tool, TextContent # Create server instance server = Server("calculator") @server.list_tools() async def list_tools() -> list[Tool]: """List available calculator tools.""" return [ Tool( name="add", description="Add two numbers", inputSchema={ "type": "object", "properties": { "a": {"type": "number", "description": "First number"}, "b": {"type": "number", "description": "Second number"}, }, "required": ["a", "b"], }, ), Tool( name="subtract", description="Subtract second number from first number", inputSchema={ "type": "object", "properties": { "a": {"type": "number", "description": "First number"}, "b": {"type": "number", "description": "Second number to subtract"}, }, "required": ["a", "b"], }, ), Tool( name="multiply", description="Multiply two numbers", inputSchema={ "type": "object", "properties": { "a": {"type": "number", "description": "First number"}, "b": {"type": "number", "description": "Second number"}, }, "required": ["a", "b"], }, ), Tool( name="divide", description="Divide first number by second number", inputSchema={ "type": "object", "properties": { "a": {"type": "number", "description": "Dividend"}, "b": {"type": "number", "description": "Divisor"}, }, "required": ["a", "b"], }, ), Tool( name="power", description="Raise a number to a power", inputSchema={ "type": "object", "properties": { "base": {"type": "number", "description": "Base number"}, "exponent": {"type": "number", "description": "Exponent"}, }, "required": ["base", "exponent"], }, ), Tool( name="sqrt", description="Calculate square root of a number", inputSchema={ "type": "object", "properties": { "a": {"type": "number", "description": "Number to calculate square root of"}, }, "required": ["a"], }, ), Tool( name="modulo", description="Calculate remainder of division", inputSchema={ "type": "object", "properties": { "a": {"type": "number", "description": "Dividend"}, "b": {"type": "number", "description": "Divisor"}, }, "required": ["a", "b"], }, ), ] @server.call_tool() async def call_tool(name: str, arguments: dict) -> list[TextContent]: """Handle tool calls for calculator operations.""" try: if name == "add": result = arguments["a"] + arguments["b"] elif name == "subtract": result = arguments["a"] - arguments["b"] elif name == "multiply": result = arguments["a"] * arguments["b"] elif name == "divide": if arguments["b"] == 0: return [TextContent(type="text", text="Error: Division by zero")] result = arguments["a"] / arguments["b"] elif name == "power": result = math.pow(arguments["base"], arguments["exponent"]) elif name == "sqrt": if arguments["a"] < 0: return [TextContent(type="text", text="Error: Cannot calculate square root of negative number")] result = math.sqrt(arguments["a"]) elif name == "modulo": if arguments["b"] == 0: return [TextContent(type="text", text="Error: Modulo by zero")] result = arguments["a"] % arguments["b"] else: return [TextContent(type="text", text=f"Error: Unknown tool '{name}'")] return [TextContent(type="text", text=str(result))] except Exception as e: return [TextContent(type="text", text=f"Error: {str(e)}")] async def main(): """Run the calculator MCP server.""" async with stdio_server() as (read_stream, write_stream): await server.run(read_stream, write_stream, server.create_initialization_options()) if __name__ == "__main__": asyncio.run(main()) ``` 2. 在 opencode.json 添加本地 mcp ```json theme={null} { "mcp": { "calc_mcp": { "type": "local", "command": ["python3", "{your_local_path}/calc_mcp.py"], "enabled": true } } } ``` 3. 使用 `/mcps` 查看 mcp 连接状态，Enabled 状态时，可令 opencode 调用 opencode_mcp # OpenManus Source: https://docs.jiekou.ai/docs/integration/openmanus OpenManus-RL 是由 Ulab-UIUC 和 MetaGPT 联合主导的开源项目，是Manus的复刻开源版本-OpenManus的扩展版本，受 Deepseek-R1、QwQ-32B 等基于 RL 调优推理 LLM 的成功启发，旨在探索基于 RL 的 LLM 智能体调优新范式，会定期公开在 GAIA、AgentBench 等智能体基准上的测试进展和调优模型。 为了帮助大家更好地使用 OpenManus，我们准备了一份详细教程，从环境配置到接入『接口AI』，手把手教你玩转 OpenManus！ ## 1.配置前置条件 ### （1）获取 API 密钥注册 注册并登录 JieKou.AI，注册时填写邀请码【YGHNZ0】可得 \$2 注册奖励。 Example Image1 Example Image2 打开【API key】管理页面，点击添加按钮，输入自定义密钥名称，生成API密钥。 Example Image3 ### （2）生成并保存 API 密钥 !注意:密钥在服务端是加密存储，创建后无法再次查看，请妥善保存好密钥；若遗失需要在控制台上删除并创建一个新的密钥。 Example Image4 ### （3）获取需要使用的模型 ID 在 JieKou.AI 的模型广场找到想用的模型，复制模型id和基础URL。 * Gemini-3-pro-preview * Gemini-2.5-pro * Claude-sonnet-4-5 * Gpt-5.1 * Gpt-4o 其他模型ID、最大上下文及价格可参考：[模型广场](https://jiekou.vip/models-console/library?auth_res=success\&is_reg=false) ## 2. 安装 OpenManus 具体安装指南参考：[安装指南](https://github.com/FoundationAgents/OpenManus/blob/main/README_zh.md#%E5%AE%89%E8%A3%85%E6%8C%87%E5%8D%97)。下列安装教程以windows系统，以安装指南中的"方式二"为例。 1.安装 uv（一个快速的 Python 包管理器）： ``` curl -LsSf https://astral.sh/uv/install.sh | sh ``` 2.克隆仓库： ``` git clone https://github.com/FoundationAgents/OpenManus.git cd OpenManus ``` 3.创建并激活虚拟环境： ``` uv venv --python 3.12 source .venv/bin/activate # Unix/macOS 系统 Windows 系统使用： .venv\Scripts\activate ``` 4.安装依赖： ``` uv pip install -r requirements.txt ``` ## 3.配置 OpenManus OpenManus 需要配置使用的 LLM API，请按以下步骤设置： 1.在 `config` 目录创建 `config.toml` 文件（可从示例复制）： ``` cp config/config.example.toml config/config.toml ``` 2.编辑 `config/config.toml` ，更改【model】，【base\_url】，【api\_key】，添加 API 密钥和自定义设置： ``` #全局 LLM 配置 [llm] model = "gpt-4o"#如需更改模型，复制接口AI官网模型名称在此 base_url = "https://api.highwayapi.ai/openai" api_key = "在此处粘贴接口AI官网的API Key" # 此处更改 max_tokens = 4096 temperature = 0.0 # 可选特定 LLM 模型配置 [llm.vision] model = "gpt-4o"#如需更改模型，复制接口AI官网模型名称在此 base_url = "https://api.highwayapi.ai/openai" api_key ="在此处粘贴接口AI官网的API Key" # 此处更改 ``` ## 4.快速启动 OpenManus 一行命令运行 OpenManus： ``` python main.py ``` 然后在 `enter your prompt` 后输入你的创意！ # RAGFlow Source: https://docs.jiekou.ai/docs/integration/ragflow RAGFlow 是一款基于深度文档理解的开源 RAG（检索增强生成）引擎。它将前沿的 RAG 技术与代理功能融合，为生命周期管理 (LLM) 创建卓越的上下文层。它提供精简的 RAG 工作流程，可适应各种规模的企业。RAGFlow 由融合的上下文引擎和预构建的代理模板驱动，使开发人员能够以卓越的效率和精度将复杂数据转化为高保真、可用于生产环境的 AI 系统。 为了帮助大家更好地使用 RAGFlow，我们准备了一份详细教程，从环境配置到接入『接口AI』，3 分钟教你玩转 RAGFlow！ ## 1.配置前置条件 ### （1）获取 API 密钥注册 注册并登录 JieKou.AI，注册时填写邀请码【YGHNZ0】可得 \$2 注册奖励。 Example Image1 打开【API key】管理页面，点击添加按钮，输入自定义密钥名称，生成API密钥。 Example Image2 Example Image3 ### （2）生成并保存 API 密钥 !注意:密钥在服务端是加密存储，创建后无法再次查看，请妥善保存好密钥；若遗失需要在控制台上删除并创建一个新的密钥。 Example Image4 ### （3）获取需要使用的模型 ID 在 JieKou.AI 的模型广场找到想用的模型，复制模型id和基础URL。 Example Image5 * Gemini-3-pro-preview * Gemini-2.5-pro * Claude-sonnet-4-5 * Gpt-5.1 * Gpt-4o 其他模型ID、最大上下文及价格可参考：[模型广场](https://jiekou.vip/models-console/library?auth_res=success\&is_reg=false) ## 2. RAGFlow添加与配置LLM ### （1）访问 [RAGFlow 官网](https://ragflow.io/) Example Image6 ### （2）添加模型 选择【模型供应商】，找到【OpenAI-API-Compatible】，点击【添加模型】 Example Image7 ### （3）选择和填写对应配置。 Example Image8 ### （4）添加成功。 Example Image9 关于RAGFlow的更多配置，您可参考[RAGFlow文档](https://ragflow.io/docs/dev/)。 # 推理模型 Source: https://docs.jiekou.ai/docs/model/inference ## 功能介绍 推理模型是针对复杂问题解决和推理任务优化的高级语言模型，通过输出详细的推理步骤（思维链）提升问题求解的准确性。 ### 典型应用场景 * **复杂问题解决**：适用于需要逐步推导、明确逻辑步骤的场景，例如数学、科学推理。 * **决策支持系统**：提供详细推理过程支持决策分析，帮助理解决策背后的逻辑。 * **教育和培训**：帮助用户学习和理解复杂知识，提供详细的推导过程。 ## 安装与准备 在使用推理模型前，请确保已安装最新版本的 OpenAI SDK： ```bash theme={null} pip install -U openai ``` ## API 调用方法 通过调用 `/chat/completions` 接口使用推理模型。 ### 请求参数说明 * `max_tokens`：设置模型输出的最大 token 数。 * `temperature`：建议设置为 0.5 至 0.7（推荐 0.6）以平衡输出的创造性与逻辑性。 * `top_p`：建议设置为 0.95。 ### 示例请求代码 #### 流式输出请求 ```python theme={null} from openai import OpenAI client = OpenAI(api_key="YOUR_API_KEY", base_url="https://api.highwayapi.ai/openai") messages = [ {"role": "user", "content": "解释一下牛顿第二定律。"} ] response = client.chat.completions.create( model="deepseek/deepseek-r1", messages=messages, stream=True, max_tokens=4096 ) content = "" reasoning_content = "" for chunk in response: if chunk.choices[0].delta.content: content += chunk.choices[0].delta.content if chunk.choices[0].delta.reasoning_content: reasoning_content += chunk.choices[0].delta.reasoning_content print("最终回答：", content) print("推理过程：", reasoning_content) ``` #### 非流式输出请求 ```python theme={null} response = client.chat.completions.create( model="deepseek/deepseek-r1", messages=[ {"role": "user", "content": "什么是温室效应？如何减缓？"} ], stream=False, max_tokens=4096 ) content = response.choices[0].message.content reasoning_content = response.choices[0].message.reasoning_content print("最终回答：", content) print("推理过程：", reasoning_content) ``` ## 上下文管理 模型返回的推理内容不会自动拼接到下一轮对话中，用户需手动管理对话历史： ```python theme={null} messages.append({"role": "assistant", "content": content}) messages.append({"role": "user", "content": "继续解释一下解决方案。"}) ``` ## 支持模型列表 ## 计费方式 * 根据输入和输出的 token 数进行计费。 * 具体计费标准及转换规则，请在模型详情页查询。 ## 注意事项与最佳实践 * 不要在 `system` 消息中添加推理指令，应在 `user` 消息中直接明确指令。 * 在数学问题中明确指出要求，例如：“请逐步推理并明确最终答案。” * 为避免模型跳过推理环节，建议强制模型在输出前添加换行符。 # 大语言模型 Source: https://docs.jiekou.ai/docs/model/llm ## 模型能力 大语言模型（LLM）是一种基于深度学习和自然语言处理技术的人工智能模型。经过大量的文本数据进行训练，它能够理解、生成和处理人类语言。主要具备以下能力： * **文本生成** 能够基于上下文生成逻辑连贯的文本内容，并根据需要调整输出风格。 * **语言理解** 能够准确理解输入文本的含义，并支持结合上下文进行对话。 * **文本翻译** 具备跨语言生成和理解的能力，可以实现不同语言之间的文本翻译。 * **知识问答** 具有丰富的知识储备，能够回答文化、科学、历史等各个领域的问题。 * **代码理解和生成** 能够理解并生成代码（如 Python、Java、C++等），支持识别代码错误，提供代码建议等。 * **文本分类和摘要** 能够理解复杂语句，进行信息分类和抽取，可以提取文本的关键点进行自动摘要。 ## 模型选型 在 [JieKou AI](https://jiekou.vip/#model-library)，您可以查看平台支持的大语言模型列表，了解模型的基本介绍，价格等信息。单击具体的某一个模型，可以打开详情页面，按需进行在线体验。在结合具体任务进行充分体验后，您可以对比模型表现，选择适合的模型。 ## 接口调用 JieKou AI 提供了与 OpenAI API 标准兼容的 API 服务，方便您集成到现有应用程序中。 * [ChatCompletion](https://platform.openai.com/docs/api-reference/chat)，支持 streaming 模式和常规模式。 * [Completion](https://platform.openai.com/docs/api-reference/completions)，支持 streaming 模式和常规模式。 如果您已经在使用 OpenAI 的 ChatCompletion 或 Completion API，您只需将基础 URL 设置为`https://api.highwayapi.ai/openai`，获取并设置您的 API 密钥，并按需更新模型名称，即可接入大语言模型 API 服务。 关于如何获取 API 密钥，请参见[管理 API 密钥](/docs/support/quickstart#2-管理-api-密钥)。 ### 代码示例 #### Python ```python ChatCompletion theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.highwayapi.ai/openai", api_key="", ) model = "deepseek/deepseek-r1" stream = True # 或 False max_tokens = 512 chat_completion_res = client.chat.completions.create( model=model, messages=[ { "role": "system", "content": "您是一个专业的 AI 文档助手。", }, { "role": "user", "content": "JieKou AI 提供的模型能用于哪些场景？", } ], stream=stream, max_tokens=max_tokens, ) if stream: for chunk in chat_completion_res: print(chunk.choices[0].delta.content or "", end="") else: print(chat_completion_res.choices[0].message.content) ``` ```python Completion theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.highwayapi.ai/openai", api_key="", ) model = "deepseek/deepseek-r1" stream = True # 或 False max_tokens = 512 completion_res = client.completions.create( model=model, prompt="JieKou AI 提供的模型能用于哪些场景？", stream=stream, max_tokens=max_tokens, ) if stream: for chunk in completion_res: print(chunk.choices[0].text or "", end="") else: print(completion_res.choices[0].text) ``` #### Curl ```bash ChatCompletion theme={null} export API_KEY="" curl "https://api.highwayapi.ai/openai/v1/chat/completions" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${API_KEY}" \ -d '{ "model": "deepseek/deepseek-r1", "messages": [ { "role": "system", "content": "您是一个专业的 AI 文档助手。" }, { "role": "user", "content": "JieKou AI 提供的模型能用于哪些场景？" } ], "max_tokens": 512 }' ``` ```bash Completion theme={null} export API_KEY="" curl "https://api.highwayapi.ai/openai/v1/completions" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${API_KEY}" \ -d '{ "model": "deepseek/deepseek-r1", "prompt": "JieKou AI 提供的模型能用于哪些场景？", "max_tokens": 512 }' ``` ### 重点参数 #### 基础参数 `model`：要调用的模型。您可以在 [JieKou AI](https://jiekou.vip/#model-library) 查看平台支持的大语言模型列表。 #### 消息角色 > 仅适用于 ChatCompletion。 `messages`：和大模型进行交互时的输入输出。每条消息都属于一个角色。消息可以帮助您获得更好的输出，您可以尝试不同的方法，以获得更好的结果。 * `content`：消息内容。 * `role`：消息作者的角色。 * `system`：设定 AI 角色，告知模型要扮演的角色或者行为。 * `user`：用户输入给模型的文本。 * `assistant`：模型生成的回复。用户也可以预先填写示例，告知模型应该如何回应当前请求。 * `name`：可选，用于区分相同角色的消息作者。 #### 提示词 > 仅适用于 Completion。 `prompt`：生成补全的提示词。是用户输入给大语言模型的文本信息，用于明确地告诉模型想要解决的问题或完成的任务，也是模型理解需求并生成相关、准确内容的基础。 #### 控制生成 不同的参数组合可以让模型生成出更符合特定需求的内容。 **文本多样性** > `temperature`与`top_p`均可控制生成文本的多样性，建议您只设置其中一个值。设置的数值越大，生成的文本越多样。数值越小，生成的文本越确定。 * `temperature`：采样温度，调整生成文本的随机性。 * `top_p`：核采样，控制候选词累计概率。 * `top_k`：限制候选词数量。 **内容重复性** * `presence_penalty`：存在惩罚，控制模型生成文本时的内容重复度。如果一个 Token 在文本中已经出现，就会受到惩罚，这会使得模型引入更多新的 Token 。 * `frequency_penalty`：概率惩罚，控制生成文本中某些词的出现频率。让 Token 每次在文本中出现都受到惩罚，从而减少这些 Token 在未来生成中的概率，阻止模型重复使用相同的 Token。 * `repetition_penalty`：重复惩罚值，用于抑制或者鼓励重复。 #### 输出限制 * `max_tokens`：单次请求返回的最大 Token 数。如果模型生成的 Token 数超过`max_tokens`的值，会返回截断后的内容。 * `stream`：控制输出是否是流式输出。对于一些输出内容比较多的模型，建议设置为流式输出，防止输出过长，导致输出超时。 * `true`：流式输出，即边生成边输出，模型每生成一部分内容就返回一个片段。 * `false`：模型生成完所有内容后一次性返回结果。 * `stop`：终止字符。当模型生成的文本包含`stop`设置的字符串时，模型会停止输出。 # 兼容 Anthropic SDK Source: https://docs.jiekou.ai/docs/model/llm-anthropic-compatibility JieKou AI 提供了与 Anthropic SDK 兼容的 API 服务，方便您集成到现有应用程序中。如果您已经使用 Anthropic SDK 开发了应用程序，只需要将 base URL 和 API Key 替换为 JieKou AI 的 API 地址和 API Key 即可。请参考下面的接入指南。 ## 支持的模型 目前只有以下模型提供了 Anthropic SDK 兼容性支持： ## 快速开始 ### 1. 安装 Anthropic SDK ```bash Python icon="python" theme={null} pip install anthropic ``` ```bash TypeScript icon="js" theme={null} npm install @anthropic-ai/sdk ``` ### 2. 初始化客户端 Anthropic SDK 会尝试从环境变量 `ANTHROPIC_API_KEY` 和 `ANTHROPIC_BASE_URL` 中分别获取 API Key 和 base URL。您也可以在初始化客户端的时候通过参数来指定。 * 基于环境变量设置 ```bash Bash icon="terminal" theme={null} export ANTHROPIC_BASE_URL="https://api.highwayapi.ai/anthropic" export ANTHROPIC_API_KEY="" ``` * 通过在初始化 Anthropic 客户端时设置参数 ```python Python icon="python" theme={null} import anthropic client = anthropic.Anthropic( base_url="https://api.highwayapi.ai/anthropic", api_key="", # 重写 header default_headers={ "Content-Type": "application/json", "Authorization": "Bearer ", } ) ``` ```typescript TypeScript icon="js" theme={null} import Anthropic from "@anthropic-ai/sdk"; const anthropic = new Anthropic({ baseURL: "https://api.highwayapi.ai/anthropic", apiKey: "", // 重写 header defaultHeaders: { "Content-Type": "application/json", Authorization: `Bearer `, } }); ``` ### 3. 调用 API ```python Python icon="python" theme={null} import anthropic # 初始化客户端，如果您已经通过环境变量 `ANTHROPIC_BASE_URL` 和 `ANTHROPIC_API_KEY` # 设置了 API Key 和 base URL，可以省略 `api_key` 和 `base_url` 参数。 client = anthropic.Anthropic( base_url="https://api.highwayapi.ai/anthropic", api_key="", # 重写 header default_headers={ "Content-Type": "application/json", "Authorization": "Bearer ", } ) message = client.messages.create( model="moonshotai/kimi-k2-instruct", max_tokens=1000, temperature=1, system=[ { "type": "text", "text": "你是 JieKou AI AI 助手，你会以诚实专业的态度帮助用户，用中文回答问题。" } ], messages=[ { "role": "user", "content": [ { "type": "text", "text": "你是谁?" } ] } ] ) print(message.content) ``` ```typescript TypeScript icon="js" theme={null} import Anthropic from "@anthropic-ai/sdk"; // 初始化客户端，如果您已经通过环境变量 `ANTHROPIC_BASE_URL` 和 `ANTHROPIC_API_KEY` // 设置了 API Key 和 base URL，可以省略 `baseURL` 和 `apiKey` 参数。 const anthropic = new Anthropic({ baseURL: "https://api.highwayapi.ai/anthropic", apiKey: "", // 重写 header defaultHeaders: { "Content-Type": "application/json", Authorization: `Bearer `, }, }); const msg = await anthropic.messages.create({ model: "moonshotai/kimi-k2-instruct", max_tokens: 1000, temperature: 1, system: "你是 JieKou AI AI 助手，你会以诚实专业的态度帮助用户，用中文回答问题。", messages: [ { role: "user", content: [ { type: "text", text: "你是谁?" } ] } ] }); console.log(msg); ``` # 大语言模型监控 Source: https://docs.jiekou.ai/docs/model/llm-api-metrics JieKou AI 为大语言模型 API 使用提供了全面的监控指标。这些指标让您能够深入了解 LLM API 请求的可用性和性能。 您可以通过 [大语言模型（LLM）监控页面](https://jiekou.vip/models-console/llm-metrics) 查看监控指标。 ## 指标说明 以下所有指标均按**模型划分维度**，并以**分钟级别**进行采样，但根据您选择的时间间隔，采样点可能不会每分钟都显示。在这种情况下，该时间间隔内的采样点将被平均后显示。 * **每分钟请求数 (RPM)** 显示每分钟发出的 API 请求数量，帮助您了解使用模式和 API 并发级别。 * **请求成功率** 显示每分钟成功 API 响应（非 5xx 状态码）的百分比，反映 API 的可用性。 * **每个请求的平均 Token 数量** 显示每分钟每个请求的平均输入和输出 Token 数量，有助于了解 Token 消耗模式。 * **端到端（E2E）延迟** 显示模型在每分钟请求中生成完整响应所需的总时间。包括 99 分位、95 分位和平均的延迟指标。 * **生成第一个 Token 的时间 (TTFT)** 该指标仅在启用 `stream=true` 参数的流式请求中进行跟踪。 显示每分钟请求中处理 Prompt 并生成第一个输出 Token 所需的时间。包括 99 分位、95 分位和平均的延迟指标。 * **每个输出 Token 的时间 (TPOT)** 该指标仅在启用 `stream=true` 参数的流式请求中进行跟踪。 显示每分钟请求中连续输出 token 之间的平均时间。包括 99 分位、95 分位和平均的延迟指标。 # 工具调用（Function Calling） Source: https://docs.jiekou.ai/docs/model/llm-function-calling ## 使用场景 Function Calling 功能让模型可以与外部工具进行交互，获取实时信息或执行特定操作。这一功能提升了数据准确性，同时扩展了模型能力，使得模型不仅是简单的文本生成，而是可以支持更具动态性和实用性的应用场景。 Function Calling 的使用场景示例如下： * **动态信息查询**：通过调用 API 从外部系统实时获取天气、新闻资讯、股票行情等动态数据。例如，调用天气 API 获取实时天气信息，当用户询问当前天气时，模型可以告诉用户此时此刻的天气状况，而不是提供过时的天气预报。 * **任务操作自动化**：通过函数调用执行特定操作，用户可以通过对话触发后台进行自动化操作。例如，调用订票网站 API 预定门票，当用户咨询如何购买某一景点的门票时，模型不再只是告诉用户如何订票，而是可以帮助用户直接完成订票操作。 ## 支持的模型 以下模型支持 Function Calling： ## 使用方法 1. 定义模型要调用的工具函数。 2. 在请求中添加`tools` 参数定义模型要使用的函数。 ## 使用示例 下文提供了完整的 Python 代码示例，以查询某一地点的当前天气为例，演示如何使用 Function Calling。 对于 Function Calling 的具体 API 格式，请参考[创建聊天对话请求 API ](/docs/models/reference-llm-create-chat-completion)。 ### 1. 初始化客户端 您需要使用您的 JieKou AI API 密钥初始化客户端。 ```python theme={null} from openai import OpenAI import json client = OpenAI( base_url="https://api.highwayapi.ai/openai", api_key="", ) model = "deepseek/deepseek-v3" ``` ### 2. 定义要调用的函数 定义模型要调用的函数。以下 Python 示例演示了获取天气信息的功能。 ```python theme={null} # 示例函数，用于模拟获取天气数据。 def get_weather(location): """获取指定地点的当前天气""" print("调用 get_weather 函数，位置: ", location) # 在实际应用中，您需要在这里调用外部天气 API。 # 这是一个简化示例，返回硬编码数据。 return json.dumps({"位置": location, "温度": "20 摄氏度"}) ``` ### 3. 构造包含工具和用户消息的 API 请求 创建 API 调用请求。此请求包括 `tools` 参数，定义模型要使用的函数，以及用户的消息。 ```python theme={null} tools = [ { "type": "function", "function": { "name": "get_weather", "description": "获取一个地点的天气，用户需要首先提供地点", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "城市信息, 例如：上海", } }, "required": ["location"] }, } }, ] messages = [ { "role": "user", "content": "上海的天气怎么样？" } ] # 发送请求并打印响应 response = client.chat.completions.create( model=model, messages=messages, tools=tools, ) # 请在生产环境中检查响应是否包含工具调用 tool_call = response.choices[0].message.tool_calls[0] print(tool_call.model_dump()) ``` **输出**： ```js theme={null} {'id': '0', 'function': {'arguments': '{"location": "上海"}', 'name': 'get_weather'}, 'type': 'function'} ``` ### 4. 根据函数调用结果进行响应并获取最终答案 接下来处理函数调用，执行 `get_weather` 函数，并将结果发送回模型以生成最终响应给用户。 ```python theme={null} # 确保工具调用已从上一步定义 if tool_call: # 扩展对话历史记录，添加助手工具调用消息 messages.append(response.choices[0].message) function_name = tool_call.function.name if function_name == "get_weather": function_args = json.loads(tool_call.function.arguments) # 执行函数并获取响应 function_response = get_weather( location=function_args.get("location")) # 将函数响应添加到消息中 messages.append( { "tool_call_id": tool_call.id, "role": "tool", "content": function_response, } ) # 从模型获取最终响应，包含函数结果 answer_response = client.chat.completions.create( model=model, messages=messages, # 注意：不要在此处包含 tools 参数 ) print(answer_response.choices[0].message) ``` **输出**： ``` ChatCompletionMessage(content="上海目前的温度是 20 摄氏度。请注意，天气情况可能会随时变化，建议您查看最新的天气预报以获取更准确的信息。", refusal=None, role='assistant', function_call=None, tool_calls=None) ``` ## 完整代码 ```python theme={null} from openai import OpenAI import json client = OpenAI( base_url="https://api.highwayapi.ai/openai", api_key="", ) model = "deepseek/deepseek-v3" # 示例函数，用于模拟获取天气数据。 def get_weather(location): """获取指定地点的当前天气""" print("调用 get_weather 函数，位置: ", location) # 在实际应用中，您需要在这里调用外部天气 API。 # 这是一个简化示例，返回硬编码数据。 return json.dumps({"位置": location, "温度": "20 摄氏度"}) tools = [ { "type": "function", "function": { "name": "get_weather", "description": "获取一个地点的天气，用户需要首先提供地点", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "城市信息, 例如：上海", } }, "required": ["location"] }, } }, ] messages = [ { "role": "user", "content": "上海的天气怎么样？" } ] # 发送请求并打印响应 response = client.chat.completions.create( model=model, messages=messages, tools=tools, ) # 请在生产环境中检查响应是否包含工具调用 tool_call = response.choices[0].message.tool_calls[0] print(tool_call.model_dump()) # 确保工具调用已从上一步定义 if tool_call: # 扩展对话历史记录，添加助手工具调用消息 messages.append(response.choices[0].message) function_name = tool_call.function.name if function_name == "get_weather": function_args = json.loads(tool_call.function.arguments) # 执行函数并获取响应 function_response = get_weather( location=function_args.get("location")) # 将函数响应添加到消息中 messages.append( { "tool_call_id": tool_call.id, "role": "tool", "content": function_response, } ) # 从模型获取最终响应，包含函数结果 answer_response = client.chat.completions.create( model=model, messages=messages, # 注意：不要在此处包含 tools 参数 ) print(answer_response.choices[0].message) ``` # 调用频率控制（Rate Limits） Source: https://docs.jiekou.ai/docs/model/llm-rate-limits ## 理解调用频率控制 调用频率控制规定了在特定时间内可发起的 API 请求的数量，可以帮助优化 API 使用。 * 防止 API 滥用和误用 * 确保公平的资源分配 * 保持 API 性能和可靠性 * 保护服务的稳定性 ## 默认调用频率控制 每个账户在调用模型时都有默认的速率限制，分别以 RPM（每分钟每个模型的请求数）和 TPM（每分钟每个模型的 token 数）为单位进行衡量。速率限制会因账户等级不同而有所差异，具体标准见下方表格。
Quota 等级 资质（单位：美元）
T1 最近 3 个自然月中，单月最高充值总金额\< \$50
T2 \$50 ≤ 最近 3 个自然月中，单月最高充值总金额\< \$500
T3 \$500 ≤ 最近 3 个自然月中，单月最高充值总金额\< \$3000
T4 \$3000 ≤ 最近 3 个自然月中，单月最高充值总金额\< \$10000
T5 \$10000 ≤ 最近 3 个自然月中，单月最高充值总金额
各等级的默认速率限制（RPM / TPM）： ## 避免触发调用频率控制 如果您的 API 请求数量超过了调用频率控制，API 将返回： * HTTP 状态码：429（请求过多）。 * 响应体中返回调用频率超出的信息。 为避免触发调用频率控制，您可以采取以下措施： * 在您的应用中实现请求限制。 * 在重试时使用指数退避机制。 * 监控您的 API 使用情况。 ## 处理 429 错误 如果您收到 429 错误，您可以尝试以下操作： * **稍后再试**：等待一段时间后再重试您的请求。 * **优化请求**：减少请求频率。 * **提高调用频率控制**：如果需要更高的调用频率控制，可以联系我们。 # 推荐模型 Source: https://docs.jiekou.ai/docs/model/llm-recommended 推荐的开放模型列表，适用于常见的使用场景。 ## 我应该使用哪些模型？ 实际上，没有唯一正确的答案！以下是基于 JieKou AI 内部测试、社区反馈和外部基准测试的精选列表。我们建议将其作为起点，并会随着新模型的出现定期更新。 * 模型大小标记为小型、中型或大型 * 为了获得最佳延迟，使用小型或中型模型。为了获得最佳质量，使用大型模型或对中型或小型模型进行微调。 * 您可以在 JieKou AI 模型库中探索所有模型
使用场景 推荐模型
代码生成与推理 claude 系列 (大型/中型/小型)
Deepseek-r1-0528 (大型)
Deepseek-v3-0324 (大型)
Qwen3-Coder-480B-A35B-Instruct (大型)
Qwen3-235B-A22B-Instruct-2507 (大型)
Kimi-K2-Instruct (中型)
GLM-4.5 (中型)
通用推理与规划 Deepseek-r1-0528 (大型)
Deepseek-v3-0324 (大型)
Qwen-2.5-72b-instruct (中型)
Llama-3.3-70b-instruct (中型)
函数调用与工具使用 Qwen3-235b-a22b-fp8 (大型)
Qwen 3 系列 (大型/中型/小型)
长上下文与摘要 Llama-4-maverick-17b-128e-instruct-fp8 (大型)
Llama-4-scout-17b-16e-instruct (中型)
视觉与文档理解 Llama-4-maverick-17b-128e-instruct-fp8 (大型)
Qwen2.5-vl-72b-instruct (中型)
Llama-4-scout-17b-16e-instruct (中型)
低延迟自然语言理解与提取 Llama-3.1-8b-instruct (小型)
# 结构化输出（Structured Outputs） Source: https://docs.jiekou.ai/docs/model/llm-structured-outputs ## 使用场景 Structured Outputs 功能使得模型能够生成符合您提供的 [JSON Schema](https://json-schema.org/specification) 的响应，让生成结果更加可控，易于解析。这一功能既可以方便后续逻辑的解析和处理，也有利于将结果集成到业务系统中，适用于各种自动化和数据处理场景。 ## 支持的模型 以下模型支持结构化输出： ## 使用方法 在请求中添加以下信息： * **设置参数**：通过`response_format`参数指定您定义的 JSON Schema。 * **提示词指引**：在提示词中指引模型进行结构化输出。 ## 使用示例 下文提供了完整的 Python 代码示例，演示如何使用 Structured Outputs 功能生成符合您提供的 JSON Schema 的 JSON 响应。 ### 1. 初始化客户端 您需要使用您的 JieKou AI API 密钥初始化客户端。 ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.highwayapi.ai/openai", api_key="", ) model = "qwen/qwen-2.5-72b-instruct" ``` ### 2. 定义 JSON Schema 您需要定义 JSON Schema。以下示例创建了一个从用户输入中提取费用信息的 JSON Schema。 ```python theme={null} # 定义用于费用跟踪的系统提示。 system_prompt = """You are an expense tracking assistant. Extract expense information from the user's input and format it according to the provided schema.""" # 定义用于结构化响应的 JSON Schema。 response_format = { "type": "json_schema", "json_schema": { "name": "expense_tracking_schema", "schema": { "type": "object", "properties": { "expenses": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the expense" }, "amount": { "type": "number", "description": "Amount spent in dollars" }, "date": { "type": "string", "description": "When the expense occurred" }, "category": { "type": "string", "description": "Category of expense (e.g., food, office, travel)" } }, "required": [ "description", "amount" ] } }, "total": { "type": "number", "description": "Total amount of all expenses" } }, "required": [ "expenses", "total" ], }, }, } ``` ### 3. 发起 API 请求 创建 API 请求。此请求包括 `response_format` 参数，指定了上一步中定义的 JSON schema。 ```python theme={null} chat_completion = client.chat.completions.create( model=model, messages=[ { "role": "system", "content": system_prompt, }, { "role": "user", "content": """I spent $120 on dinner at an Italian restaurant last Friday with my colleagues. Also bought office supplies for $45 on Monday.""", }, ], max_tokens=1024, temperature=0.8, stream=False, response_format=response_format, ) response_content = chat_completion.choices[0].message.content # 解析并美化 JSON try: json_response = json.loads(response_content) prettified_json = json.dumps(json_response, indent=2) print(prettified_json) except json.JSONDecodeError: print("Could not parse response as JSON. Raw response:") print(response_content) ``` **输出**： ```json theme={null} { "expenses": [ { "date": "2023-03-17", "description": "Dinner at Italian restaurant", "amount": 120, "category": "Food & Dining" }, { "date": "2023-03-13", "description": "Office supplies", "amount": 45, "category": "Office Supplies" } ], "total": 165 } ``` ## 完整代码 ```python theme={null} from openai import OpenAI import json client = OpenAI( base_url="https://api.highwayapi.ai/openai", api_key="", ) model = "qwen/qwen-2.5-72b-instruct" # 使用 JSON Schema 进行结构化输出的示例 # 此示例创建了一个用于提取费用信息的 schema # 定义用于费用跟踪的系统提示 system_prompt = """You are an expense tracking assistant. Extract expense information from the user's input and format it according to the provided schema.""" # 定义用于结构化响应的 JSON schema response_format = { "type": "json_schema", "json_schema": { "name": "expense_tracking_schema", "schema": { "type": "object", "properties": { "expenses": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the expense" }, "amount": { "type": "number", "description": "Amount spent in dollars" }, "date": { "type": "string", "description": "When the expense occurred" }, "category": { "type": "string", "description": "Category of expense (e.g., food, office, travel)" } }, "required": [ "description", "amount" ] } }, "total": { "type": "number", "description": "Total amount of all expenses" } }, "required": [ "expenses", "total" ], }, }, } chat_completion = client.chat.completions.create( model=model, messages=[ { "role": "system", "content": system_prompt, }, { "role": "user", "content": """I spent $120 on dinner at an Italian restaurant last Friday with my colleagues. Also bought office supplies for $45 on Monday.""", }, ], max_tokens=1024, temperature=0.8, stream=False, response_format=response_format, ) response_content = chat_completion.choices[0].message.content # 解析并美化 JSON try: json_response = json.loads(response_content) prettified_json = json.dumps(json_response, indent=2) print(prettified_json) except json.JSONDecodeError: print("Could not parse response as JSON. Raw response:") print(response_content) ``` # 介绍 Source: https://docs.jiekou.ai/docs/model/overview 如何开始使用 JieKou.AI 模型服务 ## 查看模型列表 您可以在 [接口AI](https://jiekou.vip/#model-library) 查看平台支持的大语言模型列表。 ## 在线体验模型 1. 访问 [接口AI](https://jiekou.vip/#model-library)。 2. 找到并单击要使用的模型卡片。 3. 进入模型详情，单击「试用模型」，进入 Playground。 4. 在右侧的「模型配置」区域设置参数，然后输入信息，即可体验模型能力。 ## 调用模型 API ### 在线调用 您可以通过 [模型服务 API 手册](/docs/models/reference-authentication) 中的 API 接口文档查看代码示例，单击「试用模型」可以进行在线调用。 ### 本地调用 选择您熟悉的语言或工具，配置好本地环境后，编写代码调用 API。 建议把 API Key 配置到环境变量，避免在代码里显式使用 API Key，降低泄漏风险。 # 视觉语言模型 Source: https://docs.jiekou.ai/docs/model/visual ## 功能介绍 视觉语言模型（Vision-Language Model, VLM）是一类同时支持图像与文本输入的多模态大模型，具备对图像内容的理解与跨模态信息处理能力。模型能够基于图片与文本的组合信息，输出高质量的响应内容，广泛应用于图像识别、内容理解、智能问答等场景。 ### 典型应用场景 * **图像内容识别与描述**：自动识别图片中的物体、颜色、场景与空间关系，生成自然语言描述。 * **图文综合理解**：结合图像与文本输入，实现上下文相关的多轮对话与复杂任务响应。 * **视觉辅助问答**：可作为 OCR 工具补充，识别图像中嵌入的文本信息并完成问答。 * **未来拓展应用**：适用于智能视觉助手、机器人感知、增强现实等交互场景。 ## API 调用说明 调用视觉语言模型需通过 `/chat/completions` 接口，支持图文混合输入。 ### 图片处理参数 通过 `detail` 字段设置图像处理精度，支持以下选项： * `high`：高分辨率，保留更多细节，适合精细化任务。 * `low`：低分辨率，处理速度快，适合实时响应。 * `auto`：系统自动选择合适模式。 ### 消息格式示例 #### URL 图片形式 ```json theme={null} { "role": "user", "content": [ { "type": "image_url", "image_url": { "url": "https://example.com/image.png", "detail": "high" } }, { "type": "text", "text": "请描述图片中的场景。" } ] } ``` #### Base64 图片形式 ```json theme={null} { "role": "user", "content": [ { "type": "image_url", "image_url": { "url": "data:image/jpeg;base64,{base64_image}", "detail": "low" } }, { "type": "text", "text": "图片中有哪些文字内容？" } ] } ``` ### Base64 图像编码示例代码（Python） ```python theme={null} import base64 from PIL import Image import io def image_to_base64(image_path): with Image.open(image_path) as img: buffered = io.BytesIO() img.save(buffered, format="JPEG") return base64.b64encode(buffered.getvalue()).decode('utf-8') base64_image = image_to_base64("path/to/your/image.jpg") ``` ## 多图模式 支持发送多张图片与文本共同作为输入，建议最多两张以获得更佳性能与理解效果。 ```json theme={null} { "role": "user", "content": [ { "type": "image_url", "image_url": { "url": "https://example.com/image1.png" } }, { "type": "image_url", "image_url": { "url": "data:image/jpeg;base64,{base64_image}" } }, { "type": "text", "text": "比较这两张图片的共同特征。" } ] } ``` ## 支持模型 以下为当前平台支持的视觉语言模型（VLM）： ## 计费方式 视觉语言模型的图像输入将转换为 Tokens 与文本共同计算调用费用： * 每个模型的图像 Token 估算规则略有不同； * 详细的计费标准可在对应模型介绍页中查看。 ## API 调用示例代码 ### 单图像描述 ```python theme={null} from openai import OpenAI client = OpenAI(api_key="YOUR_KEY", base_url="https://api.highwayapi.ai/openai") response = client.chat.completions.create( model="qwen/qwen2.5-vl-72b-instruct", messages=[ { "role": "user", "content": [ {"type": "image_url", "image_url": {"url": "https://example.com/cityscape.jpg"}}, {"type": "text", "text": "描述图片中的主要建筑物。"} ] } ], stream=True ) for chunk in response: print(chunk.choices[0].delta.content or "", end="", flush=True) ``` ### 多图像对比分析 ```python theme={null} response = client.chat.completions.create( model="qwen/qwen2.5-vl-72b-instruct", messages=[ { "role": "user", "content": [ {"type": "image_url", "image_url": {"url": "https://example.com/product1.jpg"}}, {"type": "image_url", "image_url": {"url": "https://example.com/product2.jpg"}}, {"type": "text", "text": "请对比一下这两个产品的主要区别。"} ] } ], stream=True ) for chunk in response: print(chunk.choices[0].delta.content or "", end="", flush=True) ``` ## 常见问题与说明 * 图像分辨率与清晰度会影响模型识别准确率，推荐使用清晰图源。 * Base64 编码体积较大，建议图片不超过 1MB。 * 如遇问题请参考平台开发者文档或提交工单获取支持。 # API 鉴权方式 Source: https://docs.jiekou.ai/docs/models/reference-authentication JieKou AI API 使用 `请求头` 中的 Authorization 字段携带 API 密钥进行身份认证。您可以在 [设置页面](https://jiekou.vip/settings/key-management) 查看和管理您的 API 密钥。 ```js theme={null} { "Authorization": "Bearer {{API Key}}" } ``` # API 错误码说明 Source: https://docs.jiekou.ai/docs/models/reference-error-code
错误名称 状态码 说明
INVALID\_API\_KEY 403 未提供 API Key
MODEL\_NOT\_FOUND 404 模型不存在
FAILED\_TO\_AUTH 401 认证失败
NOT\_ENOUGH\_BALANCE 403 余额不足
INVALID\_REQUEST\_BODY 400 请求体格式错误，详见 message
RATE\_LIMIT\_EXCEEDED 429 请求过快，请稍后重试
TOKEN\_LIMIT\_EXCEEDED 429 Token 数超限，请稍后重试
SERVICE\_NOT\_AVAILABLE 503 服务不可用
ACCESS\_DENY 403 无权限访问
# Gemini 2.5 Flash Image 图片编辑 Source: https://docs.jiekou.ai/docs/models/reference-gemini-2.5-flash-image-edit POST https://api.highwayapi.ai/v3/gemini-2.5-flash-image-edit 使用 Gemini 2.5 Flash 模型通过文本提示词编辑图像。您可以通过 URL 或 base64 编码字符串提供图像。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 描述图像预期编辑效果的文本提示词 用于编辑的输入图像 URL 列表 生成图像的宽高比。可用值：1:1、3:2、2:3、3:4、4:3、4:5、5:4、9:16、16:9、21:9 可选值：`1:1`, `3:2`, `2:3`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9` 用于编辑的 base64 编码图像列表 ## 响应信息 编辑后输出图像的 URL 列表 # Gemini 2.5 Flash Image 文生图 Source: https://docs.jiekou.ai/docs/models/reference-gemini-2.5-flash-image-text-to-image POST https://api.highwayapi.ai/v3/gemini-2.5-flash-image-text-to-image 使用 Gemini 2.5 Flash 模型根据文字提示生成图像。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 描述要生成图像的文字提示 生成图像的宽高比。可用值：1:1、3:2、2:3、3:4、4:3、4:5、5:4、9:16、16:9、21:9 可选值：`1:1`, `3:2`, `2:3`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9` ## 响应信息 生成图像的 URL 列表 # Gemini 3 Pro 图片编辑 Source: https://docs.jiekou.ai/docs/models/reference-gemini-3-pro-image-edit POST https://api.highwayapi.ai/v3/gemini-3-pro-image-edit Gemini 3 Pro Image (Nano Banana Pro) 旨在通过集成最先进的推理能力，解决最具挑战性的图像生成任务。它是处理复杂和多轮图像生成与编辑的最佳模型，具备更高的准确性和更优的图像质量。支持 URL 和 Base64 编码的图片作为输入。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 输出图片的像素尺寸。1K（1024px）、2K（2048px）、4K（4096px）。默认为 1K 可选值：`1K`, `2K`, `4K` Google 搜索选项 启用 Google 网页搜索，基于真实世界信息生成更准确的图片。 描述期望图片编辑效果的文本提示词 用于编辑的输入图片 URL 列表 输出图片的宽高比 可选值：`1:1`, `3:2`, `2:3`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9` 用于编辑的 Base64 编码图片列表 ## 响应信息 编辑后的图片 URL 列表 模型 grounding 元数据。Google 服务端工具（例如搜索）被调用时返回。注意：工具调用取决于 Google。参数启用工具，不一定 100% 触发工具调用。 # Gemini 3 Pro 图片生成 Source: https://docs.jiekou.ai/docs/models/reference-gemini-3-pro-image-text-to-image POST https://api.highwayapi.ai/v3/gemini-3-pro-image-text-to-image Gemini 3 Pro Image (Nano Banana Pro) 旨在通过集成最先进的推理能力，解决最具挑战性的图像生成任务。它是处理复杂和多轮图像生成与编辑的最佳模型，具备更高的准确性和更优的图像质量。支持可配置的图片尺寸、宽高比和输出格式。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 输出图片的像素尺寸（宽\*高）。1K（1024px）、2K（2048px）、4K（4096px）。默认为 1K 可选值：`1K`, `2K`, `4K` Google 搜索选项 启用 Google 网页搜索，基于真实世界信息生成更准确的图片。 描述要生成图片的文本提示词 生成图片的宽高比 可选值：`1:1`, `3:2`, `2:3`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9` 输出图片的 MIME 类型，支持 PNG、JPEG 和 WebP 格式 可选值：`image/png`, `image/jpeg` ## 响应信息 生成的图片 URL 列表 模型 grounding 元数据。Google 服务端工具（例如搜索）被调用时返回。注意：工具调用取决于 Google。参数启用工具，不一定 100% 触发工具调用。 # Gemini 3.1 Flash 图片编辑 Source: https://docs.jiekou.ai/docs/models/reference-gemini-3.1-flash-image-edit POST https://api.highwayapi.ai/v3/gemini-3.1-flash-image-edit 使用 Gemini 3.1 Flash 模型通过自然语言提示词编辑图片。支持 URL 和 Base64 编码的图片作为输入，最多可传入 14 张参考图。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 输出图片的像素尺寸。0.5K（约512px）、1K（约1024px）、2K（约2048px）、4K（约4096px）。默认为 1K 可选值：`0.5K`, `1K`, `2K`, `4K` Google 搜索选项 启用 Google 网页搜索，基于真实世界信息生成更准确的图片。 启用 Google 图片搜索，使用真实图片作为生成的视觉参考。 描述期望图片编辑效果的文本提示词 用于编辑的输入图片 URL 列表，最多支持 14 张参考图 数组长度：0 - 14 输出图片的宽高比。支持标准比例和新增的超宽/超长比例（1:4、4:1、1:8、8:1） 可选值：`1:1`, `1:4`, `1:8`, `2:3`, `3:2`, `3:4`, `4:1`, `4:3`, `4:5`, `5:4`, `8:1`, `9:16`, `16:9`, `21:9` 用于编辑的 Base64 编码图片列表。image\_urls 和 image\_base64s 的总数不超过 14 张 数组长度：0 - 14 输出图片的 MIME 类型。支持格式：image/png、image/jpeg。默认为 image/png 可选值：`image/png`, `image/jpeg` ## 响应信息 编辑后的图片 URL 列表 模型 grounding 元数据。Google 服务端工具（例如搜索）被调用时返回。注意：工具调用取决于 Google。参数启用工具，不一定 100% 触发工具调用。 # Gemini 3.1 Flash 图片生成 Source: https://docs.jiekou.ai/docs/models/reference-gemini-3.1-flash-image-text-to-image POST https://api.highwayapi.ai/v3/gemini-3.1-flash-image-text-to-image 使用 Gemini 3.1 Flash Image Preview 模型，通过文本提示词生成图片。支持可配置的图片尺寸、宽高比和思考深度以获取更高质量的生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 输出图片的像素尺寸（宽\*高）。0.5K（512px）仅适用于 Gemini 3.1 Flash。 可选值：`0.5K`, `1K`, `2K`, `4K` Google 搜索选项 启用 Google 网页搜索，基于真实世界信息生成更准确的图片。 启用 Google 图片搜索，使用真实图片作为生成的视觉参考。 描述要生成图片的文本提示词 生成图片的宽高比。 可选值：`1:1`, `1:4`, `1:8`, `2:3`, `3:2`, `3:4`, `4:1`, `4:3`, `4:5`, `5:4`, `8:1`, `9:16`, `16:9`, `21:9` 输出图片的 MIME 类型，支持 PNG 和 JPEG 格式。 可选值：`image/png`, `image/jpeg` ## 响应信息 生成的图片 URL 列表 模型 grounding 元数据。Google 服务端工具（例如搜索）被调用时返回。注意：工具调用取决于 Google。参数启用工具，不一定 100% 触发工具调用。 # 查询任务结果 Source: https://docs.jiekou.ai/docs/models/reference-get-async-task-result GET https://api.highwayapi.ai/v3/async/task-result 「查询任务结果 API」用来获取异步任务返回的图像、音频或视频结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 查询参数 在异步 API 的 200 响应中返回的 task\_id 值。 ## 响应信息参数 调试信息 记录请求参数以用于调试。 任务提交时的时间戳（以毫秒为单位）。 任务开始执行时的时间戳（以毫秒为单位）。 任务完成时的时间戳（以毫秒为单位）。 任务详细信息。 任务 ID。 任务当前状态。枚举值: * `TASK_STATUS_QUEUED`：任务排队中，等待处理； * `TASK_STATUS_SUCCEED`：任务已成功； * `TASK_STATUS_FAILED`：任务失败； * `TASK_STATUS_PROCESSING`：任务正在处理中； 任务失败原因，当任务失败时，该字段有效。 任务的类型。 任务预计完成时间，以秒为单位。只有部分 API 该字段有效。 任务完成的进度百分比。此功能目前仅适用于：
1. 视频生成 API;
2. 文本到图像 API 和 图像到图像 API。 返回与图像类任务的输出图片结果。 图像 URL。 图像 URL 过期时间（以秒为单位）。默认值为 3600 秒。 图像类型。枚举值: `jpeg, png, webp` 返回与视频类任务的输出视频结果。 视频 URL。 视频 URL 过期时间（以秒为单位）。默认值为 3600 秒。 视频类型。枚举值: `mp4, gif` 返回与音频类任务的输出音频结果。 音频 URL。 音频 URL 过期时间（以秒为单位）。默认值为 3600 秒。 音频类型。枚举值: `wav` 生成的音频文件的详细元数据信息。 音频包含的文本信息。 文本的开始时间（以秒为单位）。 文本的结束时间（以秒为单位）。 # 查询账单 Source: https://docs.jiekou.ai/docs/models/reference-get-bill-pay-as-you-model GET https://api.highwayapi.ai/openapi/v1/billing/bill/list ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 响应信息 计费周期粒度。选项： * `Hour`：按小时 * `Day`: 按天 * `Week`：按周 * `Month`：按月 产品类型。选项： * `summary`：汇总账单 * `llm`： 大语言模型 产品名称。支持模糊匹配。 查询账单周期的开始时间，时间戳（秒），默认值：0。 查询账单周期的结束时间，时间戳（秒），默认值：0。 指定要查询的实例 ID。 ## 响应信息参数 按需实例计费信息。 实例所属的用户 ID。 账单的开始时间。格式为 Unix 时间戳。 账单的结束时间。格式为 Unix 时间戳。 实例的计费方式。值为 1 表示按需计费。 产品名称。 产品类别。 实例 ID。 * llm：输入 tokens * llm：输出 tokens 原价 无意义 * llm：输入 tokens 单价 * 其他：单价 * llm：输出 tokens 单价 总价。 代金券扣除金额。 现金支付金额。 价格精度。 产品 ID。 # GPT Image 2 Image Edit Source: https://docs.jiekou.ai/docs/models/reference-gpt-image-2-edit POST https://api.highwayapi.ai/v3/gpt-image-2-edit OpenAI GPT Image 2 图片编辑 API。根据文本提示词编辑图片，支持遮罩修复、透明背景，以及多种质量/尺寸选项。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 生成的图片数量。实际返回数量可能少于请求数量。 取值范围：\[1, 10] 附加图片，其完全透明区域表示需要编辑的位置。必须是带有 alpha 通道的 PNG 格式。 生成图片的尺寸。 可选值：`auto`, `688x2048`, `880x2048`, `1024x1024`, `1024x1536`, `1024x2048`, `1152x2048`, `1360x2048`, `1536x1024`, `1536x2048`, `2048x688`, `2048x880`, `2048x1024`, `2048x1152`, `2048x1360`, `2048x1536`, `2048x2048`, `2160x3840`, `3840x2160` 要编辑的图片，可以是单张图片 URL/base64 或图片数组。支持格式：PNG、JPEG、GIF、WebP。 描述所需编辑效果的文本提示词，最大长度为 32000 个字符。 长度限制：0 - 32000 生成图片的质量。质量越高耗时越长，费用越高。 可选值：`low`, `medium`, `high` 背景是否为不透明或自动检测。 可选值：`opaque`, `auto` 输出图片格式。 可选值：`png`, `jpeg` ## 响应信息 生成的图片 URL 数组。 # GPT Image 2 Light 编辑 Source: https://docs.jiekou.ai/docs/models/reference-gpt-image-2-light-edit POST https://api.highwayapi.ai/v3/gpt-image-2-light-edit GPT Image 2 Light 图片编辑 API。通过 images 数组接收图片 URL，根据提示词编辑输入图片，并返回编辑后的图片 URL。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 蒙版图片 URL 或 data URL。蒙版图必须是 PNG，且必须带 alpha channel，例如 RGBA 或 LA。透明区域表示需要被编辑或重绘的区域，不透明区域表示尽量保持不变的区域。蒙版尺寸通常需要和输入 image 一致。不支持 file\_id。 输出尺寸，默认 auto，不支持其他尺寸，auto 由模型提示词判定。 可选值：`auto` JSON URL 模式下的待编辑原图列表。至少需要一个 image\_url，支持 URL 或 data URL。 数组长度：1 - 16 输入图片 URL 或 data URL。不支持 file\_id。 描述希望如何修改输入图片的编辑指令。为空会返回 prompt is required。 长度限制：0 - 32000 输出图片背景处理方式。 可选值：`auto`, `opaque` 内容审核严格程度。 可选值：`auto`, `low` ## 响应信息 平台存储转换后的编辑结果图片 URL 数组。 # GPT Image 2 Light 文生图 Source: https://docs.jiekou.ai/docs/models/reference-gpt-image-2-light-text-to-image POST https://api.highwayapi.ai/v3/gpt-image-2-light-text-to-image GPT Image 2 Light 文生图 API，单一 SKU 计费。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 输出尺寸，默认 auto，不支持其他尺寸，auto 由模型提示词判定 可选值：`auto` 描述要创建的图片内容。 输出图片背景模式。 可选值：`opaque`, `auto` 生成模式下的内容审核强度。 可选值：`auto`, `low` ## 响应信息 生成后的图片 URL 列表。 # GPT Image 2 Text to Image Source: https://docs.jiekou.ai/docs/models/reference-gpt-image-2-text-to-image POST https://api.highwayapi.ai/v3/gpt-image-2-text-to-image GPT Image 2 文生图生成模型的调用 API，支持多种质量等级（low/medium/high）和尺寸。根据文本提示词生成图像，可配置输出格式、压缩率和背景设置。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 生成图片的数量，默认为 1。实际返回数量可能少于请求数量。 取值范围：\[1, 10] 生成图片的尺寸。1024x1024 为正方形，1024x1536 为竖版，1536x1024 为横版，2048x2048 为2K正方形，2048x1152 为2K横版，3840x2160 为4K横版，2160x3840 为4K竖版，2048x1360 为3:2横版，1360x2048 为2:3竖版，1152x2048 为9:16竖版，2048x1536 为4:3横版，1536x2048 为3:4竖版，2048x880 为21:9超宽屏，880x2048 为9:21超竖屏，688x2048 为1:3竖版，2048x688 为3:1横版，2048x1024 为2:1横版，1024x2048 为1:2竖版。 可选值：`1024x1024`, `1024x1536`, `1536x1024`, `2048x2048`, `2048x1152`, `3840x2160`, `2160x3840`, `2048x1360`, `1360x2048`, `1152x2048`, `2048x1536`, `1536x2048`, `2048x880`, `880x2048`, `688x2048`, `2048x688`, `2048x1024`, `1024x2048`, `auto` 用于生成图像的文本提示词，支持中英文。最大长度 32000 个字符。 长度限制：0 - 32000 生成图片的质量等级。low 速度最快、成本最低；medium 平衡质量与速度；high 质量最佳但速度最慢、成本最高。 可选值：`low`, `medium`, `high` 背景设置。 可选值：`opaque`, `auto` 内容审核等级。 可选值：`low`, `auto` 输出图片的文件格式。 可选值：`png`, `jpeg` 输出图片的压缩等级（0-100）。仅对 jpeg 格式有效，png 格式不支持（必须为 100 或不传）。 取值范围：\[0, 100] ## 响应信息 生成的图片 URL 数组。 # Heygen Video-translate Source: https://docs.jiekou.ai/docs/models/reference-heygen-video-translate POST https://api.highwayapi.ai/v3/async/heygen-video-translate 使用自然语音克隆和精准唇形同步将视频翻译成 175+ 种语言 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 要翻译的视频 URL。必须可公开访问。支持直接 URL、Google Drive 和 YouTube 链接。 翻译目标语言。支持 70+ 种语言和 175+ 种方言,提供自然语音克隆和唇形同步调整。 可选值：`English`, `English (Australia)`, `English (India)`, `English (UK)`, `English (US)`, `Spanish`, `Spanish (Mexico)`, `Spanish (Spain)`, `French`, `French (Canada)`, `French (France)`, `Hindi`, `Italian`, `German`, `Polish`, `Portuguese`, `Portuguese (Brazil)`, `Portuguese (Portugal)`, `Chinese`, `Chinese (Cantonese, Traditional)`, `Chinese (Mandarin, Simplified)`, `Chinese (Mandarin, Traditional)`, `Japanese`, `Dutch`, `Turkish`, `Korean`, `Danish`, `Arabic`, `Romanian`, `Mandarin`, `Filipino`, `Swedish`, `Indonesian`, `Ukrainian`, `Greek`, `Czech`, `Bulgarian`, `Malay`, `Slovak`, `Croatian`, `Tamil`, `Finnish`, `Russian` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Kling v3.0 4K 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-kling-v3.0-4k-i2v POST https://api.highwayapi.ai/v3/async/kling-v3.0-4k-i2v Kling v3.0 4K 图像转视频工具可将静态图像转换为 4K 超高清动态视频，在保持主体一致性的同时，呈现更丰富的画面细节、自然运动与流畅的场景动态效果。支持 3 至 15 秒灵活时长、音视频同步生成、尾帧控制及多镜头视频生成。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 视频首帧图片；支持 `.jpg`、`.jpeg`、`.png`。图片文件大小不得超过 10MB；宽高均需 >= 300px；宽高比需在 1:2.5 与 2.5:1 之间。 是否在生成视频时同时生成音频。 生成视频的正向提示词文本，可描述场景运动、镜头移动、动作、语音风格、氛围及音效；不可超过 2500 个字符。 生成视频的持续时间（秒）。支持 3 至 15 秒灵活时长。 取值范围：\[3, 15] 控制视频生成的灵活性。数值越高，模型生成内容对提示词的贴合度越高；数值越低，运动效果越自然。 取值范围：\[0, 1] 尾帧图片 URL，用于引导过渡效果。与 multi\_prompt 不兼容。支持 `.jpg`、`.jpeg`、`.png`。 多镜头视频生成的提示词列表。将视频分为多个镜头。与 prompt 互斥。 反向提示词，指定在画面和音频中需要避免的元素；长度不超过 2500 字符。 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Kling v3.0 4K 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-kling-v3.0-4k-t2v POST https://api.highwayapi.ai/v3/async/kling-v3.0-4k-t2v Kling v3.0 4K 文本转视频可根据文字提示生成 4K 超高清视频，画面细节更丰富，具备自然运动与流畅的场景动态效果。支持 3 至 15 秒灵活时长、音视频同步生成及多镜头视频生成。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 是否在生成视频时同时生成音频。 生成视频的正向提示词文本，可描述场景运动、镜头移动、动作、语音风格、氛围及音效；不可超过 2500 个字符。与 multi\_prompt 互斥。 长度限制：0 - 2500 生成视频的持续时间（秒）。支持 3 至 15 秒灵活时长。 取值范围：\[3, 15] 控制视频生成的灵活性。数值越高，模型生成内容对提示词的贴合度越高；数值越低，运动效果越自然。 取值范围：\[0, 1] 生成视频的宽高比。 可选值：`16:9`, `9:16`, `1:1` 多镜头视频生成的提示词列表。将视频分为多个镜头。与 prompt 互斥。 反向提示词，指定在画面和音频中需要避免的元素；长度不超过 2500 字符。 长度限制：0 - 2500 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Kling V3.0 动作控制 Source: https://docs.jiekou.ai/docs/models/reference-kling-v3.0-motion-control POST https://api.highwayapi.ai/v3/async/kling-v3.0-motion-control Kling V3.0 动作控制工具可从参考视频提取运动轨迹，并将其应用到参考图像生成视频，同时保持主体一致性。支持标准与专业模式，按秒计费。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 参考图像 URL 或 base64 编码图像；支持 .jpg、.jpeg、.png。 图片文件大小不得超过 10MB；宽高均需 >= 300px；宽高比需在 1:2.5 与 2.5:1 之间。 参考运动视频 URL；支持 .mp4、.mov。 视频文件大小不得超过 10MB；宽高均需 >= 300px；时长 3-30 秒。 场景描述、风格、光线等正向提示词；长度不超过 2500 字符。 长度限制：0 - 2500 模型名称。kling-v3-0-std：标准模式，性价比高；kling-v3-0-pro：专业模式，视频质量更佳。 可选值：`kling-v3-0-std`, `kling-v3-0-pro` 反向提示词，描述需要在生成视频中避免的元素；长度不超过 2500 字符。 长度限制：0 - 2500 是否保留参考视频的原始音频。 输出帧模式： * image：以参考图像的人物姿态和构图为主，将动作迁移到图像人物上（输出 5 秒） * video：以参考视频的人物姿态和构图为主，将视频中的动作应用到图像人物上（输出时长与参考视频一致，最长 30 秒） 可选值：`image`, `video` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Kling v3.0 Pro 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-kling-v3.0-pro-i2v POST https://api.highwayapi.ai/v3/async/kling-v3.0-pro-i2v Kling v3.0 Pro 图像转视频工具可将静态图像转换为动态视频，在保持主体一致性的同时，生成自然运动与更流畅的场景动态效果。支持 3 至 15 秒灵活时长、音视频同步生成、尾帧控制及多镜头视频生成。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 视频首帧图片；支持 `.jpg`、`.jpeg`、`.png`。图片文件大小不得超过 10MB；宽高均需 >= 300px；宽高比需在 1:2.5 与 2.5:1 之间。 是否在生成视频时同时生成音频。 生成视频的正向提示词文本，可描述场景运动、镜头移动、动作、语音风格、氛围及音效；不可超过 2500 个字符。 生成视频的持续时间（秒）。支持 3 至 15 秒灵活时长。 取值范围：\[3, 15] 控制视频生成的灵活性。数值越高，模型生成内容对提示词的贴合度越高；数值越低，运动效果越自然。 取值范围：\[0, 1] 尾帧图片 URL，用于引导过渡效果。与 multi\_prompt 不兼容。支持 `.jpg`、`.jpeg`、`.png`。 多镜头视频生成的提示词列表。将视频分为多个镜头。与 prompt 互斥。 反向提示词，指定在画面和音频中需要避免的元素；长度不超过 2500 字符。 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Kling v3.0 Pro 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-kling-v3.0-pro-t2v POST https://api.highwayapi.ai/v3/async/kling-v3.0-pro-t2v Kling v3.0 Pro 文本转视频可根据文字提示生成高质量视频，具有自然运动与流畅的场景动态效果。支持 3 至 15 秒灵活时长、音视频同步生成及多镜头视频生成。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 是否在生成视频时同时生成音频。 生成视频的正向提示词文本，可描述场景运动、镜头移动、动作、语音风格、氛围及音效；不可超过 2500 个字符。与 multi\_prompt 互斥。 长度限制：0 - 2500 生成视频的持续时间（秒）。支持 3 至 15 秒灵活时长。 取值范围：\[3, 15] 控制视频生成的灵活性。数值越高，模型生成内容对提示词的贴合度越高；数值越低，运动效果越自然。 取值范围：\[0, 1] 生成视频的宽高比。 可选值：`16:9`, `9:16`, `1:1` 多镜头视频生成的提示词列表。将视频分为多个镜头。与 prompt 互斥。 反向提示词，指定在画面和音频中需要避免的元素；长度不超过 2500 字符。 长度限制：0 - 2500 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Kling v3.0 Standard 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-kling-v3.0-std-i2v POST https://api.highwayapi.ai/v3/async/kling-v3.0-std-i2v Kling v3.0 Standard 图像转视频工具可将静态图像转换为动态视频，在保持主体一致性的同时，生成自然运动与流畅的场景动态效果，支持音频同步生成和多段提示词组合。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 视频首帧图片；支持 `.jpg`、`.jpeg`、`.png`。 图片文件大小不得超过 10MB；宽高均需 >= 300px；宽高比需在 1:2.5 与 2.5:1 之间。 是否在生成视频时同时生成音频。 生成视频的正向提示词文本，描述场景运动、镜头移动、动作、声音风格、氛围和音效；不可超过 2500 个字符。 生成视频的持续时间（秒），范围 3-15。 可选值：`3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15` 控制视频生成的灵活性。数值越低运动越自然；数值越高，生成内容对提示词的贴合度越高。 取值范围：\[0, 1] 尾帧图片 URL，用于引导起始帧与结束帧之间的过渡。格式约束与 image 相同。不可与 multi\_prompt 同时使用。 多段提示词数组，用于多镜头视频组合。每项包含一个提示词和该段的时长。不可与 end\_image 同时使用。 该视频段落的运动描述。 该段落的持续时间（秒），范围 3-15。 取值范围：\[3, 15] 反向提示词，指定要在画面和音频中避免的元素；长度不超过 2500 字符。 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Kling v3.0 Standard 文字生成视频 Source: https://docs.jiekou.ai/docs/models/reference-kling-v3.0-std-t2v POST https://api.highwayapi.ai/v3/async/kling-v3.0-std-t2v Kling v3.0 Standard 文字生成视频可根据文本提示生成高质量视频，具备流畅的运动效果、电影级画面、精准的提示词遵循能力，并支持可选的原生音频共同生成。支持 3-15 秒时长和多种画面比例。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 是否在生成视频时同时生成音频。支持中文和英文语音输出。 生成视频的正向提示词文本；不可超过 2500 个字符。 长度限制：0 - 2500 生成视频的持续时间（秒）。 可选值：`3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15` 控制视频生成的灵活性。设为 0 可获得最大创意自由，0.5（默认）为平衡效果，设为 1 则严格遵循提示词。 取值范围：\[0, 1] 生成视频的宽高比。 可选值：`16:9`, `9:16`, `1:1` 反向提示词，描述需要在生成视频中避免的元素；长度不超过 2500 字符。 长度限制：0 - 2500 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # 创建聊天对话请求 Source: https://docs.jiekou.ai/docs/models/reference-llm-create-chat-completion POST https://api.highwayapi.ai/openai/v1/chat/completions 根据指定的聊天对话生成模型回复 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 要使用的模型名称。 组成当前对话的消息列表。 消息的内容。所有消息都需要 content，对于包含函数调用的 assistant 消息，content 可以为 null。 您可以根据不同的模态使用以下参数。

选项 1：

您可以使用字符串类型来表示消息的文本内容。


选项 2：

使用内容部分的数组，object\[]。详细字段如下：

内容部分的类型，在此情况下为 `text`。 文本内容。

仅可使用视觉语言模型。

内容部分的数组，object\[]。详细字段如下：

内容部分的类型，在此情况下为 `image_url`。 图像的 URL 或 base64 编码的图像数据（claude 系列模型仅支持 base64 编码的图像数据）。

仅可使用支持视频的模型。

内容部分的数组，object\[]。详细字段如下：

内容部分的类型，在此情况下为 `video_url`。 视频的 URL。
消息作者的角色。可以是 system、user 或 assistant。 枚举值: `system`, `user`, `assistant` 此消息作者的名称。可以包含 a-z、A-Z、0-9 和下划线，最大长度为 64 个字符。 在完成中生成的最大 tokens 数量。 如果您的提示（先前的消息）加上 max\_tokens 的 tokens 数超过模型的上下文长度，则行为取决于 context\_length\_exceeded\_behavior。默认情况下，max\_tokens 将被降低以适应上下文窗口，而不是返回错误。 是否流式返回部分进度。如果设置，tokens 将作为数据专用的服务器发送事件 (SSE) 发送，当它们可用时，流将以 `data: [DONE]` 消息终止。 流响应的选项。仅在设置 stream 为 true 时设置此项。 如果设置，将在数据: \[DONE] 消息之前流式传输一个额外的 chunk。此 chunk 中的 usage 字段显示整个请求的 tokens 使用统计信息，而 choices 字段始终为空数组。所有其他 chunk 也将包含一个 usage 字段，但值为 null。 为每个提示生成的完成数量。 注意：由于此参数会生成许多完成，因此可能会快速消耗您的 tokens 配额。请谨慎使用，并确保您对 max\_tokens 和 stop 有合理的设置。 必需范围：`1 < x < 128` 如果指定，我们的系统将尽力以确定性的方式进行采样，以便使用相同的 seed 和参数重复请求应返回相同的结果。 正值会根据新 tokens 在文本中现有的频率进行惩罚，降低模型逐字重复相同行的可能性。 如果目标只是稍微减少重复样本，合理的值在 0.1 到 1 之间。如果目标是强烈抑制重复，则可以将系数增加到 2，但这可能会显著降低样本质量。负值可用于增加重复的可能性。 另请参见 presence\_penalty，用于以固定速率惩罚至少出现一次的 tokens。 必需范围：`-2 < x < 2` 正值会根据新 tokens 是否出现在文本中进行惩罚，增加模型谈论新主题的可能性。 如果目标只是稍微减少重复样本，合理的值在 0.1 到 1 之间。如果目标是强烈抑制重复，则可以将系数增加到 2，但这可能会显著降低样本质量。负值可用于增加重复的可能性。 另请参见 `frequency_penalty`，用于根据 tokens 出现的频率以递增速率惩罚 tokens。 必需范围：`-2 < x < 2` 对重复的 tokens 应用惩罚以阻止或鼓励重复。值为 1.0 表示没有惩罚，允许自由重复。值高于 1.0 会惩罚重复，降低重复 tokens 的可能性。值在 0.0 和 1.0 之间会奖励重复，增加重复 tokens 的机会。为了获得良好的平衡，通常建议使用 1.2 的值。请注意，惩罚适用于生成的输出和仅解码器模型中的提示。 必需范围：`0 < x < 2` API 将停止生成进一步 tokens 的最多 4 个序列。返回的文本将包含停止序列。 使用的采样温度，介于 0 和 2 之间。较高的值如 0.8 会使输出更随机，而较低的值如 0.2 会使其更集中和确定性。 我们通常建议更改此项或 `top_p`，但不要同时更改。 必需范围：`0 < x < 2` 一种替代采样温度的方法，称为核采样，其中模型考虑具有 top\_p 概率质量的 tokens 结果。因此，0.1 表示仅考虑构成前 10% 概率质量的 tokens。我们通常建议更改此项或温度，但不要同时更改。 必需范围：`0 < x <= 1` Top-k 采样是另一种采样方法，其中最可能的 k 个下一个 tokens 被过滤，并且概率质量仅在这 k 个下一个 tokens 之间重新分配。k 的值控制文本生成期间每个步骤下一个 tokens 的候选数量。 必需范围：`1 < x < 128` 表示 tokens 被考虑的最小概率，相对于最可能 tokens 的概率。 必需范围：`0 <= x <= 1` 修改指定 tokens 在完成中出现的可能性。 接受一个 JSON 对象，将 tokens 映射到 -100 到 100 之间的关联偏差值。 数学上，偏差被添加到模型在采样之前生成的 logits 中。确切的效果会因模型而异。 例如，通过设置 `"logit_bias":{"1024": 6}` 将增加 token ID 为 1024 的 tokens 的可能性。 是否返回输出 tokens 的对数概率。如果为 true，则返回消息内容中每个输出 tokens 的对数概率。 一个介于 0 和 20 之间的整数，指定在每个 tokens 位置返回的最可能 tokens 的数量，每个 tokens 都有一个关联的对数概率。如果使用此参数，则必须将 `logprobs` 设置为 true。 必需范围：`0 <= x <= 20` 模型可以调用的工具列表。目前，仅支持函数作为工具。使用此项提供模型可以为其生成 JSON 输入的函数列表。 在[函数调用指南](/docs/model/llm-function-calling)中了解有关函数调用的更多信息。 工具的类型。 支持的类型：`function` 要调用的函数名称。必须是 a-z、A-Z、0-9，或包含下划线和破折号，最大长度为 64。 函数的描述，模型用于选择何时以及如何调用函数。 函数接受的参数，描述为 JSON Schema 对象。有关格式的文档，请参阅 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/)。 在生成函数调用时是否启用严格的模式遵循。如果设置为 true，模型将遵循参数字段中定义的确切模式。 允许强制模型生成特定的输出格式。 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用结构化输出，确保模型将匹配您提供的 JSON schema。 设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式，确保模型生成的消息是有效的 JSON。对于支持它的模型，建议使用 `json_schema`。 枚举值: `text`, `json_object`, `json_schema` JSON Schema 响应格式。用于生成结构化 JSON 响应。 仅当 `type` 设置为 `json_schema` 时支持，并且当 `type` 设置为 `json_schema` 时也是必需的。 请在[结构化输出指南](/docs/model/llm-structured-outputs)中了解更多信息。 响应格式的名称。必须是 a-z、A-Z、0-9，或包含下划线和破折号，最大长度为 64。 响应格式的描述，模型用于确定如何以该格式响应。 响应格式的模式，描述为 JSON Schema 对象。了解如何在[此处](https://json-schema.org/specification)构建 JSON schema。 支持的类型：`string`, `number`, `integer`, `boolean`, `array`, `object`, `enum`, `anyOf`。 在生成输出时是否启用严格的模式遵循。如果设置为 true，模型将始终遵循 schema 字段中定义的确切模式。当 strict 为 true 时，仅支持 JSON Schema 的子集。 如果您通过提供 `strict: true` 启用结构化输出并使用不支持的 JSON Schema 调用 API，您将收到错误。 是否将推理与 "content" 分开到 "reasoning\_content" 字段中。 支持的模型： * `deepseek/deepseek-r1-turbo` 控制在思考和非思考模式之间的切换。 支持的模型： * `zai-org/glm-4.5` ## 响应信息 聊天完成选项的列表。 模型停止生成 tokens 的原因。如果模型达到自然停止点或提供的停止序列，则为 "stop"；如果达到请求中指定的最大 tokens 数量，则为 "length"。 可用选项: `stop`, `length` 聊天完成选项的索引。 此消息作者的角色。 可用选项: `system`, `user`, `assistant` 消息的内容。 推理步骤的内容。 仅当 `separate_reasoning` 设置为 true 时，此字段才可用。 响应生成时的 Unix 时间（以秒为单位）。 响应的唯一标识符。 用于聊天完成的模型。 对象类型，始终为 `chat.completion`。 使用统计信息。 对于流式响应，使用字段包含在返回的最后一个响应块中。 生成的完成中的 tokens 数量。 提示中的 tokens 数量。 请求中使用的 tokens 总数（提示 + 完成）。 # 创建对话请求 Source: https://docs.jiekou.ai/docs/models/reference-llm-create-completion POST https://api.highwayapi.ai/openai/v1/completions 根据指定的 prompt 与参数生成模型回复 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 对应的模型名称。可用模型名称请参考：[JieKou AI](https://jiekou.vip/#model-library) 中的模型库。 用于生成对话的提示（提示可以是字符串、字符串数组、tokens 数组或 tokens 数组的数组）。 在生成对话时可产生的最大 tokens 数。
prompt 的 tokens 数量加上 max\_tokens 不能超过模型的上下文长度。 是否使用流式传输。默认为 false，如果设置了，tokens 将以 data-only server-sent events（SSE）发送，并以 data: \[DONE] 消息终止流。 流式回复选项。仅当 stream 设置为 true 时设置。 如果设置，将在数据: \[DONE] 消息之前流式传输一个额外的 chunk。此 chunk 中的 usage 字段显示整个请求的 tokens 使用统计信息，而 choices 字段始终为空数组。所有其他 chunk 也将包含一个 usage 字段，但值为 null。 每个提示生成多少个对话。默认值为 1。

注意：由于此参数会生成多个对话，因此可能会快速消耗您的 tokens 计费额度。请谨慎使用，并确保为 max\_tokens 和 stop 设置了合理的值。
所需范围：1 \< x \< 128 如果指定，我们的系统将尽最大努力进行确定性采样，以便相同的 seed 和参数的重复请求应返回相同的结果。 默认值为 0，正值会根据新 tokens 在当前文本中的出现频率对其进行惩罚，从而降低模型重复相同内容的可能性。

如果目的是仅仅减少重复样本，合理的值大约在 0.1 到 1 之间。如果目的是强烈抑制重复，可以将系数提高到 2，但这可能会明显降低样本质量。负值可以用来增加重复的可能性。

另见 presence\_penalty，用于以固定速率惩罚至少出现一次的 tokens
所需范围：-2 \< x \< 2 默认值为 0，正值会根据新 tokens 是否出现在当前文本中对其进行惩罚，从而增加模型谈论新话题的可能性。

如果目的是稍微减少重复样本，合理的值大约在 0.1 到 1 之间。如果目的是强烈抑制重复，可以将系数提高到 2，但这可能会显著降低样本质量。负值可以用来增加重复的可能性。

另见 frequency\_penalty，用于根据 tokens 出现的频率按递增速率进行惩罚
所需范围：-2 \< x \< 2 对重复的 tokens 应用惩罚，以抑制或鼓励重复。值为 1.0 表示没有惩罚，允许自由重复。大于 1.0 的值会惩罚重复，降低重复 tokens 的可能性。介于 0.0 和 1.0 之间的值会奖励重复，增加重复 tokens 的机会。为了达到良好的平衡，通常建议使用 1.2。请注意，在仅解码器模型中，惩罚会同时应用于生成的输出和提示。
所需范围：0 \< x \< 2 最多 4 个序列，API 将停止生成更多 tokens。返回的文本包含停止序列。 对话中的随机性程度，默认值为 1，介于 0 和 2 之间。较高的值（如 0.8）会使输出更加随机，而较低的值（如 0.2），会使输出更集中且确定性更强。

我们通常建议只调整此项或 top\_p，而不是同时调整两者。
所需范围：0 \< x \< 2 作为 temperature 的替代方法，称为 nucleus sampling，模型会考虑具有 top\_p 概率质量的 tokens 的结果。因此，0.1 意味着只考虑构成前 10% 概率质量的 tokens。我们通常建议只调整此项或 temperature，而不是同时调整两者。
所需范围：0 \< x ≤ 1 Top-k 采样是另一种采样方法，在这种方法中，k 个最可能的下一个 tokens 会被筛选出来，并且概率质量仅在这 k 个 tokens 之间重新分配。k 的值控制了在每一步生成文本时，下一个 tokens 的候选数量。
所需范围：1 \< x \< 128 表示一个 tokens 被考虑的最小概率的浮动值，相对于最有可能的 tokens 的概率。
所需范围：0 ≤ x ≤ 1 默认为 null。修改指定 tokens 在对话中出现的可能性。接受一个 JSON 对象，将 tokens 映射到一个从 -100 到 100 的关联偏差值。 返回最可能的 logprobs 个输出 token 的对数概率，同时包含被选中 token 的概率。例如，如果 logprobs 设为 5，API 会返回每步生成时前 5 个最可能 token 的对数概率列表。
logprobs 的最大值为 5。 默认为 1。生成 best\_of 个对话并在服务器端进行处理，返回‘最佳’（即每个 tokens 的对数概率最高的那个）。结果无法流式传输。

与 n 一起使用时，best\_of 控制候选对话的数量，n 指定返回多少个对话。best\_of 必须大于 n。

注意：由于此参数会生成多个对话，因此可能会快速消耗您的 tokens 计费额度。请谨慎使用，并确保为 max\_tokens 和 stop 设置了合理的值。 ## 响应信息 生成的对话选择列表。 模型停止生成 tokens 的原因。如果模型遇到自然停止点或提供的停止序列，则为 ‘stop’；如果请求中指定的最大 tokens 数量已达到，则为 ‘length’。枚举值: `stop,length`。 对话选择的索引。 最有可能的 tokens 的对数概率。 文本偏移的整数数组。 token 对数概率的数字数组。 tokens 的字符串数组。 包含 top 对数概率的对象数组。 给定键的对数概率值。 对话返回的内容。 响应生成的 Unix 时间戳（以秒为单位）。 响应的唯一标识符。 用于对话的模型。 对象类型，始终为 text\_completion。 使用统计。
对于流式回复，usage 字段被包含在返回的最后一个回复块中。 对话生成的 tokens 数。 prompt 中的 tokens 数。 请求中使用的总 tokens 数（prompt + completion）。 # 创建嵌入向量 Source: https://docs.jiekou.ai/docs/models/reference-llm-create-embeddings POST https://api.highwayapi.ai/openai/v1/embeddings 创建一个表示输入文本的嵌入向量。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 要嵌入的输入文本，编码为字符串或 token 数组。要在单个请求中嵌入多个输入，请传递字符串数组或 token 数组。输入不得超过模型的最大输入 token（text-embedding-ada-002 为 8192 个 tokens），不能是空字符串，且任何数组的维度必须小于或等于 2048。 要使用的模型 ID。枚举值: * `baai/bge-m3` 返回嵌入向量的格式。可以是 float 或 base64。 ## 响应信息 固定为 list 模型生成的嵌入向量列表。 嵌入向量的索引。 嵌入向量。 固定为 embedding 使用的模型 ID。 使用信息。 prompt tokens 的数量。 总 tokens 的数量。 # 创建重排序 Source: https://docs.jiekou.ai/docs/models/reference-llm-create-rerank POST https://api.highwayapi.ai/openai/v1/rerank 创建重排序 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 要使用的模型名称。 搜索查询。 文档列表。 返回的最相关文档或索引的数量。 ## 响应信息 ID 原始文档内容。 输入候选文档数组中位置的索引值。 相似度分数。 Tokens 使用统计。 生成的完成中的 tokens 数量。 提示中的 tokens 数量。 请求中使用的 tokens 总数（prompt + completion）。 # 获取模型列表 Source: https://docs.jiekou.ai/docs/models/reference-llm-list-models GET https://api.highwayapi.ai/openai/v1/models 获取当前可用于 LLM API 的模型列表，并提供每个模型的基本信息。此 Endpoint 与 OpenAI API 兼容。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 响应信息 包含以下属性的模型对象数组： 模型标识符，可在 API Endpoints 中引用。 模型创建时的 Unix 时间戳（以秒为单位）。 对象类型，始终为 "model"。 每百万输入 tokens 的价格。 每百万输出 tokens 的价格。 模型的标题。 模型的描述。 模型的最大上下文大小。 # 获取指定模型信息 Source: https://docs.jiekou.ai/docs/models/reference-llm-retrieve-model GET https://api.highwayapi.ai/openai/v1/models/{model} 获取模型实例，提供有关模型的基本信息。此 Endpoint 与 OpenAI API 兼容。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 路径参数 用于此请求的模型 ID。 ## 响应信息 模型 ID，在 API Endpoints 中引用。 模型创建时的 Unix 时间戳（以秒为单位）。 对象类型，始终为 "model"。 每百万输入的 tokens 价格。 每百万输出 tokens 的价格。 模型的标题。 模型的描述。 模型的最大上下文大小。 # Minimax Hailuo 2.3 Fast 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-minimax-hailuo-2.3-fast-i2v POST https://api.highwayapi.ai/v3/async/minimax-hailuo-2.3-fast-i2v Minimax Hailuo 2.3 Fast 在保持优异画质与表现力的同时，大幅提升了生成速度，具备更高性价比。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索视频生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 指导生成所需的提示词文本。 范围: `1 <= x <= 2000`。 用于视频生成的图片。支持公网 URL 或 Base64 编码（如 `data:image/jpeg;base64,...`）。 生成视频的时长（秒）。默认值：`6`
可选值：`6`、`10` 生成视频的分辨率。默认值：`768P` * 6 秒视频支持：`768P`、`1080P` * 10 秒视频仅支持：`768P` 是否启用提示词优化。 默认值: `true`。 ## 响应信息 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Minimax Hailuo 2.3 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-minimax-hailuo-2.3-i2v POST https://api.highwayapi.ai/v3/async/minimax-hailuo-2.3-i2v Minimax Hailuo 2.3 是全新升级的视频生成模型，在肢体动作、物理效果和对指令的理解与执行能力等方面表现更为出色。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索视频生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 指导生成所需的提示词文本。 范围: `1 <= x <= 2000`。 支持 15 种运镜指令的指令: * 左右移: \[左移], \[右移] * 左右摇: \[左摇], \[右摇] * 推拉: \[推进], \[拉远] * 升降: \[上升], \[下降] * 上下摇: \[上摇], \[下摇] * 变焦: \[变焦推近], \[变焦拉远] * 其他: \[晃动], \[跟随], \[固定] 使用规则: * 组合运镜: 同一组 \[] 内的多个指令会同时生效，如 \[左摇,上升]，建议组合不超过 3 个 * 顺序运镜: prompt 中前后出现的指令会依次生效，如 "...\[推进], 然后...\[拉远]" * 自然语言: 也支持通过自然语言描述运镜，但使用标准指令能获得更准确的响应 用于视频生成的图片。支持公网 URL 或 Base64 编码（如 `data:image/jpeg;base64,...`）。 生成视频的时长（秒）。默认值：`6`
可选值：`6`、`10` 生成视频的分辨率。默认值：`768P` * 6 秒视频支持：`768P`、`1080P` * 10 秒视频仅支持：`768P` 是否启用提示词优化。 默认值: `true`。 是否缩短提示词优化的耗时。 默认值: `false`。 ## 响应信息 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Minimax Hailuo 2.3 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-minimax-hailuo-2.3-t2v POST https://api.highwayapi.ai/v3/async/minimax-hailuo-2.3-t2v Minimax Hailuo 2.3 是全新升级的视频生成模型，在肢体动作、物理效果和对指令的理解与执行能力等方面表现更为出色。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索视频生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 指导生成所需的提示词文本。 范围: `1 <= x <= 2000`。 支持 15 种运镜指令的指令: * 左右移: \[左移], \[右移] * 左右摇: \[左摇], \[右摇] * 推拉: \[推进], \[拉远] * 升降: \[上升], \[下降] * 上下摇: \[上摇], \[下摇] * 变焦: \[变焦推近], \[变焦拉远] * 其他: \[晃动], \[跟随], \[固定] 使用规则: * 组合运镜: 同一组 \[] 内的多个指令会同时生效，如 \[左摇,上升]，建议组合不超过 3 个 * 顺序运镜: prompt 中前后出现的指令会依次生效，如 "...\[推进], 然后...\[拉远]" * 自然语言: 也支持通过自然语言描述运镜，但使用标准指令能获得更准确的响应 生成视频的时长（秒）。默认值：`6`
可选值：`6`、`10` 生成视频的分辨率。默认值：`768P` * 6 秒视频支持：`768P`、`1080P` * 10 秒视频仅支持：`768P` 是否启用提示词优化。 默认值: `true`。 是否缩短提示词优化的耗时。 默认值: `false`。 ## 响应信息 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Midjourney 区域重绘 Source: https://docs.jiekou.ai/docs/models/reference-mj-inpaint POST https://api.highwayapi.ai/v3/async/mj-inpaint 使用 Midjourney 区域重绘功能，对已生成图像的指定区域进行重新绘制。支持通过多边形区域或黑白蒙版图片指定重绘区域，该接口采用异步处理方式，客户端需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 图片编号，用于指定要进行区域重绘的图片。 取值范围：0\~3 原始图像生成任务的唯一标识符。 重绘区域提示词，用于描述重绘区域的期望内容。 长度限制：1-8192 个字符。 绘制区域配置，替代 area 参数，支持多区域重绘。areas 和 url 二选一。 以黑白二值图片指定多边形区域，支持指定多个区域，白色区域为重绘区域。 多边形区域数组，支持指定多个区域。 多边形区域坐标点数组，以左上为原点，按顺时针方向、以 XYXY 的方式组织。 图片像素宽度。 取值范围：500\~4096 图片像素高度。 取值范围：500\~4096 单个多边形区域配置（与 mask 参数二选一使用）。 多边形区域坐标点数组，以左上为原点，按顺时针方向、以 XYXY 的方式组织。 图片像素宽度。 取值范围：500\~4096 图片像素高度。 取值范围：500\~4096 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Midjourney 扩图 Source: https://docs.jiekou.ai/docs/models/reference-mj-outpaint POST https://api.highwayapi.ai/v3/async/mj-outpaint 使用 Midjourney 扩图功能，对已生成的图像进行外扩处理，在保持原图内容的基础上扩展图像边界。该接口采用异步处理方式，客户端需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 图片编号，用于指定要进行扩图的图片。 取值范围：0\~3 原始图像生成任务的唯一标识符。 扩图区域提示词，用于描述扩展区域的内容。 长度限制：1-8192 个字符。 扩图目标比例，即在视图中新图所占区域相较原图区域的倍数。 取值范围：1.1\~2.0 例如：一个 1:1 图片扩图后，外扩 20%（scale=1.2） ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Midjourney 重塑 Source: https://docs.jiekou.ai/docs/models/reference-mj-remix POST https://api.highwayapi.ai/v3/async/mj-remix 使用 Midjourney 重塑功能，对已生成图像进行重新创作和调整。支持强烈调整和细微调整两种模式，通过新的提示词对指定图片进行重塑处理。该接口采用异步处理方式，客户端需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 图片编号，用于指定要进行重塑的图片。 取值范围：0\~3 原始图像生成任务的唯一标识符。 新提示词，用于描述重塑后图像的期望内容和风格。 长度限制：1-8192 个字符。 Remix 模式，控制重塑的强度和程度。 * `0`: 强烈调整 - 对图像进行较大幅度的重塑和改变 * `1`: 细微调整 - 对图像进行轻微的调整和优化 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Midjourney 移除背景 Source: https://docs.jiekou.ai/docs/models/reference-mj-remove-background POST https://api.highwayapi.ai/v3/async/mj-remove-background 使用 Midjourney 移除背景功能，自动识别并移除图像中的背景，保留主体对象。该接口采用异步处理方式，客户端需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 图片 url，指定要移除背景的图像地址。 最大长度：1024 字符 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Midjourney 重新执行 Source: https://docs.jiekou.ai/docs/models/reference-mj-reroll POST https://api.highwayapi.ai/v3/async/mj-reroll 使用 Midjourney 重新执行功能，对已生成的图像任务进行重新生成，获得不同的结果变体。该接口采用异步处理方式，客户端需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 任务 ID，用于指定要重新执行的原始任务。 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Midjourney 文生图 Source: https://docs.jiekou.ai/docs/models/reference-mj-txt2img POST https://api.highwayapi.ai/v3/async/mj-txt2img 使用 Midjourney 图像生成模型，通过文本描述快速生成高质量图像。该接口采用异步处理方式，客户端需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 文本信息，用于描述期望生成的图像内容。 长度限制：1-8192 个字符。 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Midjourney 高清 Source: https://docs.jiekou.ai/docs/models/reference-mj-upscale POST https://api.highwayapi.ai/v3/async/mj-upscale 使用 Midjourney 高清功能，对已生成的图像进行高清化处理，提升图像分辨率和细节质量。该接口采用异步处理方式，客户端需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 图片编号，用于指定要进行高清处理的图片。 取值范围：0\~3 原始图像生成任务的唯一标识符。 高清类型，控制高清处理的风格。 取值范围：0\~1 * `0`: v6/niji6/v6.1/v7 subtle 高清 * `1`: v6/niji6/v6.1/v7 creative 高清 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Midjourney 变化 Source: https://docs.jiekou.ai/docs/models/reference-mj-variation POST https://api.highwayapi.ai/v3/async/mj-variation 使用 Midjourney 变化功能，对已生成的图像进行轻微或强烈的变换，创造出不同风格的变体图像。该接口采用异步处理方式，客户端需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 图片编号，用于指定要进行变化的图片。 取值范围：0\~3 原始图像生成任务的唯一标识符。 新的提示词，用于指导图像变化的方向。 长度限制：1-8192 个字符。 变换类型，控制变化的强度。 取值范围：0\~1 * `0`: subtle 轻微变换 * `1`: strong 强烈变换 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Nano Banana 2 图生图 Source: https://docs.jiekou.ai/docs/models/reference-nano-banana-2-i2i POST https://api.highwayapi.ai/v3/nano-banana-2-i2i 基于文本提示词与参考图像使用 Nano Banana 2 模型生成图像，支持配置图像尺寸比例与画质等级。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 用于生成图像的文本提示词，支持中英文。建议不超过 1000 个字符。 图生图参考图像，支持图像 URL 或 Base64 编码。可传入单张图像（字符串）或多张图像（字符串数组）。 输出图像的尺寸比例，系统会自动映射为对应的像素尺寸。 可选值：`1x1`, `2x3`, `3x2`, `3x4`, `4x3`, `4x5`, `5x4`, `9x16`, `16x9`, `21x9` 图像生成质量等级，更高质量可生成更清晰、更细腻的图像。 可选值：`1k`, `2k`, `4k` 生成图像的返回格式。 可选值：`url`, `b64_json` ## 响应信息 生成的图像数组，元素为图像 URL（当 `response_format` 为 `url` 时）或 Base64 编码字符串（当 `response_format` 为 `b64_json` 时）。 # Nano Banana 2 文生图 Source: https://docs.jiekou.ai/docs/models/reference-nano-banana-2-t2i POST https://api.highwayapi.ai/v3/nano-banana-2-t2i 基于文本提示词使用 Nano Banana 2 模型生成图像，支持配置图像尺寸比例与画质等级。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 用于生成图像的文本提示词，支持中英文。建议不超过 1000 个字符。 输出图像的尺寸比例，系统会自动映射为对应的像素尺寸。 可选值：`1x1`, `2x3`, `3x2`, `3x4`, `4x3`, `4x5`, `5x4`, `9x16`, `16x9`, `21x9` 图像生成质量等级，更高质量可生成更清晰、更细腻的图像。 可选值：`1k`, `2k`, `4k` 生成图像的返回格式。 可选值：`url`, `b64_json` ## 响应信息 生成的图像数组，元素为图像 URL（当 `response_format` 为 `url` 时）或 Base64 编码字符串（当 `response_format` 为 `b64_json` 时）。 # Nano Banana Light 图生图 Source: https://docs.jiekou.ai/docs/models/reference-nano-banana-light-i2i POST https://api.highwayapi.ai/v3/nano-banana-light-i2i 根据输入图像和文本描述生成新图像 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 遮罩图像URL或Base64编码 生成图像的大小 可选值：`1x1`, `2x3`, `3x2`, `3x4`, `4x3`, `4x5`, `5x4`, `9x16`, `16x9`, `21x9` 要处理的输入图像列表 数组长度：1 - 10 图像URL或Base64编码 所需图像的文本描述。最大长度为1000个字符。 选择图像生成质量 可选值：`1k`, `2k`, `4k` 返回生成的图像的格式。 可选值：`url`, `b64_json` ## 响应信息 生成的图像列表 图像URL（当response\_format为url时） Base64编码的图像数据（当response\_format为b64\_json时） 修订后的提示词（如果有的话） 创建时间戳 # Nano Banana Light 文生图 Source: https://docs.jiekou.ai/docs/models/reference-nano-banana-light-t2i POST https://api.highwayapi.ai/v3/nano-banana-light-t2i 根据文本描述生成图像 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 生成图像的大小 可选值：`1x1`, `2x3`, `3x2`, `3x4`, `4x3`, `4x5`, `5x4`, `9x16`, `16x9`, `21x9` 所需图像的文本描述。图像可以通过url上传。最大长度为1000个字符。 选择图像生成质量 可选值：`1k`, `2k`, `4k` 返回生成的图像的格式。 可选值：`url`, `b64_json` ## 响应信息 生成的图像列表 图像URL（当response\_format为url时） Base64编码的图像数据（当response\_format为b64\_json时） 修订后的提示词（如果有的话） 创建时间戳 # Nano Banana Pro Light 图生图 (reverse) Source: https://docs.jiekou.ai/docs/models/reference-nano-banana-pro-light-i2i POST https://api.highwayapi.ai/v3/nano-banana-pro-light-i2i 根据输入图像和文本描述生成新图像 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 遮罩图像URL或Base64编码 生成图像的大小 可选值：`1x1`, `2x3`, `3x2`, `3x4`, `4x3`, `4x5`, `5x4`, `9x16`, `16x9`, `21x9` 要处理的输入图像列表 数组长度：1 - 10 图像URL或Base64编码 所需图像的文本描述。 选择图像生成质量 可选值：`1k`, `2k`, `4k` 返回生成的图像的格式。必须是url之一—b64\_json。 可选值：`url`, `b64_json` ## 响应信息 生成的图像列表 图像URL（当response\_format为url时） Base64编码的图像数据（当response\_format为b64\_json时） 修订后的提示词（如果有的话） 创建时间戳 # Nano Banana Pro Light 文生图 (reverse) Source: https://docs.jiekou.ai/docs/models/reference-nano-banana-pro-light-t2i POST https://api.highwayapi.ai/v3/nano-banana-pro-light-t2i 根据文本描述生成图像 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 要生成的图像数。必须介于1和10之间。 取值范围：\[1, 10] 生成图像的大小 可选值：`1x1`, `2x3`, `3x2`, `3x4`, `4x3`, `4x5`, `5x4`, `9x16`, `16x9`, `21x9` 所需图像的文本描述。 选择图像生成质量 可选值：`1k`, `2k`, `4k` 返回生成的图像的格式。必须是url之一—b64\_json。 可选值：`url`, `b64_json` ## 响应信息 生成的图像列表 图像URL（当response\_format为url时） Base64编码的图像数据（当response\_format为b64\_json时） 修订后的提示词（如果有的话） 创建时间戳 # Qwen-Image 图像编辑 Source: https://docs.jiekou.ai/docs/models/reference-qwen-image-edit POST https://api.highwayapi.ai/v3/async/qwen-image-edit Qwen-Image 图像编辑 — 一个用于下一代图像编辑生成的 20B MMDiT 模型。基于 20B Qwen-Image，它在保留风格的同时，提供精确的双语文本编辑（中文和英文），并支持语义和外观级别的编辑。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 用于生成图像的提示。 用于生成图像的图像。 用于生成的随机种子。-1 表示将使用随机种子。范围：-1 \~ 2147483647。默认值为 -1。 输出图像的格式。默认是 jpeg。
枚举值: `jpeg`, `png`, `webp` ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Qwen-Image 文生图 Source: https://docs.jiekou.ai/docs/models/reference-qwen-image-txt2img POST https://api.highwayapi.ai/v3/async/qwen-image-txt2img Qwen-Image — 一个 20B MMDiT 模型，用于下一代文本到图像生成。特别擅长创建带有本地文本的惊艳图形海报。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 图像生成的文本提示。 生成媒体的像素大小（宽\*高）。默认值为 `1024*1024`。长和宽的像素范围：256 \~ 1536。 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Seedance 2.0 原厂协议 Source: https://docs.jiekou.ai/docs/models/reference-seedance-2.0-native POST https://api.highwayapi.ai/v3/bytedance/contents/generations/tasks 本文档整合了 Seedance 2.0 视频生成 API 及其配套的两种素材管理 API，为开发者提供一站式的协议参考。 三部分内容的关系如下： * **视频生成 API**：核心能力，通过 Seedance 2.0 / Seedance 2.0-fast 模型生成视频。 * **虚拟人像素材 API**：将图片、视频或音频创建为可被 Seedance 引用的素材，生成时使用 `asset://` 引用。 * **真人素材 API**：用户完成 H5 真人验证后，将该真人的画像创建为可被 Seedance 引用的素材，同样使用 `asset://` 引用。 素材 API 创建的 asset 可被视频生成 API 引用，实现"先建素材 → 再生成视频"的完整流程。 *** ## 一、视频生成 API ### 1.1 调用方式 **创建任务：** ``` POST https://api.highwayapi.ai/v3/bytedance/contents/generations/tasks ``` **查询任务：** ``` GET https://api.highwayapi.ai/v3/bytedance/contents/generations/tasks/{id} ``` ### 1.2 支持模型 | 模型 | 说明 | | ----------------- | --- | | seedance-2.0 | 标准版 | | seedance-2.0-fast | 快速版 | 官方文档参考：[https://www.volcengine.com/docs/82379/1520757?lang=zh](https://www.volcengine.com/docs/82379/1520757?lang=zh) ### 1.3 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ### 1.4 请求体 模型名称。可选值：`seedance-2.0`、`seedance-2.0-fast` 多模态内容数组，支持文本、图片、视频、音频等类型。每项包含 `type` 字段和对应内容。 支持的类型： * `text`：文本提示词，包含 `text` 字段 * `image_url`：图片输入，包含 `image_url.url` 字段，可选 `role` 字段（如 `reference_image`） * `video_url`：视频输入，包含 `video_url.url` 字段，可选 `role` 字段（如 `reference_video`） * `audio_url`：音频输入，包含 `audio_url.url` 字段，可选 `role` 字段（如 `reference_audio`） URL 字段也支持 `asset://` 格式引用已创建的素材。 生成视频时长（秒）。范围 \[4, 15] 视频分辨率。1080p 仅支持标准版。 可选值：`480p`, `720p`, `1080p` 生成视频的宽高比。 可选值：`16:9`, `4:3`, `1:1`, `3:4`, `9:16`, `21:9`, `adaptive` 是否生成与画面同步的声音。true 时模型基于文本与视觉内容自动生成匹配的人声、音效及背景音乐。 生成视频是否包含水印。 ### 1.5 REST API 示例 **创建任务：** ```bash theme={null} curl -X POST 'https://api.highwayapi.ai/v3/bytedance/contents/generations/tasks' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d @- << EOF { "content": [ { "text": "A cat walking through a sunny garden", "type": "text" } ], "duration": 5, "model": "seedance-2.0", "resolution": "480p" } EOF ``` **查询任务：** ```bash theme={null} curl -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ 'https://api.highwayapi.ai/v3/bytedance/contents/generations/tasks/975de73b-85ff-47f1-b199-737b72fe92da' ``` ### 1.6 SDK 示例 ```python theme={null} import os import time # Install SDK: pip install 'volcengine-python-sdk[ark]' from volcenginesdkarkruntime import Ark client = Ark( base_url='https://api.highwayapi.ai/v3/bytedance', api_key=os.environ.get("YOUR_API_KEY"), ) if __name__ == "__main__": print("----- create request -----") create_result = client.content_generation.tasks.create( model="seedance-2.0-fast", content=[ { "type": "text", "text": "全程使用视频1的第一视角构图，全程使用音频1作为背景音乐。第一人称视角果茶宣传广告...", }, { "type": "image_url", "image_url": { "url": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic1.jpg" }, "role": "reference_image", }, { "type": "image_url", "image_url": { "url": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic2.jpg" }, "role": "reference_image", }, { "type": "video_url", "video_url": { "url": "https://ark-project.tos-cn-beijing.volces.com/doc_video/r2v_tea_video1.mp4" }, "role": "reference_video", }, { "type": "audio_url", "audio_url": { "url": "https://ark-project.tos-cn-beijing.volces.com/doc_audio/r2v_tea_audio1.mp3" }, "role": "reference_audio", }, ], generate_audio=True, ratio="16:9", duration=11, watermark=True, ) print(create_result) # Polling query section print("----- polling task status -----") task_id = create_result.id while True: get_result = client.content_generation.tasks.get(task_id=task_id) status = get_result.status if status == "succeeded": print("----- task succeeded -----") print(get_result) break elif status == "failed": print("----- task failed -----") print(f"Error: {get_result.error}") break else: print(f"Current status: {status}, Retrying after 30 seconds...") time.sleep(30) ``` *** ## 二、虚拟人像素材 API ### 2.1 适用范围 本接口用于将图片、视频或音频创建为 Seedance 可引用的虚拟人像素材。素材创建完成并返回 Active 后，使用 `asset://` 引用。 ### 2.2 调用方式 统一入口： ``` POST https://api.highwayapi.ai/v3/synthetic/bytedance/ark?Action={Action}&Version=2024-01-01 Content-Type: application/json ``` ### 2.3 鉴权 客户只需要传平台 API Key：`Authorization: Bearer ` ### 2.4 支持 Action | Action | 方法 | 说明 | | ----------- | ---- | ----------------------- | | CreateAsset | POST | 创建虚拟人像素材，返回平台 asset id。 | | GetAsset | POST | 查询素材状态。 | ### 2.5 通用响应结构 **成功响应：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "CreateAsset", "Version": "2024-01-01" }, "Result": {} } ``` **错误响应：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "CreateAsset", "Version": "2024-01-01", "Service": "ark", "Error": { "Code": "InvalidParameter", "Message": "URL is required" } } } ``` ### 2.6 创建资产 (CreateAsset) 使用公网可下载的图片、视频或音频 URL 创建虚拟人像素材。CreateAsset 为异步处理，创建后建议调用 GetAsset 轮询状态。 **Request：** ```bash theme={null} curl -X POST 'https://api.highwayapi.ai/v3/synthetic/bytedance/ark?Action=CreateAsset&Version=2024-01-01' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "URL": "https://your-cdn.example.com/assets/reference-image.png", "AssetType": "Image", "Name": "product_reference_image" }' ``` **Request 字段：** | 字段 | 类型 | 必填 | 说明 | | ----------- | ------ | -- | --------------------------------- | | URL | string | 是 | 素材 URL，平台和上游服务必须能从公网下载。 | | AssetType | string | 否 | 支持 Image、Video、Audio；不传时默认 Image。 | | Name | string | 否 | 客户侧素材名称，用于区分和幂等匹配。 | | ProjectName | string | 否 | 可传但会被平台忽略，平台统一使用默认项目。 | **素材建议：** | 类型 | 建议 | | -- | --------------------------------------- | | 图片 | JPG / PNG；URL 可公网下载；内容应符合平台和上游内容安全要求。 | | 视频 | MP4 等常见格式；分辨率、时长和编码需满足上游 Seedance 资产要求。 | | 音频 | MP3 / WAV 等常见格式；URL 可公网下载。 | **Response：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "CreateAsset", "Version": "2024-01-01" }, "Result": { "Id": "asset-20260701111803-yqveg", "AssetType": "Image", "Name": "product_reference_image", "Status": "Processing" } } ``` **Response 字段：** | 字段 | 说明 | | --------- | ----------------------------------- | | Id | 平台 asset id，后续使用 `asset://` 引用。 | | Status | 素材状态，初始通常为 Processing。 | | AssetType | 素材类型。 | | Name | 创建时传入的素材名称。 | **重复创建行为：** 同一账号下，CreateAsset 会在同一上游供应商绑定内按 URL + AssetType + Name 精确幂等： | 场景 | 行为 | | ---------------------------------- | --------------------- | | 命中同一上游供应商，且 URL、AssetType、Name 均相同 | 返回已创建的同一个平台 asset id。 | | URL、AssetType 或 Name 任一不同 | 按新的创建请求处理。 | **常见错误：** | HTTP | Code | Message | 说明 | | ---- | ------------------- | ------------------------------------------- | ------------------------- | | 400 | InvalidParameter | URL is required | 未传 URL。 | | 404 | InvalidAction | Action is not supported for bytedance asset | Action 不在虚拟人像素材白名单内。 | | 503 | NoProviderAvailable | no asset provider available | 当前没有可用素材供应商，请稍后重试或联系平台支持。 | > 上游素材校验失败时，平台会透传上游错误。例如视频分辨率过低时，上游可能返回类似 `InvalidParameter.HeightTooSmall` 的错误。 ### 2.7 查询资产状态 (GetAsset) 查询素材状态。建议创建后轮询到 Status=Active 再用于视频生成。 **Request：** ```bash theme={null} curl -X POST 'https://api.highwayapi.ai/v3/synthetic/bytedance/ark?Action=GetAsset&Version=2024-01-01' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "Id": "asset-20260701111803-yqveg" }' ``` **Request 字段：** | 字段 | 类型 | 必填 | 说明 | | -- | ------ | -- | --------------------------- | | Id | string | 是 | CreateAsset 返回的平台 asset id。 | **Response：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "GetAsset", "Version": "2024-01-01" }, "Result": { "Id": "asset-20260701111803-yqveg", "AssetType": "Image", "Name": "product_reference_image", "Status": "Active" } } ``` **失败状态示例：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "GetAsset", "Version": "2024-01-01" }, "Result": { "Id": "asset-20260701111803-yqveg", "AssetType": "Video", "Name": "product_reference_video", "Status": "Failed", "ErrorMessage": "asset validation failed" } } ``` **Status 说明：** | Status | 说明 | | ---------- | --------------------------- | | Processing | 处理中，继续轮询。 | | Active | 素材可用于 Seedance 视频生成。 | | Failed | 素材创建失败，响应可能包含 ErrorMessage。 | **常见错误：** | HTTP | Code | Message | 说明 | | ---- | ---------------- | ------------------------------------------- | -------------------------- | | 400 | InvalidParameter | Id is required | 未传 Id。 | | 404 | AssetNotFound | asset not found | asset 不存在或不属于当前账号。 | | 409 | AssetUnavailable | asset unavailable, please upload again: ... | 当前素材绑定的上游命名空间不可用，需要重新创建素材。 | ### 2.8 Seedance 生成中引用虚拟人像素材 当 GetAsset 返回 Active 后，可在 Seedance 请求中使用： ```json theme={null} { "model": "seedance-2.0", "content": [ { "type": "text", "text": "Create a product video with a clean studio background." }, { "type": "image_url", "image_url": { "url": "asset://asset-20260701111803-yqveg" }, "role": "reference_image" } ] } ``` | 字段 | 适用素材 | | ------------------------- | ----- | | content\[].image\_url.url | Image | | content\[].video\_url.url | Video | | content\[].audio\_url.url | Audio | **生成侧常见错误：** | HTTP | Code / reason | Message / details | 说明 | | ---- | ---------------------- | ------------------------------------------------------------------ | -------------------------------------- | | 400 | INVALID\_REQUEST\_BODY | asset not found: \ | asset 不存在，或不属于当前账号。 | | 400 | INVALID\_REQUEST\_BODY | asset not ready: \ (status=Processing) | asset 尚未 Active，需要继续轮询。 | | 400 | INVALID\_REQUEST\_BODY | all assets in one request must belong to the same provider account | 同一请求中引用了不同供应商账号的 asset。 | | 400 | INVALID\_REQUEST\_BODY | asset unavailable, please upload again: ... | asset 绑定的上游命名空间不可用，不会 fallback 到其他供应商。 | ### 2.9 排障清单 | 现象 | 优先检查 | | --------------- | ------------------------------------------------------------------- | | InvalidAction | 是否使用 /v3/synthetic/bytedance/ark，且 Action 为 CreateAsset 或 GetAsset。 | | URL is required | CreateAsset 请求体是否传入 URL。 | | 素材创建失败 | 素材 URL 是否公网可下载；格式、分辨率、时长是否满足上游要求；内容是否符合安全要求。 | | asset not found | API Key 是否属于创建该 asset 的同一账号；asset:// 后的 id 是否为 Result.Id。 | | asset not ready | GetAsset 是否已经返回 Active。 | | 多素材请求失败 | 同一个生成请求内是否混用了不同供应商账号创建的 asset。 | | 带 asset 生成失败 | asset 是否属于当前账号且状态为 Active；若提示 asset unavailable，需要重新创建素材。 | *** ## 三、真人素材 API ### 3.1 适用范围 本接口用于用户完成 H5 真人验证后，将该同一真人的画像创建为 Seedance 可引用的真人素材。素材状态为 Active 后，使用 `asset://` 引用。 ### 3.2 调用方式 统一入口： ``` POST https://api.highwayapi.ai/v3/bytedance/ark?Action={Action}&Version=2024-01-01 ``` ### 3.3 鉴权 客户只需要传平台 API Key：`Authorization: Bearer ` ### 3.4 支持 Action | Action | 方法 | 说明 | | --------------------------- | ---- | ------------------------------------------- | | CreateVisualValidateSession | POST | 创建 H5 真人验证会话，返回 H5Link。 | | GetVisualValidateResult | POST | 使用 H5 回调中的 BytedToken 换取验证结果和 AssetGroupID。 | | CreateAsset | POST | 在资产组下创建资产。 | | GetAsset | POST | 查询资产状态。 | ### 3.5 通用响应结构 **成功响应：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "CreateAsset", "Version": "2024-01-01" }, "Result": {} } ``` **错误响应：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "CreateAsset", "Version": "2024-01-01", "Service": "ark", "Error": { "Code": "InvalidParameter", "Message": "GroupId is required" } } } ``` ### 3.6 创建 H5 真人验证会话 (CreateVisualValidateSession) **Request：** ```bash theme={null} curl -X POST 'https://api.highwayapi.ai/v3/bytedance/ark?Action=CreateVisualValidateSession&Version=2024-01-01' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "CallbackURL": "https://your-app.example.com/liveness/done" }' ``` **Request 字段：** | 字段 | 类型 | 必填 | 说明 | | ----------- | ------ | -- | ---------------------- | | CallbackURL | string | 是 | 用户完成 H5 真人验证后跳转回客户侧页面。 | **Response：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "CreateVisualValidateSession", "Version": "2024-01-01" }, "Result": { "H5Link": "https://example.com/liveness?token=...", "BytedToken": "xxx", "ExpiresInSec": 120, "ExpiresAt": "xxx" } } ``` **Response 字段：** | 字段 | 说明 | | ------------ | ---------------------------------------------- | | H5Link | 客户前端打开该链接，让用户完成真人验证。 | | BytedToken | 真人验证会话 token，后续调用 GetVisualValidateResult 时传入。 | | ExpiresInSec | 有效期秒数，通常为 120 秒。 | | ExpiresAt | 过期时间戳。 | > 用户完成 H5 真人验证：客户前端打开 H5Link 后，用户按页面引导完成真人验证。H5 页面完成后会跳转到创建会话时传入的 CallbackURL。建议客户侧仍以 GetVisualValidateResult 的结果作为真人验证是否可用于创建素材的最终依据。 ### 3.7 获取验证结果 (GetVisualValidateResult) 使用 BytedToken 查询真人验证结果，获取后续创建素材需要的 GroupId。 **Request：** ```bash theme={null} curl -X POST 'https://api.highwayapi.ai/v3/bytedance/ark?Action=GetVisualValidateResult&Version=2024-01-01' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "BytedToken": "xxx" }' ``` **Request 字段：** | 字段 | 类型 | 必填 | 说明 | | ---------- | ------ | -- | -------------------------------------- | | BytedToken | string | 是 | CreateVisualValidateSession 返回的 token。 | **Response：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "GetVisualValidateResult", "Version": "2024-01-01" }, "Result": { "GroupId": "group-xxx-xxx" } } ``` **常见错误：** | HTTP | Code | Message | 说明 | | ---- | ---------------- | ------------------------------------------- | --------------------------- | | 400 | InvalidParameter | BytedToken is required | 未传 BytedToken。 | | 404 | SessionNotFound | liveness session not found | token 不存在或不属于当前账号。 | | 410 | SessionExpired | liveness session expired | token 已过期，需要重新创建 H5 真人验证会话。 | | 409 | AssetUnavailable | asset unavailable, please upload again: ... | 当前素材会话不可用，需要重新发起认证。 | ### 3.8 创建资产 (CreateAsset) 使用 GroupId 和真人画像 URL 创建素材。CreateAsset 是异步处理，创建后建议调用 GetAsset 轮询素材状态。 **Request：** ```bash theme={null} curl -X POST 'https://api.highwayapi.ai/v3/bytedance/ark?Action=CreateAsset&Version=2024-01-01' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "GroupId": "group-xxx-xxx", "URL": "https://your-cdn.example.com/portraits/user123.jpg", "AssetType": "Image", "Name": "user_123_portrait" }' ``` **Request 字段：** | 字段 | 类型 | 必填 | 说明 | | --------- | ------ | -- | ------------------------------------ | | GroupId | string | 是 | GetVisualValidateResult 返回的 GroupId。 | | URL | string | 是 | 真人画像图片 URL，平台必须能公网下载。 | | AssetType | string | 否 | 素材类型，当前仅支持 Image；不传时默认 Image。 | | Name | string | 否 | 素材名称。 | **图片建议：** | 项 | 建议 | | ---- | ------------------ | | 格式 | JPG / PNG | | 可访问性 | 公网可下载，不能依赖客户内网鉴权。 | | 内容 | 应为完成 H5 真人验证的同一真人。 | **Response：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "CreateAsset", "Version": "2024-01-01" }, "Result": { "Id": "asset-xxx-xxx", "AssetType": "Image", "Name": "user_123_portrait", "Status": "Processing" } } ``` **重复创建行为：** 同一账号下，CreateAsset 会按 GroupId + URL + AssetType + Name 精确幂等： | 场景 | 行为 | | ------------------------------ | ----------------------- | | GroupId、URL、AssetType、Name 均相同 | 返回已创建的同一个平台 asset id。 | | URL、AssetType 或 Name 任一不同 | 按新的创建请求处理，并继续进行真人一致性校验。 | ### 3.9 查询资产状态 (GetAsset) 查询素材状态。建议创建后轮询到 Status=Active 再用于视频生成。 **Request：** ```bash theme={null} curl -X POST 'https://api.highwayapi.ai/v3/bytedance/ark?Action=GetAsset&Version=2024-01-01' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "Id": "asset-xxx-yqveg" }' ``` **Response：** ```json theme={null} { "ResponseMetadata": { "RequestId": "6163f1079c03952acff2b5ba4312fdb8", "Action": "GetAsset", "Version": "2024-01-01" }, "Result": { "Id": "asset-xxx-yqveg", "AssetType": "Image", "Name": "user_123_portrait", "Status": "Active" } } ``` **Status 说明：** | Status | 说明 | | ---------- | --------------------------- | | Processing | 处理中，继续轮询。 | | Active | 素材可用于 Seedance 视频生成。 | | Failed | 素材创建失败，响应可能包含 ErrorMessage。 | **常见错误：** | HTTP | Code | Message | 说明 | | ---- | ---------------- | ------------------------------------------- | ------------------ | | 400 | InvalidParameter | Id is required | 未传 Id。 | | 404 | AssetNotFound | asset not found | asset 不存在或不属于当前账号。 | | 409 | AssetUnavailable | asset unavailable, please upload again: ... | 当前素材不可用，需要重新创建。 | ### 3.10 Seedance 生成中引用真人素材 当 GetAsset 返回 Active 后，可以在 Seedance 请求中使用： ```json theme={null} { "model": "seedance-2.0", "content": [ { "type": "text", "text": "使用 @image1 中的真人资产生成一段视频。人物面向镜头自然微笑，保持人物身份、发型和服装一致。" }, { "type": "image_url", "image_url": { "url": "asset://asset-xxx-xxx" }, "role": "reference_image" } ] } ``` ### 3.11 完整流程示例 ```bash theme={null} export ASSET_ENDPOINT="https://api.highwayapi.ai/v3/bytedance/ark" export PLATFORM_API_KEY="" export CALLBACK_URL="https://your-app.example.com/liveness/done" # Step 1: create liveness session curl -sS -X POST "${ASSET_ENDPOINT}?Action=CreateVisualValidateSession&Version=2024-01-01" \ -H "Authorization: Bearer ${PLATFORM_API_KEY}" \ -H "Content-Type: application/json" \ -d "{ \"CallbackURL\": \"${CALLBACK_URL}\" }" # Step 2: open Result.H5Link in browser and finish liveness within 120 seconds. # Step 3: exchange token for GroupId curl -sS -X POST "${ASSET_ENDPOINT}?Action=GetVisualValidateResult&Version=2024-01-01" \ -H "Authorization: Bearer ${PLATFORM_API_KEY}" \ -H "Content-Type: application/json" \ -d '{ "BytedToken": "" }' # Step 4: create asset curl -sS -X POST "${ASSET_ENDPOINT}?Action=CreateAsset&Version=2024-01-01" \ -H "Authorization: Bearer ${PLATFORM_API_KEY}" \ -H "Content-Type: application/json" \ -d '{ "GroupId": "", "URL": "https://your-cdn.example.com/portraits/user123.jpg", "AssetType": "Image", "Name": "user_123_portrait" }' # Step 5: poll asset status curl -sS -X POST "${ASSET_ENDPOINT}?Action=GetAsset&Version=2024-01-01" \ -H "Authorization: Bearer ${PLATFORM_API_KEY}" \ -H "Content-Type: application/json" \ -d '{ "Id": "" }' ``` ### 3.12 排障清单 | 现象 | 优先检查 | | ------------------ | ---------------------------------------------------- | | SessionExpired | 用户是否在 120 秒内完成 H5 真人验证并调用 GetVisualValidateResult。 | | SessionNotFound | API Key 是否属于同一账号；BytedToken 是否复制正确。 | | AssetGroupNotFound | GroupId 是否来自当前 API Key 的 GetVisualValidateResult 响应。 | | 图片上传失败 | 图片 URL 是否公网可下载；图片内容是否为完成真人验证的同一真人。 | | asset not ready | GetAsset 是否已经返回 Active。 | | 带 asset 生成失败 | asset 是否属于当前账号，且状态是否为 Active。 | *** ## 四、素材引用总览 ### 4.1 两种素材 API 对比 | 维度 | 虚拟人像素材 API | 真人素材 API | | ---------------- | --------------------------- | --------------------------------------------------- | | 调用入口 | /v3/synthetic/bytedance/ark | /v3/bytedance/ark | | 前置条件 | 无，直接 CreateAsset | 需先完成 H5 真人验证，获取 GroupId | | 支持素材类型 | Image、Video、Audio | 仅 Image | | CreateAsset 幂等维度 | URL + AssetType + Name | GroupId + URL + AssetType + Name | | CreateAsset 额外字段 | ProjectName（可选，忽略） | GroupId（必填） | | 独有 Action | 无 | CreateVisualValidateSession、GetVisualValidateResult | | 引用方式 | asset://\ | asset://\ | ### 4.2 完整流程对比 **虚拟人像素材流程：** 1. CreateAsset（传入 URL、AssetType、Name） 2. GetAsset 轮询至 Status=Active 3. 在 Seedance 生成请求中使用 `asset://` 引用 **真人素材流程：** 1. CreateVisualValidateSession（传入 CallbackURL）→ 获取 H5Link 和 BytedToken 2. 用户在 H5 页面完成真人验证（120 秒内） 3. GetVisualValidateResult（传入 BytedToken）→ 获取 GroupId 4. CreateAsset（传入 GroupId、URL、AssetType、Name） 5. GetAsset 轮询至 Status=Active 6. 在 Seedance 生成请求中使用 `asset://` 引用 # Seedream 图片生成 4.0 Source: https://docs.jiekou.ai/docs/models/reference-seedream-4.0 POST https://api.highwayapi.ai/v3/seedream-4.0 Seedream 4.0 是一款先进的图像生成模型，提供灵活的图像创建功能，包括支持 4K 分辨率，可以从文本和其他图像生成图像。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 用于生成图像的提示词，支持中英文。 建议不超过 300 个汉字或 600 个英文单词。字数过多信息容易分散，模型可能因此忽略细节，只关注重点，造成视图片缺失部分元素。 输入要编辑的图像的 Base64 编码或可访问的 URL。支持输入单张或多张图像。 * 图像 URL：确保图像 URL 可访问。 * Base64 编码：格式必须为`data:image/<图像格式>;base64,`。
输入图像必须满足以下要求： * 图像格式：jpeg, png * 宽高比（宽度/高度）：范围为\[1/3, 3] * 宽度和高度（像素）：> 14 * 大小：不超过 10 MB * 总像素值：不超过 `6000×6000` PX * 支持上传最多 10 张参考图像。 设置生成图像的规格。有两种方法可用，但不能同时使用。 * 方法 1，指定分辨率。 * 可选值：`1K`, `2K`, `4K` * 方法 2，指定生成图像的宽度和高度（像素）。 * 默认值：`2048x2048` * 总像素值范围：`[1024x1024, 4096x4096]` * 宽高比值范围：`[1/16, 16]` 推荐的宽度和高度： | 宽高比 | 宽度和高度像素值 | | ---- | --------- | | 1:1 | 2048x2048 | | 4:3 | 2304x1728 | | 3:4 | 1728x2304 | | 16:9 | 2560x1440 | | 9:16 | 1440x2560 | | 3:2 | 2496x1664 | | 2:3 | 1664x2496 | | 21:9 | 3024x1296 | 控制是否禁用批量生成功能。 * `auto`：在自动模式下，模型会根据用户的提示词自动决定是否返回多张图像以及包含多少张图像。 * `disabled`：禁用批量生成功能。模型将只生成一张图像。 指定此请求中要生成的最大图像数量。此参数仅在`sequential_image_generation`设置为`auto`时有效。 取值范围：`[1, 15]` 说明 实际生成的图像数量受`max_images`和输入参考图像数量的影响。输入参考图像数量 + 生成图像数量 ≤ 15。 为生成的图像添加水印。 * `false`：不添加水印。 * `true`：在图像的右下角添加带有 "AI 生成" 文字的水印。 ## 响应信息 包含生成图像下载链接的数组。 # Seedream 图片生成 4.5 Source: https://docs.jiekou.ai/docs/models/reference-seedream-4.5 POST https://api.highwayapi.ai/v3/seedream-4.5 根据输入的文本提示词和/或参考图片生成图像。支持生成单图或组图（一组内容关联的图片） ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 指定生成图像的尺寸信息。方式1：指定分辨率（2K、4K）；方式2：指定宽高像素值（如2048x2048）。总像素取值范围：\[3686400, 16777216]，宽高比取值范围：\[1/16, 16]。 输入的图片信息数组，支持 URL 或 Base64 编码。最多支持传入 14 张参考图。图片格式支持 jpeg、png、webp、bmp、tiff、gif。 数组长度：1 - 14 用于生成图像的提示词，支持中英文。建议不超过300个汉字或600个英文单词。 是否在生成的图片中添加水印。 提示词优化功能的配置。 设置提示词优化功能使用的模式。standard：标准模式，质量更高，耗时较长；fast：快速模式，耗时更短，质量一般。当前仅支持 standard 模式。 可选值：`standard` 控制是否关闭组图功能。auto：自动判断模式，模型会根据提示词自主判断是否返回组图；disabled：关闭组图功能，只生成一张图。 可选值：`auto`, `disabled` 组图功能的配置。仅当 sequential\_image\_generation 为 auto 时生效。 指定本次请求最多可生成的图片数量。输入的参考图数量+最终生成的图片数量≤15张。 取值范围：\[1, 15] ## 响应信息 生成的图片信息数组。 # Seedream 5.0 lite Source: https://docs.jiekou.ai/docs/models/reference-seedream-5.0-lite POST https://api.highwayapi.ai/v3/seedream-5.0-lite 根据输入的文本提示词和/或参考图片生成图像。支持生成单图或组图（一组内容关联的图片）。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 指定生成图像的尺寸信息。方式1：指定分辨率（2K、3K）；方式2：指定宽高像素值（如2048x2048）。总像素取值范围：\[2560x1440=3686400, 3072x3072x1.1025=10404496]，宽高比取值范围：\[1/16, 16]。 输入的图片信息数组，支持 URL 或 Base64 编码。最多支持传入 14 张参考图。图片格式支持 jpeg、png、webp、bmp、tiff、gif。 数组长度：1 - 14 用于生成图像的提示词，支持中英文。建议不超过300个汉字或600个英文单词。 是否在生成的图片中添加水印。 提示词优化功能的配置。 设置提示词优化功能使用的模式。standard：标准模式，质量更高，耗时较长；fast：快速模式，耗时更短，质量一般。当前仅支持 standard 模式。 可选值：`standard` 控制是否关闭组图功能。auto：自动判断模式，模型会根据提示词自主判断是否返回组图；disabled：关闭组图功能，只生成一张图。 可选值：`auto`, `disabled` 组图功能的配置。仅当 sequential\_image\_generation 为 auto 时生效。 指定本次请求最多可生成的图片数量。输入的参考图数量+最终生成的图片数量≤15张。 取值范围：\[1, 15] ## 响应信息 生成的图片信息数组。 # OpenAI Sora 2 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-sora-2-img2video POST https://api.highwayapi.ai/v3/async/sora-2-img2video OpenAI Sora 2 将单个参考图像转换为具有同步音频的连贯视频片段。基于 Sora 2 的核心进步，图像到视频的流程在合成可信的运动和摄像机动态的同时，保留了身份、光照和构图。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索视频生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 视频生成的正面文本提示。 输入图像支持 URL 和 Base64 格式，支持的图像格式包括 .jpg、.jpeg、.png。 生成视频的分辨率。 枚举值： * professional 为 true（Pro 版）：`720p`, `1080p`。 * professional 为 false：`720p`。 默认：`720p`。 生成视频的时长（秒）。 枚举值：`4`、`8`、`12`。 默认：`4`。 该参数支持是否使用 Pro 版本。如果未提供，则默认值为 false。 ## 响应信息 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # OpenAI Sora 2 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-sora-2-text2video POST https://api.highwayapi.ai/v3/async/sora-2-text2video OpenAI Sora 2 是一款最先进的视频+音频生成器。它在原有 Sora 基础上进行了改进，具备更精确的物理效果、更清晰的真实感、同步的音频、更强的可操控性以及更广泛的风格范围。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索视频生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 视频生成的正面文本提示。 生成视频的像素大小（宽度\*高度）。 枚举值： * professional 为 true（Pro 版）：`720*1280`、`1280*720`、`1024*1792`、`1792*1024`。 * professional 为 false： `720*1280`、`1280*720`。 默认：`720*1280`。 生成视频的时长（秒）。 枚举值：`4`、`8`、`12`。 默认：`4`。 该参数支持是否使用 Pro 版本。如果未提供，则默认值为 false。 ## 响应信息 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # 视频生成通用接口 Source: https://docs.jiekou.ai/docs/models/reference-unified-video-generation POST https://api.highwayapi.ai/v3/video/create # Veo 3.1 Fast 视频延展 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-fast-generate-extend POST https://api.highwayapi.ai/v3/async/veo-3.1-fast-generate-extend 使用 Google Veo 3.1 Fast 模型对输入视频进行7秒延展。支持720p和1080p分辨率，支持16:9和9:16宽高比。输入视频要求：MP4格式，24fps，时长1-30秒。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于复现生成结果。 取值范围：\[0, 4294967295] 输入视频，支持视频URL或Base64编码数据。视频要求：MP4格式，24fps，时长1-30秒，分辨率720p/1080p，宽高比16:9或9:16。 描述视频延展内容的文本提示词。 输出视频分辨率。 可选值：`720p`, `1080p` 输出视频宽高比。 可选值：`16:9`, `9:16` 生成视频样本数量（1-4）。 取值范围：\[1, 4] 是否同时生成音频。注意：视频延展本身不支持音频生成，此参数仅用于SKU计费区分。 描述需要在生成视频中避免的内容。 是否允许生成成人人物。allow\_adult：允许生成成人；dont\_allow：不允许生成人物。 可选值：`allow_adult`, `dont_allow` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 Fast 首尾帧视频生成 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-fast-generate-firstlastframe POST https://api.highwayapi.ai/v3/async/veo-3.1-fast-generate-firstlastframe 通过指定首帧和尾帧图像，结合文本提示词生成视频。模型在两帧之间插值生成连贯的运动内容。使用 Google Veo 3.1 Fast 模型（veo-3.1-fast-generate-001），生成速度更快。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于确定性生成。相同种子和参数将产生相同结果 取值范围：\[0, 4294967295] 首帧图像，支持图片URL或Base64编码。支持 JPEG、PNG 格式，最大 20MB 文本提示词，描述视频内容和首尾帧之间的运动过程 尾帧图像，支持图片URL或Base64编码。支持 JPEG、PNG 格式，最大 20MB 输出视频分辨率 可选值：`720p`, `1080p` 视频宽高比，16:9 为横屏，9:16 为竖屏 可选值：`16:9`, `9:16` 生成视频数量，范围 1-4 取值范围：\[1, 4] 是否增强输入提示词以提升生成质量 是否生成音频轨道 负面提示词，描述不希望在视频中出现的内容 视频时长（秒），可选 4、6、8 秒 可选值：`4`, `6`, `8` 人物生成控制。allow\_adult: 允许生成成人；disallow: 禁止生成人物 可选值：`allow_adult`, `disallow` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 Fast 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-fast-generate-img2video POST https://api.highwayapi.ai/v3/veo-3.1-fast-generate-img2video Veo 3.1 Preview 版本 API 已自动兼容到本接口 使用 Veo 3.1 Fast 视频生成模型，通过输入图像和文本描述生成高质量视频内容。该接口采用异步处理方式，需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 描述您想要生成的视频的文本字符串。 输入图像，支持 URL 或 base64 编码的方式。 结尾图像，用于填充视频最后一帧图像。支持 URL 或 base64 编码的方式。 指定生成视频的宽高比。 枚举值: `16:9`、`9:16`。默认值为 `16:9`。 您想要生成的视频文件的长度（秒）。 枚举值: `4`、`6`、`8`。默认值为 `8`。 指定是否使用 Gemini 增强您的提示词。仅支持 `true`。 默认值: `true` 指定是否为视频生成音频。 描述您想要阻止模型生成的内容的文本字符串。 控制是否允许人物或面部生成的安全设置。 枚举值: * `allow_adult` (默认): 仅允许生成成人 * `dont_allow`: 不允许在图像中包含人物或面部 * `allow_all`: 允许生成所有年龄段的人物（需项目在 allowlist 中） 生成视频的分辨率。 枚举值: `720p` (默认) 或 `1080p` 要生成的视频样本数量。 取值范围: 1-4 用于初始化随机生成过程的数字。使用相同的种子、提示词和其他参数会产生相同的输出视频，使生成过程具有确定性。 取值范围: 0-4,294,967,295 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Veo 3.1 Fast 参考图像生成视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-fast-generate-reference POST https://api.highwayapi.ai/v3/async/veo-3.1-fast-generate-reference 使用 Google Veo 3.1 Fast 模型通过1-3张参考图像引导生成视频。支持720p和1080p分辨率，支持16:9和9:16宽高比。时长固定为8秒。参考类型仅支持asset。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于复现生成结果。 取值范围：\[0, 4294967295] 描述期望视频内容的文本提示词。 输出视频分辨率。 可选值：`720p`, `1080p` 输出视频宽高比。 可选值：`16:9`, `9:16` 生成视频样本数量（1-4）。 取值范围：\[1, 4] 是否使用AI改写提示词以获得更好的生成效果。 是否同时生成音频。 描述需要在生成视频中避免的内容。 1-3张参考图像，用于引导视频生成。每个元素包含图像URL或Base64编码数据和参考类型。 数组长度：1 - 3 是否允许生成成人人物。allow\_adult：允许生成成人；dont\_allow：不允许生成人物。 可选值：`allow_adult`, `dont_allow` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 Fast 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-fast-generate-text2video POST https://api.highwayapi.ai/v3/async/veo-3.1-fast-generate-text2video Veo 3.1 Preview 版本 API 已自动兼容到本接口 使用 Veo 3.1 Fast 视频生成模型，通过文本描述生成高质量视频内容。该接口采用异步处理方式，需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 描述您想要生成的视频的文本字符串。 指定生成视频的宽高比。 枚举值: `16:9`、`9:16`。默认值为 `16:9`。 您想要生成的视频文件的长度（秒）。 枚举值: `4`、`6`、`8`。默认值为 `8`。 指定是否使用 Gemini 增强您的提示词。仅支持 `true`。 默认值: `true` 指定是否为视频生成音频。 描述您想要阻止模型生成的内容的文本字符串。 控制是否允许人物或面部生成的安全设置。 枚举值: * `allow_adult` (默认): 仅允许生成成人 * `dont_allow`: 不允许在图像中包含人物或面部 * `allow_all`: 允许生成所有年龄段的人物（需项目在 allowlist 中） 生成视频的分辨率。 枚举值: `720p` (默认) 或 `1080p` 要生成的视频数量。 取值范围: 1-4 用于初始化随机生成过程的数字。使用相同的种子、提示词和其他参数会产生相同的输出视频，使生成过程具有确定性。 取值范围: 0-4,294,967,295 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Veo 3.1 视频延展 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-generate-extend POST https://api.highwayapi.ai/v3/async/veo-3.1-generate-extend 使用 Google Veo 3.1 模型对输入视频进行7秒延展。支持720p和1080p分辨率，支持16:9和9:16宽高比。输入视频要求：MP4格式，24fps，时长1-30秒。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于复现生成结果。 取值范围：\[0, 4294967295] 输入视频，支持视频URL或Base64编码数据。视频要求：MP4格式，24fps，时长1-30秒，分辨率720p/1080p，宽高比16:9或9:16。 描述视频延展内容的文本提示词。 输出视频分辨率。 可选值：`720p`, `1080p` 输出视频宽高比。 可选值：`16:9`, `9:16` 生成视频样本数量（1-4）。 取值范围：\[1, 4] 是否同时生成音频。注意：视频延展本身不支持音频生成，此参数仅用于SKU计费区分。 描述需要在生成视频中避免的内容。 是否允许生成成人人物。allow\_adult：允许生成成人；dont\_allow：不允许生成人物。 可选值：`allow_adult`, `dont_allow` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 首尾帧视频生成 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-generate-firstlastframe POST https://api.highwayapi.ai/v3/async/veo-3.1-generate-firstlastframe 使用 Google Veo 3.1 模型，根据提供的首帧和尾帧图片生成过渡视频。支持4/6/8秒时长，720p和1080p分辨率，可选音频生成。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于复现生成结果。 取值范围：\[0, 4294967295] 首帧图片，支持图片URL或Base64编码数据。格式要求：JPEG或PNG，最大20MB。 描述首帧到尾帧之间视频过渡内容的文本提示词。 尾帧图片，支持图片URL或Base64编码数据。格式要求：JPEG或PNG，最大20MB。 输出视频分辨率。 可选值：`720p`, `1080p` 输出视频宽高比。 可选值：`16:9`, `9:16` 生成视频样本数量（1-4）。 取值范围：\[1, 4] 是否使用 Gemini 增强提示词。Veo 3.x 上此功能无法禁用。 是否同时生成音频。 描述需要在生成视频中避免的内容。 生成视频时长（秒），支持4、6、8秒。 可选值：`4`, `6`, `8` 是否允许生成人物。allow\_adult：允许生成成人；dont\_allow：不允许生成人物；allow\_all：允许所有人物。 可选值：`allow_adult`, `dont_allow`, `allow_all` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-generate-img2video POST https://api.highwayapi.ai/v3/async/veo-3.1-generate-img2video Veo 3.1 Preview 版本 API 已自动兼容到本接口 使用 Veo 3.1 视频生成模型，通过输入图像和文本描述生成高质量视频内容。该接口采用异步处理方式，需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 描述您想要生成的视频的文本字符串。 输入图像，支持 URL 或 base64 编码的方式。 结尾图像，用于填充视频最后一帧图像。支持 URL 或 base64 编码的方式。 最多三张 `asset` 图像或最多一张 `style` 图像的列表，用于描述模型在生成视频时使用的参考图像。 参考图像，支持 URL 或 base64 编码的方式。 指定提供的参考图像类型。支持以下值： * `asset`: 参考图像为生成的视频提供资产，例如：场景、物体或角色。 指定生成视频的宽高比。 枚举值: `16:9`、`9:16`。默认值为 `16:9`。 您想要生成的视频文件的长度（秒）。 枚举值: `4`、`6`、`8`，当使用 `reference_images` 时只能为 `8` 。 默认值为 `8`。 指定是否使用 Gemini 增强您的提示词。仅支持 `true`。 默认值: `true` 指定是否为视频生成音频。 描述您想要阻止模型生成的内容的文本字符串。 控制是否允许人物或面部生成的安全设置。 枚举值: * `allow_adult` (默认): 仅允许生成成人 * `dont_allow`: 不允许在图像中包含人物或面部 * `allow_all`: 允许生成所有年龄段的人物（需项目在 allowlist 中） 生成视频的分辨率。 枚举值: `720p` (默认) 或 `1080p` 要生成的视频样本数量。 取值范围: 1-4 用于初始化随机生成过程的数字。使用相同的种子、提示词和其他参数会产生相同的输出视频，使生成过程具有确定性。 取值范围: 0-4,294,967,295 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Veo 3.1 参考图像生成视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-generate-reference POST https://api.highwayapi.ai/v3/async/veo-3.1-generate-reference 使用 Google Veo 3.1 模型通过1-3张参考图像引导生成视频。支持720p和1080p分辨率，支持16:9和9:16宽高比。时长固定为8秒。参考类型仅支持asset。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于复现生成结果。 取值范围：\[0, 4294967295] 描述期望视频内容的文本提示词。 输出视频分辨率。 可选值：`720p`, `1080p` 输出视频宽高比。 可选值：`16:9`, `9:16` 生成视频样本数量（1-4）。 取值范围：\[1, 4] 是否使用AI改写提示词以获得更好的生成效果。 是否同时生成音频。 描述需要在生成视频中避免的内容。 1-3张参考图像，用于引导视频生成。每个元素包含图像URL或Base64编码数据和参考类型。 数组长度：1 - 3 是否允许生成成人人物。allow\_adult：允许生成成人；dont\_allow：不允许生成人物。 可选值：`allow_adult`, `dont_allow` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-generate-text2video POST https://api.highwayapi.ai/v3/async/veo-3.1-generate-text2video Veo 3.1 Preview 版本 API 已自动兼容到本接口 使用 Veo 3.1 视频生成模型，通过文本描述生成高质量视频内容。该接口采用异步处理方式，需要通过 task\_id 查询最终生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 描述您想要生成的视频的文本字符串。 指定生成视频的宽高比。 枚举值: `16:9`、`9:16`。默认值为 `16:9`。 您想要生成的视频文件的长度（秒）。 枚举值: `4`、`6`、`8`。默认值为 `8`。 指定是否使用 Gemini 增强您的提示词。仅支持 `true`。 默认值: `true` 指定是否为视频生成音频。 描述您想要阻止模型生成的内容的文本字符串。 控制是否允许人物或面部生成的安全设置。 枚举值: * `allow_adult` (默认): 仅允许生成成人 * `dont_allow`: 不允许在图像中包含人物或面部 * `allow_all`: 允许生成所有年龄段的人物（需项目在 allowlist 中） 生成视频的分辨率。 枚举值: `720p` (默认) 或 `1080p` 要生成的视频数量。 取值范围: 1-4 用于初始化随机生成过程的数字。使用相同的种子、提示词和其他参数会产生相同的输出视频，使生成过程具有确定性。 取值范围: 0-4,294,967,295 ## 响应信息参数 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Veo 3.1 Lite 视频延展 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-lite-extend POST https://api.highwayapi.ai/v3/async/veo-3.1-lite-extend 基于 Google Veo 3.1 Lite 模型的视频延展 API，支持对输入视频进行内容延展生成 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于生成可复现的结果 取值范围：\[0, 4294967295] 输入视频的 URL 地址，支持 mp4/mov/mpeg/avi 等格式 描述延展视频内容的文本提示词（仅支持英文） 输出视频分辨率 可选值：`720p`, `1080p` 输出视频宽高比 可选值：`16:9`, `9:16` 生成视频数量 取值范围：\[1, 4] 是否自动优化提示词 是否生成音频轨道 负面提示词，描述需要避免的内容 人物生成安全控制 可选值：`dont_allow`, `allow_adult` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 Lite 首末帧生视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-lite-firstlastframe POST https://api.highwayapi.ai/v3/async/veo-3.1-lite-firstlastframe 使用 Google Veo 3.1 Lite 模型从首帧和末帧图片生成视频。支持 4秒、6秒和8秒时长，720p和1080p分辨率，16:9和9:16宽高比。可选音频生成。输入图片最大 20MB。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于复现生成结果。 取值范围：\[0, 4294967295] 首帧图片，支持图片URL或Base64编码数据。支持格式：JPEG、PNG。最大 20MB。 描述期望生成视频内容的文本提示词。 生成视频的时长，单位为秒。 可选值：`4`, `6`, `8` 输出视频分辨率。 可选值：`720p`, `1080p` 输出视频宽高比。 可选值：`16:9`, `9:16` 生成视频样本数量（1-4）。 取值范围：\[1, 4] 是否通过改写增强提示词。 是否同时生成音频。 描述需要在生成视频中避免的内容。 末帧图片，支持图片URL或Base64编码数据。支持格式：JPEG、PNG。最大 20MB。 是否允许生成成人人物。allow\_adult：允许生成成人；dont\_allow：不允许生成人物。 可选值：`allow_adult`, `dont_allow` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 Lite 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-lite-i2v POST https://api.highwayapi.ai/v3/async/veo-3.1-lite-i2v 使用 Google Veo 3.1 Lite 模型从输入图片生成视频。支持 4秒、6秒和8秒时长，720p和1080p分辨率，16:9和9:16宽高比。可选音频生成。输入图片最大 20MB。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于复现生成结果。 取值范围：\[0, 4294967295] 输入图片，支持图片URL或Base64编码数据。支持格式：JPEG、PNG。最大 20MB。建议分辨率 720p（1280x720）或更高，宽高比 16:9 或 9:16。 描述期望生成视频内容的文本提示词。 生成视频的时长，单位为秒。 可选值：`4`, `6`, `8` 输出视频分辨率。 可选值：`720p`, `1080p` 输出视频宽高比。 可选值：`16:9`, `9:16` 生成视频样本数量（1-4）。 取值范围：\[1, 4] 是否同时生成音频。 描述需要在生成视频中避免的内容。 是否允许生成成人人物。allow\_adult：允许生成成人；dont\_allow：不允许生成人物。 可选值：`allow_adult`, `dont_allow` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Veo 3.1 Lite 文本生成视频 Source: https://docs.jiekou.ai/docs/models/reference-veo-3.1-lite-t2v POST https://api.highwayapi.ai/v3/async/veo-3.1-lite-t2v 使用 Google Veo 3.1 Lite 模型根据文本提示生成视频。支持 4s/6s/8s 时长，720p/1080p 分辨率，16:9 和 9:16 宽高比，可选音频生成。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机种子，用于结果可复现 视频生成的文本描述 长度限制：0 - 2048 视频时长（秒） 可选值：`4`, `6`, `8` 输出视频分辨率 可选值：`720p`, `1080p` 视频宽高比 可选值：`16:9`, `9:16` 生成视频数量 取值范围：\[1, 4] 是否自动优化提示词 是否同时生成音频 不希望出现在视频中的内容 长度限制：0 - 2048 控制是否允许生成人物 可选值：`dont_allow`, `allow_adult` ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Wan 2.5 Preview 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-wan-2.5-i2v-preview POST https://api.highwayapi.ai/v3/async/wan-2.5-i2v-preview Wan 2.5 Preview 图生视频模型支持根据首帧图片和文本生成 5 秒或 10 秒的视频。新增音频能力：支持自动配音，也可自定义音频文件。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索视频生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 基础输入信息，如提示词等。 文本正向提示词。支持中英文，最长 2000 个字符，超出部分自动截断。 示例值：一只小猫在草地上奔跑。 反向提示词，用于描述生成视频时需要避开的内容，可对画面进行规避或限制。 支持中英文，最长500字符，超出部分自动截断。 示例值：低分辨率、错误、最差质量、低质量、残缺、多余的手指、比例不良等。 用于视频生成的起始帧图片的URL。 要求URL可公开访问，并支持HTTP或HTTPS协议。 图片限制： * 图片格式：JPEG、JPG、PNG（不支持透明）、BMP、WEBP； * 尺寸要求：图片宽高需在\[360, 2000]像素范围内； * 文件大小不得超过10MB。 用于视频生成的音频文件URL。详细用法请参考音频设置说明。 音频要求： * 格式：wav、mp3； * 时长：3-30秒； * 文件大小不超过15MB。 超长处理：若音频时长超过目标视频时长（如5秒或10秒），仅保留前5秒或前10秒，其余部分自动舍弃；若音频时长短于视频时长，超出部分为无声视频。例如音频为3秒，视频为5秒，则输出视频前3秒有声音，后2秒为静音。 视频处理参数，例如指定输出视频分辨率、时长等。 生成视频的分辨率档位。
可选：`480P`、`720P`、`1080P`。默认值：`1080P`。 指定生成视频的时长，支持值：`5` 或 `10`（单位：秒）。 默认值：`5`。 是否开启prompt智能改写。开启后，将使用大模型对输入prompt进行智能改写，对较短提示词可显著提升生成效果，但处理时长也会增加。 * `true`：默认，开启智能改写； * `false`：不改写。 示例值：true。 是否添加音频。 参数优先级：audio\_url > audio，仅当 audio\_url 为空时有效。 * `true`：默认，自动为视频添加配音； * `false`：不添加音频，输出为静音视频。 示例值：true。 随机种子，用于控制模型生成内容的随机性，取值范围：\[0, 2147483647]。 不填写时将自动生成随机数。若期望生成结果较为稳定，可传入相同seed值。 示例值：12345。 ## 响应信息 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Wan 2.5 Preview 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-wan-2.5-t2v-preview POST https://api.highwayapi.ai/v3/async/wan-2.5-t2v-preview Wan 2.5 Preview 文生视频模型支持根据文本描述生成高质量视频内容，可生成5秒或10秒的视频。新增音频能力：支持自动配音，也可自定义音频文件。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索视频生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 基础输入信息，如提示词等。 文本正向提示词。支持中英文，最长 2000 个字符，超出部分自动截断。 示例值：一只小猫在月光下奔跑。 反向提示词，用于描述生成视频时需要避开的内容，可实现对画面的规避或限制。 支持中英文，最长500字符，超出部分自动截断。 示例值：低分辨率、错误、最差质量、低质量、残缺、多余的手指、比例不良等。 用于视频生成的自定义音频文件URL。使用方法详见音频设置说明。 音频要求： * 格式：wav、mp3。 * 时长：3\~30秒。 * 文件大小：不超过15MB。 超长处理：若音频时长超过目标视频时长（如5秒或10秒），仅保留前5秒或前10秒，其余部分自动舍弃；若音频时长短于视频时长，超出部分为无声视频。例如音频为3秒、视频为5秒，则输出视频前3秒有声音，后2秒为静音。 视频处理参数。 支持480P、720P、1080P分辨率。默认值：`1920*1080`（即1080P）。 `size`参数用于指定视频输出的分辨率，格式为宽\*高。不同分辨率档位支持的具体值如下： **480P档位**：可选分辨率 * `832*480`：16:9 * `480*832`：9:16 * `624*624`：1:1 **720P档位**：可选分辨率 * `1280*720`：16:9 * `720*1280`：9:16 * `960*960`：1:1 * `1088*832`：4:3 * `832*1088`：3:4 **1080P档位**：可选分辨率 * `1920*1080`：16:9 * `1080*1920`：9:16 * `1440*1440`：1:1 * `1632*1248`：4:3 * `1248*1632`：3:4 **关于 size 参数的常见误区**：需填写具体分辨率（如 `1280*720`），不能填写比例（如 `1:1`）或档位名称（如 `480P`、`720P`）。 输出视频的时长，可选值：`5`秒、`10`秒。 默认值为`5`。 是否开启prompt智能改写。开启后，将使用大模型自动改写输入prompt，对于较短提示词提升生成效果，但处理时长会增加。 * `true`：默认，开启智能改写 * `false`：不改写 是否添加音频。 参数优先级：audio\_url > audio，仅在 audio\_url 为空时有效。 * `true`：默认，自动为视频添加配音 * `false`：不添加音频，输出为静音视频 示例值：true 随机数种子，用于控制模型生成内容的随机性。取值范围：\[0, 2147483647]。 如果不填写，系统自动生成随机种子。若希望生成效果较为稳定一致，可指定相同的seed值。 ## 响应信息 异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 以获取生成结果 # Wan 2.6 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-wan2.6-i2v POST https://api.highwayapi.ai/v3/async/wan2.6-i2v 这是一个异步 API，仅返回异步 task\_id。你需要使用 task\_id 调用任务结果查询 API 获取视频生成结果。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 文本提示词，用来描述生成视频中期望包含的元素和视觉特点。支持中英文，每个汉字/字母占一个字符，超过部分会自动截断。 长度限制：0 - 2000 输入图片的 URL 或 Base64 编码数据。支持 HTTP 或 HTTPS 协议，本地文件可通过上传文件获取临时 URL。图像限制：图像格式：JPEG、JPG、PNG（不支持透明通道）、BMP、WEBP；图像分辨率：图像的宽度和高度范围为\[360, 2000]，单位为像素；文件大小：不超过 10MB。输入图像说明：1. 使用公网访问 URL - 支持 HTTP 或 HTTPS 协议，本地文件可通过上传文件获取临时 URL；示例：[https://cdn.translate.alibaba.com/r/wanx-demo-1.png。2](https://cdn.translate.alibaba.com/r/wanx-demo-1.png。2). 传入 Base64 编码图像后的字符串 - 数据格式：data:;base64,；示例：data:image/png;base64,GDU7MtCZEbTbmRZ......（编码字符串过长，仅展示片段）。更多内容请参见输入图像。 视频特效模板的名称。若未填写，表示不使用任何视频特效。不同模板支持不同的特效模板，调用前请查询视频特效列表，以免调用失败。 音频文件URL，模型将使用该音频生成视频。支持HTTP或HTTPS协议。音频限制：格式为wav、mp3；时长3～30s；文件大小不超过15MB。超限处理：若音频长度超过duration值（5秒或10秒），自动截取前5秒或10秒，其余部分丢弃。若音频长度不足视频时长，超出音频长度部分为无声视频。例如，音频为3秒，视频时长为5秒，输出视频前3秒有声，后2秒无声。 反向提示词，用来描述不希望在视频画面中看到的内容，可以对视频画面进行限制。支持中英文，长度不超过500个字符，超过部分会自动截断。 长度限制：0 - 500 随机数种子。取值范围为\[0, 2147483647]。未指定时，系统自动生成随机种子。若需提升生成结果的可复现性，建议固定seed值。请注意，由于模型生成具有概率性，即使使用相同seed，也不能保证每次生成结果完全一致。 取值范围：\[0, 2147483647] 用于控制是否添加音频。参数优先级：audio\_url > audio，仅在audio\_url为空时生效，使用方式参见音频设置。true：默认值，自动为视频添加音频；false：不添加音频，输出无声视频。 生成视频的时长，单位为秒。duration直接影响费用，请在调用前确认模型价格。生成视频的时长，单位为秒。 可选值：`5`, `10`, `15` 视频生成模式。single：单镜头生成；multi：多镜头生成。 可选值：`single`, `multi` 是否添加水印标识，水印位于视频右下角，文案固定为"AI 生成"。false：默认值，不添加水印；true：添加水印。 指定生成视频的分辨率档位。支持720P、1080P三个档位。 可选值：`720P`, `1080P` 是否开启prompt智能改写。开启后使用大模型对输入prompt进行智能改写。对于较短的prompt生成效果提升明显，但会增加耗时。true：默认值，开启智能改写；false：不开启智能改写。 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Wan 2.6 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-wan2.6-t2v POST https://api.highwayapi.ai/v3/async/wan2.6-t2v 这是一个异步 API，仅返回异步 task\_id。你需要使用 task\_id 调用任务结果查询 API 获取视频生成结果。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 文本提示词，用来描述生成视频中期望包含的元素和视觉特点。支持中英文，每个汉字/字母占一个字符，超过部分会自动截断。 长度限制：0 - 2000 音频文件URL，模型将使用该音频生成视频。支持HTTP或HTTPS协议。音频限制：格式为wav、mp3；时长3～30s；文件大小不超过15MB。超限处理：若音频长度超过duration值（5秒或10秒），自动截取前5秒或10秒，其余部分丢弃。若音频长度不足视频时长，超出音频长度部分为无声视频。例如，音频为3秒，视频时长为5秒，输出视频前3秒有声，后2秒无声。 反向提示词，用来描述不希望在视频画面中看到的内容，可以对视频画面进行限制。支持中英文，长度不超过500个字符，超过部分会自动截断。 长度限制：0 - 500 随机数种子。取值范围为\[0, 2147483647]。未指定时，系统自动生成随机种子。若需提升生成结果的可复现性，建议固定seed值。请注意，由于模型生成具有概率性，即使使用相同seed，也不能保证每次生成结果完全一致。 取值范围：\[0, 2147483647] 指定生成视频的分辨率，格式为宽*高。支持720P档位（1280*720/720*1280/960*960/1088*832/832*1088）、1080P档位（1920*1080/1080*1920/1440*1440/1632*1248/1248\*1632）。 可选值：`1280*720`, `720*1280`, `960*960`, `1088*832`, `832*1088`, `1920*1080`, `1080*1920`, `1440*1440`, `1632*1248`, `1248*1632` 是否添加音频。参数优先级：audio\_url > audio，仅在audio\_url为空时生效。true：默认值，自动为视频添加音频；false：不添加音频，输出无声视频。 生成视频的时长，单位为秒。可选值为5、10、15，默认值为5。duration直接影响费用，费用=单价（基于分辨率）×时长（秒），请在调用前确认模型价格。 可选值：`5`, `10`, `15` 视频生成模式。single：单镜头生成；multi：多镜头生成。 可选值：`single`, `multi` 是否添加水印标识，水印位于视频右下角，文案固定为"AI 生成"。false：默认值，不添加水印；true：添加水印。 是否开启prompt智能改写。开启后使用大模型对输入prompt进行智能改写。对于较短的prompt生成效果提升明显，但会增加耗时。true：默认值，开启智能改写；false：不开启智能改写。 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Wan 2.6 参考生视频 Source: https://docs.jiekou.ai/docs/models/reference-wan2.6-v2v POST https://api.highwayapi.ai/v3/async/wan2.6-v2v 基于 AI 的参考生视频服务，支持通过参考图片或参考视频结合文本提示生成高质量视频内容，提供专业的视频生成能力：开箱即用的 REST 推理 API，最佳性能，无冷启动，价格实惠。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 文本提示词，用来描述生成视频中期望包含的元素和视觉特点。支持中英文，每个汉字、字母、标点占一个字符，超过部分会自动截断。通过 character1、character2 等标识引用参考角色，每个参考视频或图像仅包含单一角色。 长度限制：0 - 1500 参考图像或参考视频URL数组，用于提取角色形象与音色（如有）。图像数量0～5，视频数量0～3，图像+视频总数不超过5。传入多个参考文件时，按数组顺序定义角色顺序：第1个URL对应character1，第2个对应character2，以此类推。参考视频要求：时长1s～30s，大小不超过100MB。参考图像要求：宽高均在\[240,8000]像素之间，大小不超过20MB。 数组长度：1 - 5 参考图像或参考视频URL。支持HTTP/HTTPS公网URL，也支持通过上传文件获取的OSS临时URL。图像支持JPEG、JPG、PNG（不支持透明通道）、BMP、WEBP；视频支持MP4、MOV。 反向提示词，用来描述不希望在视频画面中看到的内容，可以对视频画面进行限制。支持中英文，长度不超过500个字符，超过部分会自动截断。 长度限制：0 - 500 随机数种子。取值范围为\[0, 2147483647]。未指定时，系统自动生成随机种子。若需提升生成结果的可复现性，建议固定seed值。请注意，由于模型生成具有概率性，即使使用相同seed，也不能保证每次生成结果完全一致。 取值范围：\[0, 2147483647] 指定生成视频的分辨率，格式为宽*高。支持720P档位（1280*720/720*1280/960*960/1088*832/832*1088）、1080P档位（1920*1080/1080*1920/1440*1440/1632*1248/1248\*1632）。 可选值：`1280*720`, `720*1280`, `960*960`, `1088*832`, `832*1088`, `1920*1080`, `1080*1920`, `1440*1440`, `1632*1248`, `1248*1632` 生成视频的时长，单位为秒。可选值为5、10，默认值为5。duration直接影响费用，费用=单价（基于分辨率）×时长（秒），请在调用前确认模型价格。 可选值：`5`, `10` 视频生成模式。single：默认值，输出单镜头视频；multi：输出多镜头视频。参数优先级：shot\_type > prompt。 可选值：`single`, `multi` 是否添加水印标识，水印位于视频右下角，文案固定为"AI 生成"。false：默认值，不添加水印；true：添加水印。 是否开启prompt智能改写。开启后使用大模型对输入prompt进行智能改写。对于较短的prompt生成效果提升明显，但会增加耗时。true：默认值，开启智能改写；false：不开启智能改写。 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # 万相 Wan 2.7 图生视频 Source: https://docs.jiekou.ai/docs/models/reference-wan2.7-i2v POST https://api.highwayapi.ai/v3/async/wan2.7-i2v 万相 Wan 2.7 图生视频模型，支持多模态输入（文本/图像/音频/视频），可完成首帧生视频、首尾帧生视频、视频续写三大任务。支持720P和1080P分辨率，时长2\~15秒，按秒计费。输出默认包含音频。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机数种子，用于提升生成结果的可复现性。取值范围\[0, 2147483647]。 取值范围：\[0, 2147483647] 文本提示词，用于描述生成视频中期望包含的元素和视觉特点。支持中英文，最多5000个字符。 长度限制：0 - 5000 生成视频时长，单位为秒，按秒计费。取值范围\[2, 15]的整数。 取值范围：\[2, 15] 首帧图像URL。格式支持JPEG、JPG、PNG（不支持透明通道）、BMP、WEBP。分辨率宽高范围\[240, 8000]像素，宽高比1:8\~8:1，文件大小不超过20MB。与first\_clip\_url二选一，至少提供一个。 是否添加水印标识，水印位于视频右下角。 输出视频分辨率档位，影响费用。视频宽高比与输入素材保持一致。 可选值：`720P`, `1080P` 是否开启prompt智能改写。开启后使用大模型对输入prompt进行智能改写，对较短的prompt生成效果提升明显，但会增加耗时。 首段视频片段URL，用于视频续写。模型将基于该视频内容进行续写生成。格式支持mp4、mov，时长2~~10秒，分辨率宽高范围\[240, 4096]像素，宽高比1:8~~8:1，文件大小不超过100MB。与image\_url二选一。 尾帧图像URL。与首帧配合可生成首尾帧视频。格式限制与首帧相同。 反向提示词，用于描述不希望在视频画面中看到的内容。支持中英文，最多500个字符。 长度限制：0 - 500 驱动音频URL。传入后模型将以该音频为驱动源生成视频（如口型同步、动作卡点等）。未传入时模型将自动生成匹配的背景音乐或音效。格式支持wav、mp3，时长2\~30秒，文件大小不超过15MB。 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # 万相 Wan 2.7 文生视频 Source: https://docs.jiekou.ai/docs/models/reference-wan2.7-t2v POST https://api.highwayapi.ai/v3/async/wan2.7-t2v 万相 Wan 2.7 文生视频模型，基于文本提示词生成流畅视频。支持音频驱动或自动配音，支持720P和1080P分辨率，时长2\~15秒，按秒计费。输出默认包含音频。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机数种子，用于提升生成结果的可复现性。取值范围\[0, 2147483647]。 取值范围：\[0, 2147483647] 输出视频分辨率（宽*高），影响费用。720P档位：1280*720（16:9）、720*1280（9:16）、960*960（1:1）、1088*832（4:3）、832*1088（3:4）。1080P档位：1920*1080（16:9）、1080*1920（9:16）、1440*1440（1:1）、1632*1248（4:3）、1248\*1632（3:4）。 可选值：`1280*720`, `720*1280`, `960*960`, `1088*832`, `832*1088`, `1920*1080`, `1080*1920`, `1440*1440`, `1632*1248`, `1248*1632` 文本提示词，用于描述生成视频中期望包含的元素和视觉特点。支持中英文，最多1500个字符，超过部分自动截断。 长度限制：0 - 1500 生成视频时长，单位为秒，按秒计费。取值范围\[2, 15]的整数。 取值范围：\[2, 15] 音频文件URL，模型将使用该音频驱动视频生成（如口型同步、动作卡点等）。未传入时模型自动生成匹配的背景音乐或音效。格式支持wav、mp3，时长3\~30秒，文件不超过15MB。若音频超过视频时长则截取，不足则超出部分无声。 是否添加水印标识，水印位于视频右下角。 是否开启prompt智能改写。开启后使用大模型对输入prompt进行智能改写，对较短的prompt生成效果提升明显，但会增加耗时。 反向提示词，用于描述不希望在视频画面中出现的内容。支持中英文，最多500个字符。 长度限制：0 - 500 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # Anthropic Source: https://docs.jiekou.ai/docs/providers/anthropic ## 原生协议支持 本站所有 Anthropic 模型均可通过原生 `/v1/messages` 协议访问。比如激活 1M token 上下文，可使用如下请求 ```bash theme={null} curl https://api.highwayapi.ai/anthropic/v1/messages \ -H "x-api-key: $API_KEY" \ -H "anthropic-beta: context-1m-2025-08-07" \ -H "content-type: application/json" \ -d '{ "model": "claude-sonnet-4-20250514", "max_tokens": 1024, "messages": [ {"role": "user", "content": "Process this large document..."} ] }' ``` ## Prompt caching 本站支持通过 Anthropic 协议或 OpenAI 兼容协议使用 Prompt caching。 具体可参考文档 [模型特性 - Prompt caching](/docs/feature/prompt-caching)。 ## Extend thinking 当前仅支持通过 Anthropic 协议控制思考过程。 ```bash theme={null} curl https://api.highwayapi.ai/anthropic/v1/messages \ -H "x-api-key: $API_KEY" \ -H "content-type: application/json" \ -d \ '{ "model": "claude-sonnet-4-20250514", "max_tokens": 16000, "thinking": { "type": "enabled", "budget_tokens": 10000 }, "messages": [ { "role": "user", "content": "Are there an infinite number of prime numbers such that n mod 4 == 3?" } ] }' ``` ## Tools 暂时只支持 Bash 和 Text editor。Computer use, Web fetch, Web search 等暂不支持。 使用方式参考[官网文档](https://docs.claude.com/en/docs/agents-and-tools/tool-use)即可。 ## Claude Code 使用 参考 [第三方工具配置 - Claude Code](/docs/integration/claudecode)。 # Gemini Source: https://docs.jiekou.ai/docs/providers/gemini 平台支持使用 OpenAI chat/completions 协议和 Gemini 原生协议访问 Gemini 模型。 以下示例均使用非 Stream 模式，如需 Stream 模式，改 Path 为 /gemini/v1/models/:**streamGenerateContent** 即可。 ## 快速开始 ```bash OpenAI theme={null} curl https://api.highwayapi.ai/openai/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer " \ -d '{ "model": "gemini-2.5-flash", "messages": [{ "role": "user", "content": "What is the capital of France?" }], "reasoning_effort": "low" }' ``` ```bash Gemini theme={null} curl https://api.highwayapi.ai/gemini/v1/models/gemini-2.5-flash:generateContent \ -H "Content-Type: application/json" \ -H "Authorization: Bearer " \ -d '{ "contents": [{ "role": "user", "parts": [{"text": "What is the capital of France?"}] }], "generationConfig": { "thinkingConfig": { "thinkingBudget": 1024 } } }' ``` ## OpenAI 协议思考控制 平台会将 OpenAI chat/completions 请求的 reasoning\_effort 参数转换为 Gemini thinking 参数。 | reasoning\_effort | thinking | | ----------------- | ---------------------- | | "disable", "none" | "budget\_tokens": 0 | | "low" | "budget\_tokens": 1024 | | "medium" | "budget\_tokens": 2048 | | "high" | "budget\_tokens": 4096 | ⚠️ 非 OpenAI 标准值 disable/none 可用于关闭思考过程 ### 各模型默认设置 | 模型 | 默认设置（未设置 reasoning\_effort） | | -------------- | --------------------------- | | 2.5 Pro | 动态思考：模型决定何时以及思考多少 | | 2.5 Flash | 动态思考：模型决定何时以及思考多少 | | 2.5 Flash Lite | 思考已禁用 | ⚠️ 无法为 Gemini 2.5 Pro 禁用思考，reasoning\_effort: none 将被转换为最小 thinkingBudget 128 ⚠️ thinkingBudget 仅在 Gemini 2.5 Flash、2.5 Pro 和 2.5 Flash-Lite 中支持。根据提示的不同，模型可能会超出或低于 token 预算。 ## 服务端工具使用 ### Google Search 依托 Google Search 可将 Gemini 模型与实时网络内容相关联，并支持所有可用语言。这样一来，Gemini 就可以提供更准确的回答，并引用知识截止日期之后的可验证来源。 ```bash OpenAI theme={null} curl https://api.highwayapi.ai/openai/chat/completions \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" -d @- <" \ -H "Content-Type: application/json" -d @- < 结果示例如下，OpenAI 协议可从非标准字段 gemini\_grounding\_metadata 可获取 Grounding 信息。 ```json OpenAI theme={null} { "id": "dcc7eab10b5adeb9e8648d134e815409", "object": "chat.completion", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "Here are some of today's top news in China: ..." }, "finish_reason": "stop" } ], "gemini_grounding_metadata": { # 👈 GEMINI GROUNDING "webSearchQueries": [ "中国今日热点新闻" ], ... "groundingChunks": [ ... ] } } ``` ```json Gemini theme={null} { "candidates": [ { "content": { "role": "model", "parts": [ { "text": "根据您提供的搜索结果，以下是今日中国的一些热点新闻：..." } ] }, "finishReason": "STOP", "index": 0, "groundingMetadata": { "webSearchQueries": [ "今日中国热点新闻", "中国最新新闻头条" ], "searchEntryPoint": {...}, "groundingChunks": [...], "groundingSupports": [...] } } ] } ``` ### Code Execution Gemini 提供了一个代码执行工具，可让模型生成和运行 Python 代码。然后，模型可以根据代码执行结果进行迭代学习，直到获得最终输出。 ```bash OpenAI theme={null} curl https://api.highwayapi.ai/openai/chat/completions \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" -d @- <" \ -H "Content-Type: application/json" -d @- < 结果示例如下，对于 OpenAI 协议，代码和代码执行结果将在 content 中体现。对于 Gemini 协议，代码在 executableCode 字段， 执行结果在 codeExecutionResult 字段，总结在 text 字段。 ````markdown OpenAI theme={null} Okay, I can help you with that. I will write a Python script to find the first 50 prime numbers and then calculate their sum. Here's the plan: 1. Create a function to check if a number is prime. 2. Create a function to generate the first `n` prime numbers. 3. Call the generation function for the first 50 primes. 4. Sum the resulting list of primes. Here is the code to perform this calculation: ```PYTHON def is_prime(num): """Checks if a number is prime.""" if num <= 1: return False if num <= 3: return True if num % 2 == 0 or num % 3 == 0: return False i = 5 while i * i <= num: if num % i == 0 or num % (i + 2) == 0: return False i += 6 return True def get_first_n_primes(n): """Generates a list of the first n prime numbers.""" primes = [] num = 2 while len(primes) < n: if is_prime(num): primes.append(num) num += 1 return primes # Get the first 50 prime numbers first_50_primes = get_first_n_primes(50) # Calculate the sum of these prime numbers sum_of_primes = sum(first_50_primes) print(f"The first 50 prime numbers are: {first_50_primes}") print(f"The sum of the first 50 prime numbers is: {sum_of_primes}") ``` The first 50 prime numbers are: [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137, 139, 149, 151, 157, 163, 167, 173, 179, 181, 191, 193, 197, 199, 211, 223, 227, 229] The sum of the first 50 prime numbers is: 5117 ```` ```markdown Gemini theme={null} - executableCode: language: PYTHON code: | import sympy def is_prime(n): if n <= 1: return False if n <= 3: return True if n % 2 == 0 or n % 3 == 0: return False i = 5 while i * i <= n: if n % i == 0 or n % (i + 2) == 0: return False i += 6 return True prime_numbers = [] num = 2 while len(prime_numbers) < 50: if is_prime(num): prime_numbers.append(num) num += 1 sum_of_primes = sum(prime_numbers) print(f"The first 50 prime numbers are: {prime_numbers}") print(f"The sum of the first 50 prime numbers is: {sum_of_primes}") - codeExecutionResult: outcome: OUTCOME_OK output: > The first 50 prime numbers are: [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137, 139, 149, 151, 157, 163, 167, 173, 179, 181, 191, 193, 197, 199, 211, 223, 227, 229] The sum of the first 50 prime numbers is: 5117 - text: The sum of the first 50 prime numbers is 5117. ``` ### URL context 借助 URL context 工具，您可以网址的形式向模型提供更多上下文。 通过在请求中添加网址，模型将访问这些网页中的内容，从而为回答提供信息并提高回答质量。 ```bash OpenAI theme={null} curl https://api.highwayapi.ai/openai/chat/completions \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" -d @- <" \ -H "Content-Type: application/json" -d @- < 示例响应如下 ```json OpenAI theme={null} { "id": "82f10046aebe6697ed9d33a9fa398de4", "object": "chat.completion", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "这份食谱是关于如何制作 Ina Garten 的完美烤鸡。\n\n**关键信息：**\n* **食谱来源：** Ina Garten，改编自《Barefoot Contessa Cookbook》。\n* **准备时间：** 20 分钟\n* **烘烤时间：** 1 小时 30 分钟\n* **总时间：** 2 小时 10 分钟\n* **份量：** 8 人份\n* **难度：** 中等\n\n**食材：**\n* 一只 5-6 磅的烤鸡\n* 犹太盐\n* 新鲜磨碎的黑胡椒\n* 一大把新鲜百里香，外加 20 枝\n* 一个柠檬，对半切\n* 一头大蒜，横向切半\n* 2 汤匙（1/4 条）黄油，融化\n* 1 个大黄洋葱，厚切\n* 4 根胡萝卜，切成 2 英寸块\n* 1 个茴香头，去掉顶部，切成楔形\n* 橄榄油\n\n**制作步骤：**\n1. 预热烤箱至 425 华氏度（约 220 摄氏度）。\n2. 清理鸡的内脏，冲洗鸡的内外。去除多余的脂肪和残留的羽毛，并拍干鸡的外部。\n3. 在鸡的内部慷慨地撒上盐和胡椒。将一把百里香、半个柠檬和所有大蒜塞入鸡腔。\n4. 用融化的黄油刷鸡的外部，并再次撒上盐和胡椒。\n5. 用厨房绳子将鸡腿绑在一起，并将鸡翅尖塞到鸡身下方。\n6. 将洋葱、胡萝卜和茴香放入烤盘。用盐、胡椒、20 枝百里香和橄榄油拌匀。将蔬菜铺在烤盘底部，然后将鸡放在蔬菜上面。\n7. 烘烤鸡肉 1.5 小时，或直至用刀在腿和 thigh 之间切割时，汁水清澈。\n8. 将烤好的鸡和蔬菜移至盘子，用铝箔覆盖静置约 20 分钟。\n9. 将鸡肉切片装盘，与蔬菜一起食用。\n\n**烹饪技巧和用户反馈：**\n* 食谱中提到，如果蔬菜底部开始变褐色，可以加入一杯鸡汤帮助保持湿润。\n* 有用户建议使用更小的烤盘，以避免蔬菜烤焦。\n* 有用户将茴香替换成土豆。\n* 许多用户反馈鸡肉非常鲜嫩多汁，风味十足，而且烹饪过程简单。" }, "finish_reason": "stop" } ], "gemini_grounding_metadata": { "groundingChunks": [ { "web": { "uri": "https://www.foodnetwork.com/recipes/ina-garten/perfect-roast-chicken-recipe-1940592", "title": "Perfect Roast Chicken Recipe | Ina Garten | Food Network" } } ], "groundingSupports": [....] } } ``` ```json Gemini theme={null} { "candidates": [ { "content": { "role": "model", "parts": [ { "text": "\n这份食谱适合那些喜欢经典烤鸡的人士，特别是对于那些想要制作一道美味又相对容易的菜肴的家庭厨师来说。食谱的难度被评为“中等”，总共需要2小时10分钟（包括20分钟的准备时间，20分钟的空闲时间，以及1小时30分钟的烹饪时间）。\n\n此外，它也适合那些希望在聚会或特殊场合制作一道令人印象深刻的主菜的人士，因为烤鸡通常是节日餐桌上的亮点。\n\n食谱还提到了可以根据个人口味调整配料，例如有评论提到可以省略茴香，或者加入鸡汤来帮助 Basting，这表明它也可以适合那些喜欢在烹饪中进行尝试和调整的人。" } ] }, "finishReason": "STOP", "index": 0, "safetyRatings": null, "groundingMetadata": { "groundingChunks": [ { "web": { "uri": "https://www.foodnetwork.com/recipes/ina-garten/perfect-roast-chicken-recipe-1940592", "title": "Perfect Roast Chicken Recipe | Ina Garten | Food Network" } } ], "groundingSupports": [ { "segment": { "startIndex": 148, "endIndex": 317, "text": "食谱的难度被评为“中等”，总共需要2小时10分钟（包括20分钟的准备时间，20分钟的空闲时间，以及1小时30分钟的烹饪时间）。" }, "groundingChunkIndices": [ 0 ] }, { "segment": { "startIndex": 319, "endIndex": 475, "text": "此外，它也适合那些希望在聚会或特殊场合制作一道令人印象深刻的主菜的人士，因为烤鸡通常是节日餐桌上的亮点。" }, "groundingChunkIndices": [ 0 ] }, { "segment": { "startIndex": 477, "endIndex": 695, "text": "食谱还提到了可以根据个人口味调整配料，例如有评论提到可以省略茴香，或者加入鸡汤来帮助 Basting，这表明它也可以适合那些喜欢在烹饪中进行尝试和调整的人。" }, "groundingChunkIndices": [ 0 ] } ] } } ], "promptFeedback": { "safetyRatings": null }, "usageMetadata": { "promptTokenCount": 37, "candidatesTokenCount": 159, "totalTokenCount": 3270, "trafficType": "ON_DEMAND", "promptTokensDetails": [ { "modality": "TEXT", "tokenCount": 37 } ], "candidatesTokensDetails": [ { "modality": "TEXT", "tokenCount": 159 } ], "toolUsePromptTokensDetails": [ { "modality": "TEXT", "tokenCount": 3074 } ], "toolUsePromptTokenCount": 3074 }, "responseId": "0472efecb0da2db5f78d047e70e54db6", "modelVersion": "gemini-2.5-flash-lite" } ``` # Chat 模式 Source: https://docs.jiekou.ai/docs/cc/chat-mode “Chat 模式” 是 Cloud Code 提供的与 Claude Code 协作完成任务的方式，您可以在 “Chat 模式” 下通过聊天框与 Claude Code 协作完成任务。 ## 开始对话 确保已选中一个项目，且项目状态为 **「running」** 打开一个[会话](/docs/cc/session)，在右侧聊天框底部输入框输入你的需求 按 **Enter** 或点击 **发送按钮** Chat 模式开始会话 ## 选择模型 点击输入框上方的模型选择器，可以切换不同的模型，当前支持接口 AI 上所有提供 [兼容 Anthropic API](/docs/model/llm-anthropic-compatibility) 的大语言模型。 Chat 模式模型选择 ## 权限模式 Cloud Code 提供三种权限模式，控制 Claude Code 执行操作的方式： Claude Code 修改文件前需要你确认。适合谨慎操作的场景。 **特点：** * 每次文件修改都需要手动批准 * 可以预览更改内容后再决定 * 适合重要项目或学习 Claude Code 行为 Claude Code 可以自动执行所有操作。适合信任 AI 自主完成任务。 **特点：** * 无需手动确认，Claude Code 直接执行 * 开发效率最高 * 适合快速原型和熟悉 Claude Code 后使用 Claude Code 先制定计划，等待你批准后再执行。适合复杂任务的分步执行。 **特点：** * Claude Code 先分析任务并制定执行计划 * 你可以审查和修改计划 * 批准后按计划逐步执行 * 适合大型功能开发 ## 上传文件 你可以上传文件让 Claude 分析： 点击输入框旁的附件图标选择文件 直接拖拽文件到输入框区域 **支持的文件类型：** * 代码文件（.py, .js, .ts, .html, .css 等） * 文本文件（.txt, .md, .json 等） * 图片文件（.png, .jpg, .gif 等） Claude Code 可以分析和理解上传的内容，包括代码逻辑和图片内容。 点击上传文件 ## 查看工具调用 当 Claude Code 执行操作时，你可以看到详细的工具调用信息： * **工具名称**（如 `edit_file`、`bash`） * **输入参数** * **执行结果** * **执行时间** 点击工具调用可以展开/折叠详细信息。 查看工具调用 ### Claude Code 可用的工具 Claude Code 在 Cloud Code 中可以使用以下工具： | 工具 | 说明 | | ------------ | ------- | | `read_file` | 读取文件内容 | | `write_file` | 创建或覆盖文件 | | `edit_file` | 编辑现有文件 | | `bash` | 执行终端命令 | | `glob` | 搜索文件 | | `grep` | 搜索文件内容 | ## 控制响应 ### 停止响应 两种方式停止 Claude Code 的响应： * 点击输入框旁的 **停止** 按钮 * 按 `Esc` 键 Claude Code 会尽快停止生成，但已执行的操作不会回滚。 停止响应 ### 重新生成 如果对 Claude Code 的响应不满意，可以： 1. 编辑你的消息重新发送 2. 提供更详细的说明让 Claude Code 重新尝试 3. 创建新会话从头开始 ## 最佳实践 ### 有效的提示 明确描述你想要的功能和预期行为 告诉 Claude Code 项目背景和技术栈 复杂任务分解为小步骤逐一完成 根据结果提供反馈，让 Claude Code 改进 ### 示例：有效 vs 无效提示 | 无效提示 | 有效提示 | | -------- | ------------------------------------- | | "帮我写代码" | "创建一个 Python 函数，接受用户名和年龄，返回格式化的欢迎消息" | | "修复 bug" | "login.py 第 42 行报 TypeError，请分析原因并修复" | | "优化一下" | "这个函数处理大数组时很慢，请使用更高效的算法优化" | ## 相关文档 管理项目中的会话信息 管理项目中的文件 # 文件管理 Source: https://docs.jiekou.ai/docs/cc/files Cloud Code 支持文件管理功能，您能在 Claude Code 的工作区下查看、编辑和下载文件。 ## 查看当前工作区的文件目录 在 **Chat 模式** 下，你可以在右侧边栏查看当前工作区下的文件目录。点击右上角的 **刷新** 按钮，即可刷新展示的文件目录结构，点击 **下载** 按钮，即可下载当前整个文件夹的压缩包，点击 **折叠** 按钮，即可折叠文件目录视图。 文件树 ## 查看和编辑文件内容 在文件树中点击文件，即可查看文件内容和编辑文件。点击右上角的 **保存** 按钮，即可保存编辑后的文件内容。 查看或编辑文件内容 ## 相关文档 管理项目和文件 Chat 模式下，你可以通过对话框的形式，让 Claude Code 帮你完成任务。 # Git 集成 Source: https://docs.jiekou.ai/docs/cc/git-integration Cloud Code 内置完整的 Git 支持，您可以通过 Git 来对您的项目内容进行版本控制。 ## 配置 Git 用户信息 首次使用需要配置用户信息： 进入 **设置 > Git** 输入用户名和邮箱 点击保存按钮 ``` 用户名：Your Name 邮箱：your.email@example.com ``` 此信息用于 Git 提交记录，建议使用与 GitHub 账户相同的邮箱。 Git 用户信息配置 ## 连接远程仓库 ### 配置 GitHub 凭据 进入 **设置 > Git** 在「Git Credentials」区域点击 **+ 添加** 按钮 输入你的 GitHub Username 输入你的 GitHub Personal Access Token（点击输入框右上角 **创建 Tokens** 按钮，按照提示创建即可） 点击 **保存凭据** 按钮 如果配置成功，你会看到「Git Credentials」区域显示你的凭据信息，显示为「已激活」。 Git 凭据配置 ## 初始化 Git 仓库 点击顶部标签栏的 **源代码管理** 标签 在 GitHub 上创建一个新的空仓库 输入远程仓库地址，并点击 **绑定** 按钮，即可完成 Git 仓库的初始化 初始化成功后，你会看到「源代码管理」页面下会显示如下界面： Git 仓库列表 ## 提交更改 点击文件旁的 **+** 按钮暂存单个文件，或点击 **全部暂存** 暂存所有更改 在提交信息输入框中描述你的更改 点击 **提交** 按钮将你的更改提交到本地仓库 点击 **发布** 按钮发布你的更改到远程仓库 ## 查看历史 在 Git 面板中可以查看提交历史： * **提交列表** — 显示所有提交记录 * **提交详情** — 点击提交查看更改的文件 * **文件差异** — 查看具体的代码更改 Git 仓库提交历史 ## 通过 Claude Code 操作 Git 你可以让 Claude Code 帮你执行 Git 操作： | 请求 | Claude Code 操作 | | --------------------- | -------------- | | "提交这些更改" | 暂存文件并创建提交 | | "推送到 GitHub" | 执行 git push | | "创建新分支 feature/login" | 创建并切换分支 | | "查看提交历史" | 显示 git log | | "回滚到上一个提交" | 执行 git reset | ## 相关文档 管理项目信息 Chat 模式下，你可以通过对话框的形式，让 Claude Code 帮你完成任务。 # Cloud Code 介绍 Source: https://docs.jiekou.ai/docs/cc/introduction [Cloud Code](https://cc.jiekou.ai) 提供了一个 Claude Code 的云端沙箱运行环境，支持免安装一键启动，即可开始在**浏览器**中完整使用 Claude Code 的功能。任务在云端沙箱安全隔离运行，无需本地设备保持在线。 Cloud Code 当前提供的云端 Claude Code 环境不收取任何费用，所有费用基于您使用模型服务的消耗，您需要在接口 AI 账户中保持足够的[账户余额](https://jiekou.vip/billing)或者购买[资源包](https://jiekou.vip/resource-pack)，以便正常使用完整 Claude Code 功能。 Cloud Code 介绍 ## 功能特性 每个项目运行在隔离的沙箱环境中，无需配置本地 Claude Code 环境。 借助 接口 AI 丰富的模型库，轻松切换使用不同模型。 Chat 模式下，你可以通过对话框的形式，让 Claude Code 帮你完成任务。 Claude Code 的完整生态支持，包括 Skills / Plugins / MCP 等。 同时管理并运行多个项目，每个项目运行在隔离的沙箱环境中。 ## 适用场景 Cloud Code 借助 Claude Code 的强大能力，除了用于日常项目开发外，还适用于以下不同场景： ### 开发与原型 无需配置环境，即刻开始 Vibe Coding 在任何设备上继续处理你的任务，云端沙箱保持运行状态 ### 文档工程与内容创作 人机协作的写作模式：用户提供方向和声音，AI 负责扩写和格式化，保持长文本的上下文一致性 扫描目录结构，理解文件依赖关系，自动生成 README、API 文档或用户手册 维护一份 Markdown 母版，自动转换为 PDF、Docx、HTML、PPT 等多种格式 自动创建文件、填写元数据、生成正文，通过 Git 提交触发构建流程 ### 学术研究与知识管理 定时抓取论文，根据预设的"阅读兴趣模型"生成详细摘要简报 交叉比对多份文档，识别共同观点、分歧与趋势，生成对比表格 连接 Obsidian/Logseq 笔记库，发现潜在联系，基于现有笔记起草新文章 批量提取 PDF 元数据，统一重命名文件，维护知识库有序性 ### 市场营销与增长运营 扫描整个内容库，分析主题分布、发布频率、过时内容比例 分析高表现文章，提取共同的语气、格式和写作规则，生成品牌风格指南 用自然语言描述需求，生成包含可点击图表和过滤器的交互式 HTML 报告 批量生成广告文案，处理关键词聚类，识别内容缺口 ### 财务与战略分析 模拟不同市场环境下的预算分配方案，识别潜在资金缺口 用自然语言描述需求，生成包含复杂公式和敏感性分析的财务模型 批量提取合同金额、到期日、终止条款，生成结构化汇总表 将业务数据转化为 Pitch Deck 草稿，从零到初稿压缩至分钟级 ### 合规与行政 根据审查剧本逐条比对合同条款，生成修订建议和风险提示 语义分析候选人简历，识别隐含的软技能和项目经验，生成推荐短名单 基于模板和数据源批量生成合同、协议等标准化文档 打通日历、邮件、通讯工具，执行复杂的协调任务 ## 下一步 准备好开始了吗？ 从零开始创建你的第一个项目 # 项目管理 Source: https://docs.jiekou.ai/docs/cc/project “项目” 是 Cloud Code 的核心组织单元。每个项目对应一个独立的云端沙箱环境，拥有独立的 Claude Code 环境、文件系统等资源。 ## 创建项目 在侧边栏点击 **+ 新建项目** 按钮 输入项目名称（例如：`my-first-app`） 项目名称建议使用英文字母、数字和连字符，避免使用特殊字符。 点击 **创建项目** 按钮 my first app ## 项目状态 创建项目后，Cloud Code 会自动为该项目配置云端沙箱环境。项目会经历以下状态： | 状态 | 图标 | 说明 | | ------------ | ---------------------------------- | ------------ | | **creating** | | 正在初始化云端沙箱 | | **running** | | 沙箱已就绪，可以开始使用 | | **error** | | 沙箱运行异常，请稍后重试 | ## 管理项目 请注意：删除项目会永久删除所有文件和会话历史，此操作不可撤销。请确保已备份重要数据。 点击左侧边栏中的项目名称即可切换 点击指定项目右侧的删除图标即可删除项目 点击指定项目右侧的修改图标即可修改项目名称 ## 相关文档 管理项目中的会话 管理项目中的文件 版本控制与代码备份 # 快速上手指南 Source: https://docs.jiekou.ai/docs/cc/quickstart 本指南将帮助你快速开始使用 Cloud Code。我们将覆盖从账号登录到开始你第一个项目的基本流程。 ## 前置准备 在开始之前，你需要： Chrome、Firefox、Safari 或 Edge 用于访问接口 AI 模型服务，请确保[余额充足](https://jiekou.vip/billing)或者已购买[资源包](https://jiekou.vip/resource-pack)。 ## 第一步：登录 Cloud Code 打开 [Cloud Code 站点](https://cc.jiekou.ai) 点击【使用接口 AI 账号一键登录】按钮，系统会自动检查你是否已登录接口 AI 如果你已登录接口 AI，系统将自动完成登录。 如果你未登录，请点击【前往接口 AI 登录】，跳转至接口 AI 登录页面完成登录，登录成功后将自动跳转回 Cloud Code 并完成登录。 Cloud Code 登录 ## 第二步：创建并使用项目 登录成功后，你可以创建项目并开始使用 Claude Code 的功能。 在侧边栏点击 **+ 新建项目** 按钮，输入项目名称 系统会自动为你配置云端沙箱，等待状态变为「运行中」 在 Chat 输入框中输入你的需求，开始与 Claude Code 协作 详细的项目管理功能请参阅 [项目管理](/docs/cc/project) 文档。 Cloud Code 登录后 ## 核心功能概览 创建、管理和组织你的开发项目 管理与 Claude 的对话会话 Chat 模式下，你可以通过对话框的形式，让 Claude Code 帮你完成任务。 管理项目中的文件 内置完整的 Git 版本控制支持 ## 下一步 恭喜你完成了 Cloud Code 的基础入门！接下来建议： 掌握项目管理的功能 掌握会话管理的功能 # 会话管理 Source: https://docs.jiekou.ai/docs/cc/session “会话” 是你与 Claude Code 进行对话的容器，其概念与 Claude Code 的 Conversation History（“对话历史”）一致。每个项目可以包含多个会话，不同会话的上下文彼此隔离，适合在同一个项目中处理不同任务或主题而互不干扰。 ## 会话概述 每个会话包含： * **对话历史** — 你与 Claude Code 的对话、工具调用/命令以及关键输出结果，用于维持上下文（例如记住报错文件路径、已讨论的方案等）。 * **项目信息** — Claude Code 记住的项目相关信息。 * **工具调用记录** — Claude Code 执行任务时所有工具调用/命令及其输出结果。 会话上下文会影响 Claude Code 的响应。如果你想从头开始一个全新的任务，建议创建新会话。 ### 创建会话 在左侧边栏选择一个项目 在会话列表区域点击 **+ 新会话** 按钮 新会话创建后，即可在右侧聊天框中开始与 Claude Code 对话 创建新会话 ### 切换会话 点击会话列表中的任意会话即可切换。切换会话时： * 当前对话内容会自动保存 * 新会话的历史记录会加载显示 * Claude Code 的上下文会切换到目标会话 ### 删除会话 在会话列表中找到要删除的会话 右键点击会话或点击菜单图标 确认删除操作 删除会话会永久删除该会话的所有对话历史，此操作不可撤销。 ## 会话最佳实践 ### 何时创建新会话 * **开始新任务** — 当你要开始一个全新的、与之前无关的任务时 * **上下文过长** — 当对话变得很长，响应速度变慢时 * **重新开始** — 当 Claude Code 的理解出现偏差，需要重新开始时 * **分离关注点** — 当你想要分开管理不同功能或模块的开发时 ### 何时继续现有会话 * **迭代开发** — 在同一功能上持续迭代改进 * **错误修复** — 修复 Claude Code 之前代码或其他产出物中的错误 * **功能扩展** — 在已有实现的基础上添加新功能 * **上下文相关** — 新问题与之前的对话密切相关 ## 会话存储 会话数据存储在项目对应的云端沙箱中，具有以下特性： | 特性 | 说明 | | --------- | -------------------------- | | **自动保存** | 对话内容实时自动保存 | | **跨设备访问** | 在任何设备使用同一个 API Key 登录后都可访问 | | **项目绑定** | 会话与项目关联，删除项目会删除所有会话 | 重要的对话内容建议导出或复制到本地保存。 ## 相关文档 管理和组织你的项目 Chat 模式下，你可以通过对话框的形式，让 Claude Code 帮你完成任务。 # ElevenLabs 语音转文本 V1 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-scribe-v1 POST https://api.highwayapi.ai/v3/elevenlabs-scribe-v1 转录音频或视频文件。当 use\_multi\_channel 为 true 且上传的音频有多个声道时，返回 'transcripts' 对象，每个声道一个转录。否则返回单一转录结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 如指定，系统会尽力按确定性方式采样，相同 seed 和参数的请求应返回相同结果，但不保证绝对确定性。必须为 0 到 2147483647 之间的整数。 取值范围：\[0, 2147483647] 是否标注上传文件中当前说话者。 输入音频格式。可选 'pcm\_s16le\_16' 或 'other'。pcm\_s16le\_16 要求音频为 16kHz 采样率、16 位整型、单声道、小端格式，相较于编码波形延迟较低。 可选值：`pcm_s16le_16`, `other` 控制转录输出的随机性。取值范围 0.0 ～ 2.0，值越高结果越多样且越不确定。如省略，将使用所选模型的默认温度（通常为0）。 取值范围：\[0, 2] 上传文件中讲话者的最大数量。可用于辅助区分说话人，最多支持 32 名讲话者。 取值范围：\[1, 32] 指定音频文件的 ISO-639-1 或 ISO-639-3 语言代码。提前指出有时可提升转录表现。默认 null，将自动识别语言。 是否在转录中标记如（laughter）（footsteps）等音频事件。 待转录文件的 HTTPS 链接。file 和 cloud\_storage\_url 必须二选一。文件须可通过 HTTPS 访问且小于 2GB，支持任何合法 HTTPS 地址，包括云存储（AWS S3、GCS、Cloudflare R2 等）、CDN 或其他 HTTPS 来源，支持带 token 的预签名链接或 URL 查询参数鉴权。 音频文件是否为多声道，且每个声道仅包含单一讲话人。启用后将独立转录每个声道并合成结果，输出内容的每个单词包含 channel\_index 字段，最多支持 5 个声道。 说话人分离（diarization）阈值。值大时，一个人被分为多人的概率低，但不同人被合并为一人的概率高（识别出的讲话人较少）；值小时，一个人被分成多人的概率提高，但不同人合并为一人的概率降低（讲话人数更多）。仅当 diarize=True 且 num\_speakers=None 时可设。默认 None，会根据模型 id 选择阈值（通常 0.22）。 取值范围：\[0.1, 0.4] 转录内容中时间戳的粒度。'word' 提供单词级时间戳，'character' 提供每个字符的时间戳。 可选值：`none`, `word`, `character` ## 响应信息 响应可能为以下响应类型之一： 转录的原始文本。 单词及其时间信息列表。 该单词或声音在音频中的结束时间（秒）。 已转录的单词或声音内容。 此单词或声音的类型。'audio\_event' 用于非单词声音，如笑声或脚步声等。 可选值：`word`, `spacing`, `audio_event` 该单词或声音在音频中的起始时间（秒）。 预测该单词时的概率对数。logprob 范围为 \[-infinity, 0]，值越高表示模型预测越有信心。 构成单词的字符及其对应的时间信息。 字符在音频中的结束时间（秒）。 已转录的字符内容。 字符在音频中的起始时间（秒）。 该单词对应说话人的唯一标识。 该条转录对应的声道索引（多声道音频时有效）。 检测到的语言代码（例如 'eng' 表示英语）。 该响应的转录唯一 ID。 语言检测的置信度（0 到 1 之间）。 每个音频声道对应的转录列表。每条转录包含所属声道的文本及单词级别详细信息。 转录的原始文本。 单词及其时间信息列表。 该单词或声音在音频中的结束时间（秒）。 已转录的单词或声音内容。 此单词或声音的类型。'audio\_event' 用于非单词声音，如笑声或脚步声等。 可选值：`word`, `spacing`, `audio_event` 该单词或声音在音频中的起始时间（秒）。 预测该单词时的概率对数。logprob 范围为 \[-infinity, 0]，值越高表示模型预测越有信心。 构成单词的字符及其对应的时间信息。 字符在音频中的结束时间（秒）。 已转录的字符内容。 字符在音频中的起始时间（秒）。 该单词对应说话人的唯一标识。 该条转录对应的声道索引（多声道音频时有效）。 检测到的语言代码（例如 'eng' 表示英语）。 该响应的转录唯一 ID。 语言检测的置信度（0 到 1 之间）。 该响应的转录唯一 ID。 # ElevenLabs 语音转文本 V2 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-scribe-v2 POST https://api.highwayapi.ai/v3/elevenlabs-scribe-v2 转录音频或视频文件。当 use\_multi\_channel 为 true 且上传的音频有多个声道时，返回 'transcripts' 对象，每个声道一个转录。否则返回单一转录结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 如指定，系统会尽力按确定性方式采样，相同 seed 和参数的请求应返回相同结果，但不保证绝对确定性。必须为 0 到 2147483647 之间的整数。 取值范围：\[0, 2147483647] 是否标注上传文件中当前说话者。 输入音频格式。可选 'pcm\_s16le\_16' 或 'other'。pcm\_s16le\_16 要求音频为 16kHz 采样率、16 位整型、单声道、小端格式，相较于编码波形延迟较低。 可选值：`pcm_s16le_16`, `other` 控制转录输出的随机性。取值范围 0.0 ～ 2.0，值越高结果越多样且越不确定。如省略，将使用所选模型的默认温度（通常为0）。 取值范围：\[0, 2] 上传文件中讲话者的最大数量。可用于辅助区分说话人，最多支持 32 名讲话者。 取值范围：\[1, 32] 指定音频文件的 ISO-639-1 或 ISO-639-3 语言代码。提前指出有时可提升转录表现。默认 null，将自动识别语言。 是否在转录中标记如（laughter）（footsteps）等音频事件。 待转录文件的 HTTPS 链接。file 和 cloud\_storage\_url 必须二选一。文件须可通过 HTTPS 访问且小于 2GB，支持任何合法 HTTPS 地址，包括云存储（AWS S3、GCS、Cloudflare R2 等）、CDN 或其他 HTTPS 来源，支持带 token 的预签名链接或 URL 查询参数鉴权。 音频文件是否为多声道，且每个声道仅包含单一讲话人。启用后将独立转录每个声道并合成结果，输出内容的每个单词包含 channel\_index 字段，最多支持 5 个声道。 说话人分离（diarization）阈值。值大时，一个人被分为多人的概率低，但不同人被合并为一人的概率高（识别出的讲话人较少）；值小时，一个人被分成多人的概率提高，但不同人合并为一人的概率降低（讲话人数更多）。仅当 diarize=True 且 num\_speakers=None 时可设。默认 None，会根据模型 id 选择阈值（通常 0.22）。 取值范围：\[0.1, 0.4] 转录内容中时间戳的粒度。'word' 提供单词级时间戳，'character' 提供每个字符的时间戳。 可选值：`none`, `word`, `character` ## 响应信息 响应可能为以下响应类型之一： 转录的原始文本。 单词及其时间信息列表。 该单词或声音在音频中的结束时间（秒）。 已转录的单词或声音内容。 此单词或声音的类型。'audio\_event' 用于非单词声音，如笑声或脚步声等。 可选值：`word`, `spacing`, `audio_event` 该单词或声音在音频中的起始时间（秒）。 预测该单词时的概率对数。logprob 范围为 \[-infinity, 0]，值越高表示模型预测越有信心。 构成单词的字符及其对应的时间信息。 字符在音频中的结束时间（秒）。 已转录的字符内容。 字符在音频中的起始时间（秒）。 该单词对应说话人的唯一标识。 该条转录对应的声道索引（多声道音频时有效）。 检测到的语言代码（例如 'eng' 表示英语）。 该响应的转录唯一 ID。 语言检测的置信度（0 到 1 之间）。 每个音频声道对应的转录列表。每条转录包含所属声道的文本及单词级别详细信息。 转录的原始文本。 单词及其时间信息列表。 该单词或声音在音频中的结束时间（秒）。 已转录的单词或声音内容。 此单词或声音的类型。'audio\_event' 用于非单词声音，如笑声或脚步声等。 可选值：`word`, `spacing`, `audio_event` 该单词或声音在音频中的起始时间（秒）。 预测该单词时的概率对数。logprob 范围为 \[-infinity, 0]，值越高表示模型预测越有信心。 构成单词的字符及其对应的时间信息。 字符在音频中的结束时间（秒）。 已转录的字符内容。 字符在音频中的起始时间（秒）。 该单词对应说话人的唯一标识。 该条转录对应的声道索引（多声道音频时有效）。 检测到的语言代码（例如 'eng' 表示英语）。 该响应的转录唯一 ID。 语言检测的置信度（0 到 1 之间）。 该响应的转录唯一 ID。 # ElevenLabs 文字转语音 Flash V2 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-tts-flash-v2 POST https://api.highwayapi.ai/v3/elevenlabs-tts-flash-v2 使用您选择的声音将文本转换为语音并返回音频。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 如指定，系统将尽量有确定性地采样。相同seed及参数的重复请求应返回相同结果，但不保证完全确定性。 取值范围：\[0, 4294967295] 要转换为语音的文本。 是否开启 Stream 模式 要使用的语音ID。 当前请求文本之后的文本。用于在多次生成拼接时改善语音连贯性。 用于模型和文本规范化的语言代码（ISO 639-1）。如果模型不支持此语言代码，将返回错误。 生成音频的输出格式。格式为 codec\_sample\_rate\_bitrate。MP3的192kbps比特率需Creator及以上账户，PCM的44.1kHz采样率需Pro及以上账户。 可选值：`mp3_22050_32`, `mp3_24000_48`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `mp3_44100_128`, `mp3_44100_192`, `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_32000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`, `alaw_8000`, `opus_48000_32`, `opus_48000_64`, `opus_48000_96`, `opus_48000_128`, `opus_48000_192` 当前请求文本之前的文本。用于在多次生成拼接时改善语音连贯性。 若为true，使用IVC版本的语音而不是PVC版本。此为针对PVC版本较高延迟的临时方案。 调整语音的速度。1.0为默认速度，小于1.0会放慢语速，大于1.0会加快语速。 决定语音风格的夸张程度。尝试放大原始说话者的风格。设置为非0时会消耗更多计算资源，并可能增加延迟。 决定语音生成的稳定性与每次生成之间的随机性。较低的值会带来更宽广的情感范围，较高的值可能导致语音单调。 决定 AI 在尝试复刻原始声音时的贴合程度。 增强与原始说话者的相似度。需要稍高的计算负载，会增加延迟。 后续样本的request\_id列表。用于在重新生成样本时保持语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 当前生成之前已生成样本的request\_id列表。可用于改善语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 控制文本规范化。'auto'由系统决定，'on'总是规范化，'off'则跳过。 可选值：`auto`, `on`, `off` 控制针对某些支持语言的语言文本规范化以实现更自然发音。警告：可能大幅增加延迟。目前仅支持日语。 需要应用于文本的发音词典定位器（id, version\_id）列表。按顺序生效。每个请求最多可有3个定位器。 数组长度：0 - 3 发音词典版本的ID。如果未指定，则使用最新版本。 发音词典的ID。 ## 响应信息 生成的音频文件 格式: `binary` # ElevenLabs 文字转语音 Flash V2.5 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-tts-flash-v2.5 POST https://api.highwayapi.ai/v3/elevenlabs-tts-flash-v2.5 使用您选择的声音将文本转换为语音并返回音频。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 如指定，系统将尽量有确定性地采样。相同seed及参数的重复请求应返回相同结果，但不保证完全确定性。 取值范围：\[0, 4294967295] 要转换为语音的文本。 是否开启 Stream 模式 要使用的语音ID。 当前请求文本之后的文本。用于在多次生成拼接时改善语音连贯性。 用于模型和文本规范化的语言代码（ISO 639-1）。如果模型不支持此语言代码，将返回错误。 生成音频的输出格式。格式为 codec\_sample\_rate\_bitrate。MP3的192kbps比特率需Creator及以上账户，PCM的44.1kHz采样率需Pro及以上账户。 可选值：`mp3_22050_32`, `mp3_24000_48`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `mp3_44100_128`, `mp3_44100_192`, `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_32000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`, `alaw_8000`, `opus_48000_32`, `opus_48000_64`, `opus_48000_96`, `opus_48000_128`, `opus_48000_192` 当前请求文本之前的文本。用于在多次生成拼接时改善语音连贯性。 若为true，使用IVC版本的语音而不是PVC版本。此为针对PVC版本较高延迟的临时方案。 调整语音的速度。1.0为默认速度，小于1.0会放慢语速，大于1.0会加快语速。 决定语音风格的夸张程度。尝试放大原始说话者的风格。设置为非0时会消耗更多计算资源，并可能增加延迟。 决定语音生成的稳定性与每次生成之间的随机性。较低的值会带来更宽广的情感范围，较高的值可能导致语音单调。 决定 AI 在尝试复刻原始声音时的贴合程度。 增强与原始说话者的相似度。需要稍高的计算负载，会增加延迟。 后续样本的request\_id列表。用于在重新生成样本时保持语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 当前生成之前已生成样本的request\_id列表。可用于改善语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 控制文本规范化。'auto'由系统决定，'on'总是规范化，'off'则跳过。 可选值：`auto`, `on`, `off` 控制针对某些支持语言的语言文本规范化以实现更自然发音。警告：可能大幅增加延迟。目前仅支持日语。 需要应用于文本的发音词典定位器（id, version\_id）列表。按顺序生效。每个请求最多可有3个定位器。 数组长度：0 - 3 发音词典版本的ID。如果未指定，则使用最新版本。 发音词典的ID。 ## 响应信息 生成的音频文件 格式: `binary` # ElevenLabs 文字转语音 Multilingual V2 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-tts-multilingual-v2 POST https://api.highwayapi.ai/v3/elevenlabs-tts-multilingual-v2 使用您选择的声音将文本转换为语音并返回音频。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 如指定，系统将尽量有确定性地采样。相同seed及参数的重复请求应返回相同结果，但不保证完全确定性。 取值范围：\[0, 4294967295] 要转换为语音的文本。 要使用的语音ID。 当前请求文本之后的文本。用于在多次生成拼接时改善语音连贯性。 用于模型和文本规范化的语言代码（ISO 639-1）。如果模型不支持此语言代码，将返回错误。 生成音频的输出格式。格式为 codec\_sample\_rate\_bitrate。MP3的192kbps比特率需Creator及以上账户，PCM的44.1kHz采样率需Pro及以上账户。 可选值：`mp3_22050_32`, `mp3_24000_48`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `mp3_44100_128`, `mp3_44100_192`, `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_32000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`, `alaw_8000`, `opus_48000_32`, `opus_48000_64`, `opus_48000_96`, `opus_48000_128`, `opus_48000_192` 当前请求文本之前的文本。用于在多次生成拼接时改善语音连贯性。 若为true，使用IVC版本的语音而不是PVC版本。此为针对PVC版本较高延迟的临时方案。 调整语音的速度。1.0为默认速度，小于1.0会放慢语速，大于1.0会加快语速。 决定语音风格的夸张程度。尝试放大原始说话者的风格。设置为非0时会消耗更多计算资源，并可能增加延迟。 决定语音生成的稳定性与每次生成之间的随机性。较低的值会带来更宽广的情感范围，较高的值可能导致语音单调。 决定 AI 在尝试复刻原始声音时的贴合程度。 增强与原始说话者的相似度。需要稍高的计算负载，会增加延迟。 后续样本的request\_id列表。用于在重新生成样本时保持语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 当前生成之前已生成样本的request\_id列表。可用于改善语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 控制文本规范化。'auto'由系统决定，'on'总是规范化，'off'则跳过。 可选值：`auto`, `on`, `off` 控制针对某些支持语言的语言文本规范化以实现更自然发音。警告：可能大幅增加延迟。目前仅支持日语。 需要应用于文本的发音词典定位器（id, version\_id）列表。按顺序生效。每个请求最多可有3个定位器。 数组长度：0 - 3 发音词典版本的ID。如果未指定，则使用最新版本。 发音词典的ID。 ## 响应信息 生成的音频文件 格式: `binary` # ElevenLabs 文字转语音 Turbo v2 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-tts-turbo-v2 POST https://api.highwayapi.ai/v3/elevenlabs-tts-turbo-v2 使用您选择的声音将文本转换为语音并返回音频。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 如指定，系统将尽量有确定性地采样。相同seed及参数的重复请求应返回相同结果，但不保证完全确定性。 取值范围：\[0, 4294967295] 要转换为语音的文本。 要使用的语音ID。 当前请求文本之后的文本。用于在多次生成拼接时改善语音连贯性。 用于模型和文本规范化的语言代码（ISO 639-1）。如果模型不支持此语言代码，将返回错误。 生成音频的输出格式。格式为 codec\_sample\_rate\_bitrate。MP3的192kbps比特率需Creator及以上账户，PCM的44.1kHz采样率需Pro及以上账户。 可选值：`mp3_22050_32`, `mp3_24000_48`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `mp3_44100_128`, `mp3_44100_192`, `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_32000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`, `alaw_8000`, `opus_48000_32`, `opus_48000_64`, `opus_48000_96`, `opus_48000_128`, `opus_48000_192` 当前请求文本之前的文本。用于在多次生成拼接时改善语音连贯性。 若为true，使用IVC版本的语音而不是PVC版本。此为针对PVC版本较高延迟的临时方案。 调整语音的速度。1.0为默认速度，小于1.0会放慢语速，大于1.0会加快语速。 决定语音风格的夸张程度。尝试放大原始说话者的风格。设置为非0时会消耗更多计算资源，并可能增加延迟。 决定语音生成的稳定性与每次生成之间的随机性。较低的值会带来更宽广的情感范围，较高的值可能导致语音单调。 决定 AI 在尝试复刻原始声音时的贴合程度。 增强与原始说话者的相似度。需要稍高的计算负载，会增加延迟。 后续样本的request\_id列表。用于在重新生成样本时保持语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 当前生成之前已生成样本的request\_id列表。可用于改善语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 控制文本规范化。'auto'由系统决定，'on'总是规范化，'off'则跳过。 可选值：`auto`, `on`, `off` 控制针对某些支持语言的语言文本规范化以实现更自然发音。警告：可能大幅增加延迟。目前仅支持日语。 需要应用于文本的发音词典定位器（id, version\_id）列表。按顺序生效。每个请求最多可有3个定位器。 数组长度：0 - 3 发音词典版本的ID。如果未指定，则使用最新版本。 发音词典的ID。 ## 响应信息 生成的音频文件 格式: `binary` # ElevenLabs 文字转语音 Turbo V2.5 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-tts-turbo-v2.5 POST https://api.highwayapi.ai/v3/elevenlabs-tts-turbo-v2.5 使用您选择的声音将文本转换为语音并返回音频。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 如指定，系统将尽量有确定性地采样。相同seed及参数的重复请求应返回相同结果，但不保证完全确定性。 取值范围：\[0, 4294967295] 要转换为语音的文本。 要使用的语音ID。 当前请求文本之后的文本。用于在多次生成拼接时改善语音连贯性。 用于模型和文本规范化的语言代码（ISO 639-1）。如果模型不支持此语言代码，将返回错误。 生成音频的输出格式。格式为 codec\_sample\_rate\_bitrate。MP3的192kbps比特率需Creator及以上账户，PCM的44.1kHz采样率需Pro及以上账户。 可选值：`mp3_22050_32`, `mp3_24000_48`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `mp3_44100_128`, `mp3_44100_192`, `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_32000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`, `alaw_8000`, `opus_48000_32`, `opus_48000_64`, `opus_48000_96`, `opus_48000_128`, `opus_48000_192` 当前请求文本之前的文本。用于在多次生成拼接时改善语音连贯性。 若为true，使用IVC版本的语音而不是PVC版本。此为针对PVC版本较高延迟的临时方案。 调整语音的速度。1.0为默认速度，小于1.0会放慢语速，大于1.0会加快语速。 决定语音风格的夸张程度。尝试放大原始说话者的风格。设置为非0时会消耗更多计算资源，并可能增加延迟。 决定语音生成的稳定性与每次生成之间的随机性。较低的值会带来更宽广的情感范围，较高的值可能导致语音单调。 决定 AI 在尝试复刻原始声音时的贴合程度。 增强与原始说话者的相似度。需要稍高的计算负载，会增加延迟。 后续样本的request\_id列表。用于在重新生成样本时保持语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 当前生成之前已生成样本的request\_id列表。可用于改善语音连贯性。最多可传3个request\_id。 数组长度：0 - 3 控制文本规范化。'auto'由系统决定，'on'总是规范化，'off'则跳过。 可选值：`auto`, `on`, `off` 控制针对某些支持语言的语言文本规范化以实现更自然发音。警告：可能大幅增加延迟。目前仅支持日语。 需要应用于文本的发音词典定位器（id, version\_id）列表。按顺序生效。每个请求最多可有3个定位器。 数组长度：0 - 3 发音词典版本的ID。如果未指定，则使用最新版本。 发音词典的ID。 ## 响应信息 生成的音频文件 格式: `binary` # ElevenLabs 文字转语音 V3 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-tts-v3 POST https://api.highwayapi.ai/v3/elevenlabs-tts-v3 使用您选择的声音将文本转换为语音并返回音频。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 如指定，系统将尽量有确定性地采样。相同seed及参数的重复请求应返回相同结果，但不保证完全确定性。 取值范围：\[0, 4294967295] 要转换为语音的文本。 是否开启 Stream 模式 要使用的语音ID。 用于模型和文本规范化的语言代码（ISO 639-1）。如果模型不支持此语言代码，将返回错误。 生成音频的输出格式。格式为 codec\_sample\_rate\_bitrate。MP3的192kbps比特率需Creator及以上账户，PCM的44.1kHz采样率需Pro及以上账户。 可选值：`mp3_22050_32`, `mp3_24000_48`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `mp3_44100_128`, `mp3_44100_192`, `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_32000`, `pcm_44100`, `pcm_48000`, `ulaw_8000`, `alaw_8000`, `opus_48000_32`, `opus_48000_64`, `opus_48000_96`, `opus_48000_128`, `opus_48000_192` 若为true，使用IVC版本的语音而不是PVC版本。此为针对PVC版本较高延迟的临时方案。 调整语音的速度。1.0为默认速度，小于1.0会放慢语速，大于1.0会加快语速。 决定语音风格的夸张程度。尝试放大原始说话者的风格。设置为非0时会消耗更多计算资源，并可能增加延迟。 决定语音生成的稳定性与每次生成之间的随机性。较低的值会带来更宽广的情感范围，较高的值可能导致语音单调。 决定 AI 在尝试复刻原始声音时的贴合程度。 增强与原始说话者的相似度。需要稍高的计算负载，会增加延迟。 控制文本规范化。'auto'由系统决定，'on'总是规范化，'off'则跳过。 可选值：`auto`, `on`, `off` 控制针对某些支持语言的语言文本规范化以实现更自然发音。警告：可能大幅增加延迟。目前仅支持日语。 需要应用于文本的发音词典定位器（id, version\_id）列表。按顺序生效。每个请求最多可有3个定位器。 数组长度：0 - 3 发音词典版本的ID。如果未指定，则使用最新版本。 发音词典的ID。 ## 响应信息 生成的音频文件 格式: `binary` # Elevenlabs TTS v3 时间戳语音生成 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-tts-v3-timestamps POST https://api.highwayapi.ai/v3/elevenlabs-tts-v3-timestamps 将文本转换为语音，并返回 Base64 音频和字符级时间戳信息。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 可选的确定性生成种子，但不保证完全确定。 取值范围：\[0, 4294967295] 需要转换为语音的文本。 长度限制：1 - 无限制 用于语音生成的音色 ID。 输入文本的语言代码，模型支持显式语言选择时使用。 生成音频的输出格式，格式为 codec\_sample\_rate\_bitrate，例如 mp3\_22050\_32。部分格式可能需要账号等级支持。 可选值：`alaw_8000`, `mp3_22050_32`, `mp3_24000_48`, `mp3_44100_128`, `mp3_44100_192`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `opus_48000_128`, `opus_48000_192`, `opus_48000_32`, `opus_48000_64`, `opus_48000_96`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_32000`, `pcm_44100`, `pcm_48000`, `pcm_8000`, `ulaw_8000`, `wav_16000`, `wav_22050`, `wav_24000`, `wav_32000`, `wav_44100`, `wav_48000`, `wav_8000` 语音生成设置。留空时使用所选音色的默认配置。 控制生成语音的语速。 取值范围：\[0.7, 1.2] 控制支持该能力时的语音风格夸张程度。 取值范围：\[0, 1] 控制语音稳定性，值越高输出越一致。 取值范围：\[0, 1] 控制生成语音与所选音色的相似度。 取值范围：\[0, 1] 支持该能力时增强与说话人的相似度。 用于改善连续性的后续请求 ID，最多 3 个。 数组长度：0 - 3 用于改善连续性的历史请求 ID，最多 3 个。 数组长度：0 - 3 文本规范化模式。 可选值：`auto`, `on`, `off` 是否应用特定语言的文本规范化。 要应用的发音词典，最多 3 个。 数组长度：0 - 3 发音词典版本 ID。 发音词典 ID。 ## 响应信息 原始文本的字符级时间戳信息。 文本中的字符。 每个字符的结束时间，单位为秒。 每个字符的开始时间，单位为秒。 Base64 编码的生成音频。 规范化文本的字符级时间戳信息。 文本中的字符。 每个字符的结束时间，单位为秒。 每个字符的开始时间，单位为秒。 # ElevenLabs 音频快速复刻 Source: https://docs.jiekou.ai/docs/models/reference-elevenlabs-voice-clone POST https://api.highwayapi.ai/v3/elevenlabs-voice-clone 创建语音克隆并将其添加到您的语音库中。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 用于识别此语音的名称。此名称将显示在网站的下拉菜单中。 用于语音克隆的音频录音文件列表。 语音的序列化标签字典。 语音的描述信息。 如果设置为 true，将使用音频隔离模型从语音样本中去除背景噪音。如果样本不包含背景噪音，启用此选项可能会降低质量。 ## 响应信息 新创建语音的 ID。 该语音是否需要验证。 # Fish Audio S2 Pro Text to Speech Source: https://docs.jiekou.ai/docs/models/reference-fish-audio-s2-pro-text-to-speech POST https://api.highwayapi.ai/v3/fish-audio-s2-pro-text-to-speech Fish Audio S2 Pro 文本转语音模型，将文本转换为自然语音，支持采样控制、分段、音频格式和韵律控制。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 需要转换为语音的文本。S2-Pro 多说话人文本可使用 \<|speaker:0|>你好\<|speaker:1|>你好呀 标签。 核采样多样性控制。 取值范围：\[0, 1] 输出音频格式。 可选值：`wav`, `pcm`, `mp3`, `opus` 延迟档位。 可选值：`low`, `normal`, `balanced` 韵律控制。 语速倍率。 音量调整。 是否规范化输出响度。 对中英文文本进行规范化。 MP3 比特率，单位 kbps。 可选值：`64`, `128`, `192` 输出采样率 Hz。为空时使用格式默认值，opus 为 48000 Hz，其他通常为 44100 Hz。 表现力控制。 取值范围：\[0, 1] 文本分段大小。 取值范围：\[100, 300] Opus 比特率，单位 bps，-1000 表示自动。 可选值：`-1000`, `24000`, `32000`, `48000`, `64000` 音色模型 ID；多说话人场景可传入与 speaker 索引匹配的数组。 每个分段的最大音频 token 数。 分段前的最小字符数。 取值范围：\[0, 100] 降低音频模式重复的惩罚系数。 提前停止阈值。 取值范围：\[0, 1] 使用前序音频分段作为上下文。 ## 响应信息 生成的音频。 格式: `binary` # Fish Audio 语音合成 Source: https://docs.jiekou.ai/docs/models/reference-fish-audio-txt2speech POST https://api.highwayapi.ai/v4beta/txt2speech 为了获得最佳效果，建议在使用此 API 之前，先使用[音频复刻](/docs/models/reference-fish-audio-voice-cloning)上传参考音频。这将提高语音质量并降低延迟。 Fish Audio 将文本转换为语音。 支持的音频格式： * WAV / PCM * 采样率：8kHz, 16kHz, 24kHz, 32kHz, 44.1kHz * 默认采样率：44.1kHz * 16-bit，单声道 * MP3 * 采样率：32kHz, 44.1kHz * 默认采样率：44.1kHz * 单声道 * 比特率：64kbps, 128kbps (默认), 192kbps * Opus * 采样率：48kHz * 默认采样率：48kHz * 单声道 * 比特率：-1000 (自动), 24kbps, 32kbps (默认), 48kbps, 64kbps ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 要转换为语音的文本。 控制语音生成的随机性。较高的值（例如 1.0）使输出更随机，较低的值（例如 0.1）使其更确定。我们建议 `s1` 模型使用 `0.9`。 必需范围：`0 <= x <= 1` 通过核采样控制多样性。较低的值（例如 0.1）使输出更集中，较高的值（例如 1.0）允许更多样性。我们建议 `s1` 模型使用 `0.9`。 必需范围：`0 <= x <= 1` 用于语音的参考音频，这需要 MessagePack 序列化，这将覆盖 reference\_voices 和 reference\_texts。 参考音频文件。 与音频对应的参考文本。 用于语音的参考模型 ID。 用于语音的韵律控制。 语音速度控制。 语音音量控制。 用于语音的分块长度。 必需范围：`100 <= x <= 300` 是否规范化语音，这将降低延迟，但可能会降低对数字和日期的处理性能。 用于语音的格式。 可选值：`wav`, `pcm`, `mp3`, `opus` 用于语音的采样率。 用于语音的 MP3 比特率。 可选值：`64`, `128`, `192` 用于语音的 Opus 比特率。 可选值：`-1000`, `24`, `32`, `48`, `64` 用于语音的延迟设置，balanced 将降低延迟但可能导致性能下降。 可选值：`normal`, `balanced` ## 响应信息 API 将直接返回由 `format` 参数指定格式的音频流（默认：mp3）。 # Fish Audio 音频复刻 Source: https://docs.jiekou.ai/docs/models/reference-fish-audio-voice-cloning POST https://api.highwayapi.ai/v4beta/model Fish Audio API 用于创建语音模型（声音克隆）。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 模型类型，tts 代表文本转语音。 可选值: `tts` 允许的值: `"tts"` 模型标题或名称。 模型训练模式，对于 TTS 模型，fast 表示模型在创建后立即可用。 可选值: `fast` 允许的值: `"fast"` 上传用于调优模型的语音文件。 模型可见性，public 将显示在发现页面，unlist 允许任何拥有链接的人访问，private 仅对创建者可见。 可选值: `public`, `unlist`, `private` 模型描述。 模型封面图片，如果模型为 public，则此项为必填。 与语音对应的文本，如果未指定，将对语音执行 ASR（自动语音识别）。 模型标签。 增强音频质量。 ## 响应信息 已创建模型的唯一标识符。 模型类型。 可选值: `svc`, `tts` 模型标题或名称。 模型描述。 模型封面图片的 URL。 模型的当前状态。 可选值: `created`, `training`, `trained`, `failed` 模型标签。 模型创建时的时间戳。 模型最后更新时的时间戳。 模型可见性设置。 可选值: `public`, `unlist`, `private` 模型收到的点赞数。 模型收到的收藏/书签数。 模型被分享的次数。 与模型关联的任务数量。 模型作者的信息。 作者的唯一标识符。 作者的昵称。 作者头像图片的 URL。 模型使用的训练模式。 可选值: `fast`, `full` 与模型关联的样本数据。 样本标题。 样本的文本内容。 样本的任务标识符。 样本音频文件的 URL。 模型支持的语言。 可见性设置是否被锁定。 当前用户是否已取消点赞该模型。 当前用户是否已点赞该模型。 当前用户是否已收藏/书签该模型。 # Gemini 2.5 Flash TTS 文本转语音 Source: https://docs.jiekou.ai/docs/models/reference-gemini-2.5-flash-tts POST https://api.highwayapi.ai/v3/gemini-2.5-flash-tts 基于 Google Vertex AI generateContent 接口的 Gemini 2.5 Flash TTS。支持同步和流式单人/多人语音合成，通过自然语言提示词精确控制风格、口音、节奏、语调和情感表达。contents 字段最大 8000 字节，输出音频最长约 655 秒。Vertex AI 输出为 LINEAR16 PCM 格式（24kHz, 单声道），不包含 WAV 头。如需其他音频格式需客户端自行转换。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 角色，固定为 user 可选值：`user` 要合成为语音的文本内容。Vertex AI API 将提示词和文本合并在一个字段中，格式为 ': '，例如 'Say the following in a curious way: OK, so... tell me about this AI thing.'。总大小最多 8000 字节，超出 655 秒的音频将被截断。支持内联标记标签：\[sigh]、\[laughing]、\[uhm]、\[sarcasm]、\[robotic]、\[shouting]、\[whispering]、\[extremely fast]、\[short pause]、\[medium pause]、\[long pause] 长度限制：0 - 8000 温度参数，控制语音生成的随机性和创造性。值越高越有创意和多样性，值越低越可预测和集中。有效范围 (0.0, 2.0]，推荐值为 2.0 取值范围：\[0, 2] 单人语音配置。与 multi\_speaker\_voice\_config 二选一 预置语音名称（大小写不敏感）。可选的 30 个语音（男女声均有） 可选值：`Achernar`, `Achird`, `Algenib`, `Algieba`, `Alnilam`, `Aoede`, `Autonoe`, `Callirrhoe`, `Charon`, `Despina`, `Enceladus`, `Erinome`, `Fenrir`, `Gacrux`, `Iapetus`, `Kore`, `Laomedeia`, `Leda`, `Orus`, `Pulcherrima`, `Puck`, `Rasalgethi`, `Sadachbia`, `Sadaltager`, `Schedar`, `Sulafat`, `Umbriel`, `Vindemiatrix`, `Zephyr`, `Zubenelgenubi` 语言代码（BCP-47 格式，大小写不敏感）。可选字段；不传时将根据输入文本自动识别语言。GA 语言：ar-EG, bn-BD, nl-NL, en-IN, en-US, fr-FR, de-DE, hi-IN, id-ID, it-IT, ja-JP, ko-KR, mr-IN, pl-PL, pt-BR, ro-RO, ru-RU, es-ES, ta-IN, te-IN, th-TH, tr-TR, uk-UA, vi-VN。Preview 语言包括 cmn-CN（中文普通话）等 63 种 可选值：`af-ZA`, `am-ET`, `ar-001`, `ar-EG`, `az-AZ`, `be-BY`, `bg-BG`, `bn-BD`, `ca-ES`, `ceb-PH`, `cmn-CN`, `cmn-TW`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-AU`, `en-GB`, `en-IN`, `en-US`, `es-419`, `es-ES`, `es-MX`, `et-EE`, `eu-ES`, `fa-IR`, `fi-FI`, `fil-PH`, `fr-CA`, `fr-FR`, `gl-ES`, `gu-IN`, `he-IL`, `hi-IN`, `hr-HR`, `ht-HT`, `hu-HU`, `hy-AM`, `id-ID`, `is-IS`, `it-IT`, `ja-JP`, `jv-JV`, `ka-GE`, `kn-IN`, `ko-KR`, `kok-IN`, `la-VA`, `lb-LU`, `lo-LA`, `lt-LT`, `lv-LV`, `mai-IN`, `mg-MG`, `mk-MK`, `ml-IN`, `mn-MN`, `mr-IN`, `ms-MY`, `my-MM`, `nb-NO`, `ne-NP`, `nl-NL`, `nn-NO`, `or-IN`, `pa-IN`, `pl-PL`, `ps-AF`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sd-IN`, `si-LK`, `sk-SK`, `sl-SI`, `sq-AL`, `sr-RS`, `sv-SE`, `sw-KE`, `ta-IN`, `te-IN`, `th-TH`, `tr-TR`, `uk-UA`, `ur-PK`, `vi-VN` 多人语音配置。与 voice\_config 二选一。注意：gemini-2.5-flash-lite-preview-tts 不支持多人合成 说话人语音配置列表 说话人别名，必须仅由字母数字字符组成，不含空格。需与 contents.parts.text 中的说话人标识一致 预置语音名称（大小写不敏感）。可选的 30 个语音（男女声均有） 可选值：`Achernar`, `Achird`, `Algenib`, `Algieba`, `Alnilam`, `Aoede`, `Autonoe`, `Callirrhoe`, `Charon`, `Despina`, `Enceladus`, `Erinome`, `Fenrir`, `Gacrux`, `Iapetus`, `Kore`, `Laomedeia`, `Leda`, `Orus`, `Pulcherrima`, `Puck`, `Rasalgethi`, `Sadachbia`, `Sadaltager`, `Schedar`, `Sulafat`, `Umbriel`, `Vindemiatrix`, `Zephyr`, `Zubenelgenubi` ## 响应信息 Base64 编码的音频内容。格式为 LINEAR16 PCM（24kHz, 单声道, 16-bit signed little-endian），不包含 WAV 头。客户端可使用 ffmpeg 转换：ffmpeg -f s16le -ar 24k -ac 1 -i input.raw output.wav 总 token 数量（promptTokenCount + candidatesTokenCount） 输入文本消耗的 token 数量 输出音频消耗的 token 数量（每秒音频约 25 个 token） # MiniMax Music Source: https://docs.jiekou.ai/docs/models/reference-minimax-music POST https://api.highwayapi.ai/v3/minimax-music MiniMax AI音乐生成模型，支持通过文本描述和歌词创作AI音乐，涵盖多种音乐风格、情绪和场景 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 模型版本。music-2.5+为最新推荐版本，支持纯音乐生成；music-2.5为标准版本；music-2.0为基础版本 可选值：`music-2.5+`, `music-2.5`, `music-2.0` 歌词内容，使用\n分隔行。支持结构标签：\[Intro]、\[Verse]、\[Pre Chorus]、\[Chorus]、\[Interlude]、\[Bridge]、\[Outro]、\[Post Chorus]、\[Transition]、\[Break]、\[Hook]、\[Build Up]、\[Inst]、\[Solo] 长度限制：0 - 3500 音乐描述，用于指定音乐风格、情绪、场景等信息。当is\_instrumental为true时（music-2.5+），prompt为必填 长度限制：0 - 2000 音频参数设置 音频编码格式 可选值：`mp3`, `wav`, `pcm` 比特率 可选值：`32000`, `64000`, `128000`, `256000` 采样率 可选值：`16000`, `24000`, `32000`, `44100` 输出格式，固定为url，返回音频链接 可选值：`url` 是否在音频末尾添加AIGC水印 生成纯音乐（无人声）。仅music-2.5+支持，启用时prompt为必填 启用后，当lyrics为空时自动根据prompt生成歌词。仅music-2.5和music-2.5+支持 ## 响应信息 生成的音频列表 音频URL # MiniMax Lyrics Source: https://docs.jiekou.ai/docs/models/reference-minimax-music-lyrics POST https://api.highwayapi.ai/v3/minimax-music-lyrics MiniMax AI歌词生成模型，支持根据提示词生成完整歌词或编辑续写已有歌词，生成的歌词含结构标签可直接用于音乐生成 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 生成模式。write\_full\_song：写完整歌曲；edit：编辑/续写歌词 可选值：`write_full_song`, `edit` 歌曲标题。传入后输出将保持该标题不变 现有歌词内容，仅在edit模式下有效。可用于续写或修改已有歌词 长度限制：0 - 3500 提示词/指令，用于描述歌曲主题、风格或编辑方向。为空时随机生成 长度限制：0 - 2000 ## 响应信息 生成的歌词，包含结构标签，可直接用于音乐生成API 生成的歌名 风格标签，逗号分隔 # MiniMax Speech 2.8 HD 同步语音合成 Source: https://docs.jiekou.ai/docs/models/reference-minimax-speech-2.8-hd POST https://api.highwayapi.ai/v3/minimax-speech-2.8-hd 将文本转换为语音，支持多种音色、情绪控制、语速调节等功能。文本长度限制小于 10000 字符，若文本长度大于 3000 字符，推荐使用流式输出。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 需要合成语音的文本，长度限制小于 10000 字符，若文本长度大于 3000 字符，推荐使用流式输出。支持段落切换（换行符）、停顿控制（`<#x#>`标记）、语气词标签（如(laughs)、(coughs)等，仅 speech-2.8-hd/turbo 支持） 控制是否流式输出。默认 false，即不开启流式 音高调整（低沉/明亮），范围 \[-100, 100]，数值接近 -100，声音更低沉；接近 100，声音更明亮 取值范围：\[-100, 100] 音色调整（磁性/清脆），范围 \[-100, 100]，数值接近 -100，声音更浑厚；数值接近 100，声音更清脆 取值范围：\[-100, 100] 强度调整（力量感/柔和），范围 \[-100, 100]，数值接近 -100，声音更刚劲；接近 100，声音更轻柔 取值范围：\[-100, 100] 音效设置，单次仅能选择一种，可选值：spacious\_echo（空旷回音）、auditorium\_echo（礼堂广播）、lofi\_telephone（电话失真）、robotic（电音） 可选值：`spacious_echo`, `auditorium_echo`, `lofi_telephone`, `robotic` 生成音频的格式，wav 仅在非流式输出下支持 可选值：`mp3`, `pcm`, `flac`, `wav` 生成音频的比特率。可选范围 \[32000, 64000, 128000, 256000]，默认值为 128000。该参数仅对 mp3 格式的音频生效 可选值：`32000`, `64000`, `128000`, `256000` 生成音频的声道数。可选范围：\[1, 2]，其中 1 为单声道，2 为双声道，默认值为 1 可选值：`1`, `2` 对于音频恒定比特率（cbr）控制，可选 false、true。当此参数设置为 true，将以恒定比特率方式进行音频编码。注意：本参数仅当音频设置为流式输出，且音频格式为 mp3 时生效 生成音频的采样率。可选范围 \[8000, 16000, 22050, 24000, 32000, 44100]，默认为 32000 可选值：`8000`, `16000`, `22050`, `24000`, `32000`, `44100` 控制输出结果形式的参数，可选值范围为 url、hex，默认值为 hex。该参数仅在非流式场景生效，流式场景仅支持返回 hex 形式。返回的 url 有效期为 24 小时 可选值：`url`, `hex` 合成音频的音量，取值越大，音量越高。取值范围 (0, 10]，默认值为 1.0 取值范围：\[0, 10] 合成音频的语调，取值范围 \[-12, 12]，默认值为 0，其中 0 为原音色输出 取值范围：\[-12, 12] 合成音频的语速，取值越大，语速越快。取值范围 \[0.5, 2]，默认值为 1.0 取值范围：\[0.5, 2] 控制合成语音的情绪，参数范围分别对应 8 种情绪：高兴(happy)，悲伤(sad)，愤怒(angry)，害怕(fearful)，厌恶(disgusted)，惊讶(surprised)，中性(calm)，生动(fluent)，低语(whisper)。模型会根据输入文本自动匹配合适的情绪，一般无需手动指定 可选值：`happy`, `sad`, `angry`, `fearful`, `disgusted`, `surprised`, `calm`, `fluent`, `whisper` 合成音频的音色编号。若需要设置混合音色，请设置 timber\_weights 参数，本参数设置为空值。支持系统音色、复刻音色以及文生音色三种类型 控制是否朗读 latex 公式，默认为 false。仅支持中文，开启该参数后，language\_boost 参数会被设置为 Chinese 是否启用中文、英语文本规范化，开启后可提升数字阅读场景的性能，但会略微增加延迟，默认值为 false 控制在合成音频的末尾添加音频节奏标识，默认值为 false。该参数仅对非流式合成生效 是否增强对指定的小语种和方言的识别能力。默认值为 null，可设置为 auto 让模型自主判断 可选值：`Chinese`, `Chinese,Yue`, `English`, `Arabic`, `Russian`, `Spanish`, `French`, `Portuguese`, `German`, `Turkish`, `Dutch`, `Ukrainian`, `Vietnamese`, `Indonesian`, `Japanese`, `Italian`, `Korean`, `Thai`, `Polish`, `Romanian`, `Greek`, `Czech`, `Finnish`, `Hindi`, `Bulgarian`, `Danish`, `Hebrew`, `Malay`, `Persian`, `Slovak`, `Swedish`, `Croatian`, `Filipino`, `Hungarian`, `Norwegian`, `Slovenian`, `Catalan`, `Nynorsk`, `Tamil`, `Afrikaans`, `auto` 设置最后一个 chunk 是否包含拼接后的语音 hex 数据。默认值为 false，即最后一个 chunk 中包含拼接后的完整语音 hex 数据 混合音色设置，最多支持 4 种音色混合 合成音频各音色所占的权重，须与 voice\_id 同步填写。可选值范围为 \[1, 100]，最多支持 4 种音色混合，单一音色取值占比越高，合成音色与该音色相似度越高 取值范围：\[1, 100] 合成音频的音色编号，须和 weight 参数同步填写。支持系统音色、复刻音色以及文生音色三种类型 控制是否开启字幕服务，默认值为 false。此参数仅在非流式输出场景下有效，且仅对 speech-2.6-hd, speech-2.6-turbo, speech-01-turbo, speech-01-hd 模型有效 启用该参数，使得子句衔接处更自然，仅支持 speech-2.8-hd 和 speech-2.8-turbo 模型 定义需要特殊标注的文字或符号对应的注音或发音替换规则。在中文文本中，声调用数字表示：一声为 1，二声为 2，三声为 3，四声为 4，轻声为 5。示例：\["燕少飞/(yan4)(shao3)(fei1)", "omg/oh my god"] ## 响应信息 返回的合成数据对象，可能为 null，需进行非空判断 本次会话的 id，用于在咨询/反馈时帮助定位问题 本次请求的状态码和详情 音频的附加信息 # MiniMax Speech 2.8 HD 异步语音合成 Source: https://docs.jiekou.ai/docs/models/reference-minimax-speech-2.8-hd-async POST https://api.highwayapi.ai/v3/async/minimax-speech-2.8-hd 使用本接口，创建异步语音合成任务。支持文本或文件输入，文本长度限制最长 5 万字符，文件限制最长 10 万字符。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 待合成音频的文本，限制最长 5 万字符。和 `text_file_id` 二选一必填

• 语气词标签：仅当模型选择 `speech-2.8-hd` 或 `speech-2.8-turbo` 时，支持在文本中插入语气词标签。支持的语气词：`(laughs)`（笑声）、`(chuckle)`（轻笑）、`(coughs)`（咳嗽）、`(clear-throat)`（清嗓子）、`(groans)`（呻吟）、`(breath)`（正常换气）、`(pant)`（喘气）、`(inhale)`（吸气）、`(exhale)`（呼气）、`(gasps)`（倒吸气）、`(sniffs)`（吸鼻子）、`(sighs)`（叹气）、`(snorts)`（喷鼻息）、`(burps)`（打嗝）、`(lip-smacking)`（咂嘴）、`(humming)`（哼唱）、`(hissing)`（嘶嘶声）、`(emm)`（嗯）、`(whistles)`（口哨）、`(sneezes)`（喷嚏）、`(crying)`（抽泣）、`(applause)`（鼓掌） 待合成音频的文本文件 id，单个文件长度限制小于 10 万字符，支持的文件格式：txt、zip。和 `text` 二选一必填，传入后自动校验格式。
• **txt 文件**：长度限制 \<100000 字符。支持使用 `<#x#>` 标记自定义停顿。x 为停顿时长（单位：秒），范围 \[0.01, 99.99]，最多保留两位小数。注意停顿需设置在两个可以语音发音的文本之间，不可连续使用多个停顿标记
• **zip 文件**：
• 压缩包内需包含同一格式的 txt 或 json 文件。
• json 文件格式：支持 \[`title`, `content`, `extra`] 三个字段，分别表示标题、正文、附加信息。若三个字段都存在，则产出 3 组结果，共 9 个文件，统一存放在一个文件夹中。若某字段不存在或内容为空，则该字段不会生成对应结果 音高调整（低沉/明亮），范围 \[-100, 100]，数值接近 -100，声音更低沉；接近 100，声音更明亮 取值范围：\[-100, 100] 音色调整（磁性/清脆），范围 \[-100, 100]，数值接近 -100，声音更浑厚；数值接近 100，声音更清脆 取值范围：\[-100, 100] 强度调整（力量感/柔和），范围 \[-100, 100]，数值接近 -100，声音更刚劲；接近 100，声音更轻柔 取值范围：\[-100, 100] 音效设置，单次仅能选择一种，可选值： 1. spacious\_echo（空旷回音） 2. auditorium\_echo（礼堂广播） 3. lofi\_telephone（电话失真） 4. robotic（电音） 可选值：`spacious_echo`, `auditorium_echo`, `lofi_telephone`, `robotic` 生成音频的格式。可选范围`[mp3, pcm, flac, wav, pcmu_raw, pcmu_wav, opus]`，默认值为 `mp3`。`pcmu_raw` 与 `pcmu_wav` 为 G.711 μ-law 编码（采样率 8 kHz；`pcmu_raw` 为无文件头裸数据，`pcmu_wav` 封装在 WAV 容器中）。`opus` 为 Ogg/Opus 编码，仅支持采样率 `[8000, 12000, 16000, 24000, 48000]`，使用其他采样率会导致任务报错。 可选值：`mp3`, `pcm`, `flac`, `wav`, `pcmu_raw`, `pcmu_wav`, `opus` 生成音频的比特率。可选范围 \[32000, 64000, 128000, 256000]，默认值为 `128000`。该参数仅对 `mp3` 格式的音频生效 生成音频的声道数。可选范围：\[1, 2]，其中 `1` 为单声道，`2` 为双声道，默认值为 1 生成音频的采样率。可选范围 \[8000, 16000, 22050, 24000, 32000, 44100]，默认为 `32000` 合成音频的音量，取值越大，音量越高。取值范围 (0, 10]，默认值为 1.0 取值范围：\[0, 10] 合成音频的语调，取值范围 \[-12, 12]，默认值为 0，其中 0 为原音色输出 取值范围：\[-12, 12] 合成音频的语速，取值越大，语速越快。取值范围 \[0.5, 2]，默认值为1.0 取值范围：\[0.5, 2] 控制合成语音的情绪，参数范围 \["happy", "sad", "angry", "fearful", "disgusted", "surprised", "calm", "fluent", "whisper"]，分别对应 8 种情绪：高兴，悲伤，愤怒，害怕，厌恶，惊讶，中性，生动，低语
• 模型会根据输入文本自动匹配合适的情绪，一般无需手动指定\
• 该参数仅对 `speech-2.6-hd`, `speech-2.6-turbo`, `speech-01-hd`, `speech-01-turbo` 模型生效
• 选项 `fluent`, `whisper` 仅对 `speech-2.6-turbo`, `speech-2.6-hd` 模型生效 可选值：`happy`, `sad`, `angry`, `fearful`, `disgusted`, `surprised`, `calm`, `fluent`, `whisper` 合成音频的音色编号。若需要设置混合音色，请设置 timber\_weights 参数，本参数设置为空值。支持系统音色、复刻音色以及文生音色三种类型，以下是部分最新的系统音色（ID），可查看官方支持的全部音色
• **中文**:
• moss\_audio\_ce44fc67-7ce3-11f0-8de5-96e35d26fb85
• moss\_audio\_aaa1346a-7ce7-11f0-8e61-2e6e3c7ee85d
• Chinese (Mandarin)\_Lyrical\_Voice
• Chinese (Mandarin)\_HK\_Flight\_Attendant
• **英文**:
• English\_Graceful\_Lady
• English\_Insightful\_Speaker
• English\_radiant\_girl
• English\_Persuasive\_Man
• moss\_audio\_6dc281eb-713c-11f0-a447-9613c873494c
• moss\_audio\_570551b1-735c-11f0-b236-0adeeecad052
• moss\_audio\_ad5baf92-735f-11f0-8263-fe5a2fe98ec8
• English\_Lucky\_Robot
• **日文**:
• Japanese\_Whisper\_Belle
• moss\_audio\_24875c4a-7be4-11f0-9359-4e72c55db738
• moss\_audio\_7f4ee608-78ea-11f0-bb73-1e2a4cfcd245
• moss\_audio\_c1a6a3ac-7be6-11f0-8e8e-36b92fbb4f95 支持英语文本规范化，开启后可提升数字阅读场景的性能，但会略微增加延迟，默认 false 控制在合成音频的末尾添加音频节奏标识，默认值为 False。该参数仅对非流式合成生效 是否增强对指定的小语种和方言的识别能力。默认值为 `null`，可设置为 `auto` 让模型自主判断。 可选值：`Chinese`, `Chinese,Yue`, `English`, `Arabic`, `Russian`, `Spanish`, `French`, `Portuguese`, `German`, `Turkish`, `Dutch`, `Ukrainian`, `Vietnamese`, `Indonesian`, `Japanese`, `Italian`, `Korean`, `Thai`, `Polish`, `Romanian`, `Greek`, `Czech`, `Finnish`, `Hindi`, `Bulgarian`, `Danish`, `Hebrew`, `Malay`, `Persian`, `Slovak`, `Swedish`, `Croatian`, `Filipino`, `Hungarian`, `Norwegian`, `Slovenian`, `Catalan`, `Nynorsk`, `Tamil`, `Afrikaans`, `auto` 启用该参数，使得子句衔接处更自然，仅支持 `speech-2.8-hd` 和 `speech-2.8-turbo` 模型 定义需要特殊标注的文字或符号对应的注音或发音替换规则。在中文文本中，声调用数字表示： 一声为 `1`，二声为 `2`，三声为 `3`，四声为 `4`，轻声为 `5` 示例如下： \["燕少飞/(yan4)(shao3)(fei1)", "omg/oh my god"] ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 一些详细信息。 计费字符数 # MiniMax Speech 2.8 Turbo 同步语音合成 Source: https://docs.jiekou.ai/docs/models/reference-minimax-speech-2.8-turbo POST https://api.highwayapi.ai/v3/minimax-speech-2.8-turbo 将文本转换为语音，支持多种音色、情绪控制、语速调节等功能。文本长度限制小于 10000 字符，若文本长度大于 3000 字符，推荐使用流式输出。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 需要合成语音的文本，长度限制小于 10000 字符，若文本长度大于 3000 字符，推荐使用流式输出。支持段落切换（换行符）、停顿控制（`<#x#>`标记）、语气词标签（如(laughs)、(coughs)等，仅 speech-2.8-hd/turbo 支持） 控制是否流式输出。默认 false，即不开启流式 音高调整（低沉/明亮），范围 \[-100, 100]，数值接近 -100，声音更低沉；接近 100，声音更明亮 取值范围：\[-100, 100] 音色调整（磁性/清脆），范围 \[-100, 100]，数值接近 -100，声音更浑厚；数值接近 100，声音更清脆 取值范围：\[-100, 100] 强度调整（力量感/柔和），范围 \[-100, 100]，数值接近 -100，声音更刚劲；接近 100，声音更轻柔 取值范围：\[-100, 100] 音效设置，单次仅能选择一种，可选值：spacious\_echo（空旷回音）、auditorium\_echo（礼堂广播）、lofi\_telephone（电话失真）、robotic（电音） 可选值：`spacious_echo`, `auditorium_echo`, `lofi_telephone`, `robotic` 生成音频的格式，wav 仅在非流式输出下支持 可选值：`mp3`, `pcm`, `flac`, `wav` 生成音频的比特率。可选范围 \[32000, 64000, 128000, 256000]，默认值为 128000。该参数仅对 mp3 格式的音频生效 可选值：`32000`, `64000`, `128000`, `256000` 生成音频的声道数。可选范围：\[1, 2]，其中 1 为单声道，2 为双声道，默认值为 1 可选值：`1`, `2` 对于音频恒定比特率（cbr）控制，可选 false、true。当此参数设置为 true，将以恒定比特率方式进行音频编码。注意：本参数仅当音频设置为流式输出，且音频格式为 mp3 时生效 生成音频的采样率。可选范围 \[8000, 16000, 22050, 24000, 32000, 44100]，默认为 32000 可选值：`8000`, `16000`, `22050`, `24000`, `32000`, `44100` 控制输出结果形式的参数，可选值范围为 url、hex，默认值为 hex。该参数仅在非流式场景生效，流式场景仅支持返回 hex 形式。返回的 url 有效期为 24 小时 可选值：`url`, `hex` 合成音频的音量，取值越大，音量越高。取值范围 (0, 10]，默认值为 1.0 取值范围：\[0, 10] 合成音频的语调，取值范围 \[-12, 12]，默认值为 0，其中 0 为原音色输出 取值范围：\[-12, 12] 合成音频的语速，取值越大，语速越快。取值范围 \[0.5, 2]，默认值为 1.0 取值范围：\[0.5, 2] 控制合成语音的情绪，参数范围分别对应 8 种情绪：高兴(happy)，悲伤(sad)，愤怒(angry)，害怕(fearful)，厌恶(disgusted)，惊讶(surprised)，中性(calm)，生动(fluent)，低语(whisper)。模型会根据输入文本自动匹配合适的情绪，一般无需手动指定 可选值：`happy`, `sad`, `angry`, `fearful`, `disgusted`, `surprised`, `calm`, `fluent`, `whisper` 合成音频的音色编号。若需要设置混合音色，请设置 timber\_weights 参数，本参数设置为空值。支持系统音色、复刻音色以及文生音色三种类型 控制是否朗读 latex 公式，默认为 false。仅支持中文，开启该参数后，language\_boost 参数会被设置为 Chinese 是否启用中文、英语文本规范化，开启后可提升数字阅读场景的性能，但会略微增加延迟，默认值为 false 控制在合成音频的末尾添加音频节奏标识，默认值为 false。该参数仅对非流式合成生效 是否增强对指定的小语种和方言的识别能力。默认值为 null，可设置为 auto 让模型自主判断 可选值：`Chinese`, `Chinese,Yue`, `English`, `Arabic`, `Russian`, `Spanish`, `French`, `Portuguese`, `German`, `Turkish`, `Dutch`, `Ukrainian`, `Vietnamese`, `Indonesian`, `Japanese`, `Italian`, `Korean`, `Thai`, `Polish`, `Romanian`, `Greek`, `Czech`, `Finnish`, `Hindi`, `Bulgarian`, `Danish`, `Hebrew`, `Malay`, `Persian`, `Slovak`, `Swedish`, `Croatian`, `Filipino`, `Hungarian`, `Norwegian`, `Slovenian`, `Catalan`, `Nynorsk`, `Tamil`, `Afrikaans`, `auto` 设置最后一个 chunk 是否包含拼接后的语音 hex 数据。默认值为 false，即最后一个 chunk 中包含拼接后的完整语音 hex 数据 混合音色设置，最多支持 4 种音色混合 合成音频各音色所占的权重，须与 voice\_id 同步填写。可选值范围为 \[1, 100]，最多支持 4 种音色混合，单一音色取值占比越高，合成音色与该音色相似度越高 取值范围：\[1, 100] 合成音频的音色编号，须和 weight 参数同步填写。支持系统音色、复刻音色以及文生音色三种类型 控制是否开启字幕服务，默认值为 false。此参数仅在非流式输出场景下有效，且仅对 speech-2.6-hd, speech-2.6-turbo, speech-01-turbo, speech-01-hd 模型有效 启用该参数，使得子句衔接处更自然，仅支持 speech-2.8-hd 和 speech-2.8-turbo 模型 定义需要特殊标注的文字或符号对应的注音或发音替换规则。在中文文本中，声调用数字表示：一声为 1，二声为 2，三声为 3，四声为 4，轻声为 5。示例：\["燕少飞/(yan4)(shao3)(fei1)", "omg/oh my god"] ## 响应信息 返回的合成数据对象，可能为 null，需进行非空判断 本次会话的 id，用于在咨询/反馈时帮助定位问题 本次请求的状态码和详情 音频的附加信息 # MiniMax Speech 2.8 Turbo 异步语音合成 Source: https://docs.jiekou.ai/docs/models/reference-minimax-speech-2.8-turbo-async POST https://api.highwayapi.ai/v3/async/minimax-speech-2.8-turbo 使用本接口，创建异步语音合成任务。支持文本或文件输入，文本长度限制最长 5 万字符，文件限制最长 10 万字符。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 待合成音频的文本，限制最长 5 万字符。和 `text_file_id` 二选一必填

• 语气词标签：仅当模型选择 `speech-2.8-hd` 或 `speech-2.8-turbo` 时，支持在文本中插入语气词标签。支持的语气词：`(laughs)`（笑声）、`(chuckle)`（轻笑）、`(coughs)`（咳嗽）、`(clear-throat)`（清嗓子）、`(groans)`（呻吟）、`(breath)`（正常换气）、`(pant)`（喘气）、`(inhale)`（吸气）、`(exhale)`（呼气）、`(gasps)`（倒吸气）、`(sniffs)`（吸鼻子）、`(sighs)`（叹气）、`(snorts)`（喷鼻息）、`(burps)`（打嗝）、`(lip-smacking)`（咂嘴）、`(humming)`（哼唱）、`(hissing)`（嘶嘶声）、`(emm)`（嗯）、`(whistles)`（口哨）、`(sneezes)`（喷嚏）、`(crying)`（抽泣）、`(applause)`（鼓掌） 待合成音频的文本文件 id，单个文件长度限制小于 10 万字符，支持的文件格式：txt、zip。和 `text` 二选一必填，传入后自动校验格式。
• **txt 文件**：长度限制 \<100,000 字符。支持使用 `<#x#>` 标记自定义停顿。x 为停顿时长（单位：秒），范围 \[0.01,99.99]，最多保留两位小数。注意停顿需设置在两个可以语音发音的文本之间，不可连续使用多个停顿标记
• **zip 文件**：
• 压缩包内需包含同一格式的 txt 或 json 文件。
• json 文件格式：支持 \[`title`, `content`, `extra`] 三个字段，分别表示标题、正文、附加信息。若三个字段都存在，则产出 3 组结果，共 9 个文件，统一存放在一个文件夹中。若某字段不存在或内容为空，则该字段不会生成对应结果 音高调整（低沉/明亮），范围 \[-100, 100]，数值接近 -100，声音更低沉；接近 100，声音更明亮 取值范围：\[-100, 100] 音色调整（磁性/清脆），范围 \[-100, 100]，数值接近 -100，声音更浑厚；数值接近 100，声音更清脆 取值范围：\[-100, 100] 强度调整（力量感/柔和），范围 \[-100, 100]，数值接近 -100，声音更刚劲；接近 100，声音更轻柔 取值范围：\[-100, 100] 音效设置，单次仅能选择一种，可选值： 1. spacious\_echo（空旷回音） 2. auditorium\_echo（礼堂广播） 3. lofi\_telephone（电话失真） 4. robotic（电音） 可选值：`spacious_echo`, `auditorium_echo`, `lofi_telephone`, `robotic` 生成音频的格式。可选范围\[mp3, pcm, flac]，默认值为 `mp3` 可选值：`mp3`, `pcm`, `flac` 生成音频的比特率。可选范围 \[32000, 64000, 128000, 256000]，默认值为 `128000`。该参数仅对 `mp3` 格式的音频生效 生成音频的声道数。可选范围：\[1, 2]，其中 `1` 为单声道，`2` 为双声道，默认值为 1 生成音频的采样率。可选范围 \[8000, 16000, 22050, 24000, 32000, 44100]，默认为 `32000` 合成音频的音量，取值越大，音量越高。取值范围 (0, 10]，默认值为 1.0 取值范围：\[0, 10] 合成音频的语调，取值范围 \[-12, 12]，默认值为 0，其中 0 为原音色输出 取值范围：\[-12, 12] 合成音频的语速，取值越大，语速越快。取值范围 \[0.5, 2]，默认值为1.0 取值范围：\[0.5, 2] 控制合成语音的情绪，参数范围 \["happy", "sad", "angry", "fearful", "disgusted", "surprised", "calm", "fluent", "whisper"]，分别对应 8 种情绪：高兴，悲伤，愤怒，害怕，厌恶，惊讶，中性，生动，低语
• 模型会根据输入文本自动匹配合适的情绪，一般无需手动指定\
• 该参数仅对 `speech-2.6-hd`, `speech-2.6-turbo`, `speech-01-hd`, `speech-01-turbo` 模型生效
• 选项 `fluent`, `whisper` 仅对 `speech-2.6-turbo`, `speech-2.6-hd` 模型生效 可选值：`happy`, `sad`, `angry`, `fearful`, `disgusted`, `surprised`, `calm`, `fluent`, `whisper` 合成音频的音色编号。若需要设置混合音色，请设置 timber\_weights 参数，本参数设置为空值。支持系统音色、复刻音色以及文生音色三种类型，以下是部分最新的系统音色（ID），可查看官方支持的全部音色
• **中文**:
• moss\_audio\_ce44fc67-7ce3-11f0-8de5-96e35d26fb85
• moss\_audio\_aaa1346a-7ce7-11f0-8e61-2e6e3c7ee85d
• Chinese (Mandarin)\_Lyrical\_Voice
• Chinese (Mandarin)\_HK\_Flight\_Attendant
• 英文:
• English\_Graceful\_Lady
• English\_Insightful\_Speaker
• English\_radiant\_girl
• English\_Persuasive\_Man
• moss\_audio\_6dc281eb-713c-11f0-a447-9613c873494c
• moss\_audio\_570551b1-735c-11f0-b236-0adeeecad052
• moss\_audio\_ad5baf92-735f-11f0-8263-fe5a2fe98ec8
• English\_Lucky\_Robot
• 日文:
• Japanese\_Whisper\_Belle
• moss\_audio\_24875c4a-7be4-11f0-9359-4e72c55db738
• moss\_audio\_7f4ee608-78ea-11f0-bb73-1e2a4cfcd245
• moss\_audio\_c1a6a3ac-7be6-11f0-8e8e-36b92fbb4f95 支持英语文本规范化，开启后可提升数字阅读场景的性能，但会略微增加延迟，默认 false 控制在合成音频的末尾添加音频节奏标识，默认值为 False。该参数仅对非流式合成生效 是否增强对指定的小语种和方言的识别能力。默认值为 `null`，可设置为 `auto` 让模型自主判断。 可选值：`Chinese`, `Chinese,Yue`, `English`, `Arabic`, `Russian`, `Spanish`, `French`, `Portuguese`, `German`, `Turkish`, `Dutch`, `Ukrainian`, `Vietnamese`, `Indonesian`, `Japanese`, `Italian`, `Korean`, `Thai`, `Polish`, `Romanian`, `Greek`, `Czech`, `Finnish`, `Hindi`, `Bulgarian`, `Danish`, `Hebrew`, `Malay`, `Persian`, `Slovak`, `Swedish`, `Croatian`, `Filipino`, `Hungarian`, `Norwegian`, `Slovenian`, `Catalan`, `Nynorsk`, `Tamil`, `Afrikaans`, `auto` 启用该参数，使得子句衔接处更自然，仅支持 `speech-2.8-hd` 和 `speech-2.8-turbo` 模型 定义需要特殊标注的文字或符号对应的注音或发音替换规则。在中文文本中，声调用数字表示： 一声为 `1`，二声为 `2`，三声为 `3`，四声为 `4`，轻声为 `5` 示例如下： \["燕少飞/(yan4)(shao3)(fei1)", "omg/oh my god"] ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 一些详细信息。 计费字符数 # MiniMax 音频快速复刻 Source: https://docs.jiekou.ai/docs/models/reference-minimax-voice-cloning POST https://api.highwayapi.ai/v3/minimax-voice-cloning 本接口支持单、双声道复刻声音，支持按照指定音频文件快速复刻相同音色的语音。 本接口产出的快速复刻音色为临时音色，如您希望永久保留某复刻音色，请于 168 小时（7 天）内在任意 T2A 语音合成接口中调用该音色（不包含本接口内的试听行为）；否则，该音色将被删除。 本接口适用场景：IP 复刻、音色克隆等需要快速复刻某一音色的相关场景。 说明： * 上传的音频文件格式需为：mp3、m4a、wav 格式； * 上传的音频文件的时长最少应不低于 10 秒，最长应不超过 5 分钟； * 上传的音频文件大小需不超过 20mb。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 秘钥}}。 ## 请求体 需要复刻音色的音频文件 url。支持 mp3、m4a、wav 格式。 音色复刻参数，提供本参数将有助于增强语音合成的音色相似度和稳定性。 若使用本参数，需同时上传一小段示例音频（时长小于 8s）及音频对应文本，音频支持 mp3、m4a、wav 格式。 音频 prompt 参数，示例音频 url，时长必须小于 8s。 音频 prompt 参数，填入示例音频的对应文本，需确保和音频内容一致，句末需有标点符号做结尾。 复刻试听参数。模型将使用复刻后的音色念诵本段文本内容，并以链接的形式将音频合成结果返回，供试听复刻效果。限制 2000 字符以内。注：试听将根据字符数正常收取语音合成费用，定价与 T2A 各接口一致。 复刻试听参数。指定试听使用的语音模型，传"text"字段时必传该字段。
可选项：`speech-2.8-hd`, `speech-2.8-turbo` 音频复刻参数。取值范围\[0,1]。上传该字段会设置文本校验准确率阈值，不传时该字段值默认 0.7。 音频复刻参数。是否开启降噪。不传时默认取 false。 音频复刻参数。是否开启音量归一化。不传时默认取 false。 ## 响应信息 如果请求体中传入了试听文本 text 以及试听模型 model，那么本参数将以链接形式返回试听音频。 生成的 voice\_id # MiniMax 声音设计 Source: https://docs.jiekou.ai/docs/models/reference-minimax-voice-design POST https://api.highwayapi.ai/v3/minimax-voice-design 通过文字描述生成个性化定制声音。返回可用于 T2A 语音合成 API 的 voice\_id，以及十六进制编码的预览音频样本。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 声音描述文本，定义要生成的声音特征。 自定义声音 ID。如果不提供，系统将自动创建唯一的 voice\_id。 用于生成预览音频样本的文本，最多500个字符。 长度限制：0 - 500 ## 响应信息 生成的声音 ID，可用于 T2A 语音合成 API。 # MOSS TTS Source: https://docs.jiekou.ai/docs/models/reference-speech POST https://api.highwayapi.ai/v3/moss-tts/v1/audio/speech MOSS TTS v1.5 文本转语音 API。支持 JSON body 与 multipart(参考音频) 两种请求方式；返回完整 WAV 或流式 PCM 音频二进制。 ## 请求头 枚举值: `application/json`, `multipart/form-data` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 必填，要合成的文本。建议一次提交完整句子或段落。 必填，固定填写 MOSS-TTS，用于选择 MOSS TTS v1.5。 可选值：`MOSS-TTS` 可选，false 返回完整 WAV；true 返回 PCM 流，适合边生成边播放。 可选，非流式填 wav；stream=true 时必须填 pcm。 可选值：`wav`, `pcm` 参考音频文件字段，上传 WAV 或 MP3。 必填，字符串内容是 JSON body 字段，例如 model、input、stream、response\_format。 ## 响应信息 成功返回音频二进制。非流式为完整 WAV；流式为 raw PCM chunks。流式 PCM 通过响应头描述格式(缺省 48000Hz/单声道/16-bit little-endian)。 格式: `binary`
# 万相 Wan 2.7参考生视频 Source: https://docs.jiekou.ai/docs/models/reference-wan2.7-r2v POST https://api.highwayapi.ai/v3/async/wan2.7-r2v 万相 Wan 2.7参考生视频模型，支持多模态输入（文本/图像/视频），可将人或物体作为主角，生成单角色表演或多角色互动视频。支持智能分镜，生成多镜头视频。支持720P和1080P分辨率，时长2\~10秒，按秒计费。输出默认包含音频。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机数种子，用于提升生成结果的可复现性。取值范围\[0, 2147483647]。 取值范围：\[0, 2147483647] 输出视频分辨率（宽*高），影响费用。720P档位：1280*720（16:9）、720*1280（9:16）、960*960（1:1）、1088*832（4:3）、832*1088（3:4）。1080P档位：1920*1080（16:9）、1080*1920（9:16）、1440*1440（1:1）、1632*1248（4:3）、1248\*1632（3:4）。 可选值：`1280*720`, `720*1280`, `960*960`, `1088*832`, `832*1088`, `1920*1080`, `1080*1920`, `1440*1440`, `1632*1248`, `1248*1632` 是否生成有声视频，影响费用。默认true（有声视频）。 参考媒体数组，用于提取角色形象、动作及音色。按数组顺序对应prompt中的character1、character2等。图像数量0~~5，视频数量0~~3，总数不超过5。图像格式：JPEG、JPG、PNG、BMP、WEBP，分辨率\[240,8000]像素，不超过10MB。视频格式：MP4、MOV，时长1~~30秒，不超过100MB。音频格式：MP3、WAV、FLAC，时长3~~30秒。 数组长度：1 - 5 媒体文件URL。 媒体类型。reference\_image：参考图像，用于提取角色形象；reference\_video：参考视频，用于提取角色动作和形象；first\_frame：首帧图像，控制视频起始画面。 可选值：`reference_image`, `reference_video`, `first_frame` 角色参考音频URL，用于克隆角色音色生成有声视频。格式：MP3、WAV、FLAC，时长3\~30秒。 文本提示词，用于描述生成视频中期望包含的元素和视觉特点。通过character1、character2等标识引用参考角色，每个参考（视频或图像）仅包含单一角色。支持中英文，最多1500个字符。 长度限制：0 - 1500 生成视频时长，单位为秒，按秒计费。取值范围\[2, 10]的整数。 取值范围：\[2, 10] 镜头类型。single为单镜头（默认），multi为多镜头。参数优先级高于prompt。 可选值：`single`, `multi` 是否添加水印标识，水印位于视频右下角。 反向提示词，用于描述不希望在视频画面中出现的内容。支持中英文，最多500个字符。 长度限制：0 - 500 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # 万相 Wan 2.7 视频编辑 Source: https://docs.jiekou.ai/docs/models/reference-wan2.7-videoedit POST https://api.highwayapi.ai/v3/async/wan2.7-videoedit 万相 Wan 2.7 视频编辑模型，支持多模态输入（文本/图像/视频），可完成指令编辑和视频迁移任务。支持720P和1080P分辨率，时长2\~10秒，按秒计费。输出默认包含音频。 这是一个**异步**API，只会返回异步任务的 task\_id。您应该使用该 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成结果。 ## 请求头 枚举值: `application/json` Bearer 身份验证格式: Bearer \{\{API 密钥}}。 ## 请求体 随机数种子，用于提升生成结果的可复现性。取值范围\[0, 2147483647]。 取值范围：\[0, 2147483647] 生成视频的宽高比。不传则以输入视频的宽高比生成近似比例的视频。720P支持：16:9(1280*720)、9:16(720*1280)、1:1(960*960)、4:3(1104*832)、3:4(832*1104)。1080P支持：16:9(1920*1080)、9:16(1080*1920)、1:1(1440*1440)、4:3(1648*1248)、3:4(1248*1648)。 可选值：`16:9`, `9:16`, `1:1`, `4:3`, `3:4` 文本提示词，用于描述对视频的编辑操作。支持中英文，最多5000个字符。例如「将整个画面转换为黏土风格」「将视频中女孩的衣服替换为图片中的衣服」。 长度限制：0 - 5000 生成视频的时长，单位为秒。默认值为0，代表直接使用输入视频的时长。当传入\[2,10]之间的整数时，系统从原视频的0秒起截取至指定时长。仅在需要截断视频时才需配置。 取值范围：\[0, 10] 待编辑的视频URL。格式支持mp4、mov。时长2~~10秒，分辨率宽高范围\[240,4096]像素，宽高比1:8~~8:1，文件大小不超过100MB。 是否添加水印标识，水印位于视频右下角，文案固定为「AI生成」。 输出视频分辨率档位，影响费用（1080P > 720P）。视频宽高比与输入素材保持一致（除非指定ratio参数）。 可选值：`720P`, `1080P` 视频声音设置。auto：模型根据prompt内容智能判断，若提示词涉及声音描述可能重新生成音频，否则可能保留原声。origin：强制保留输入视频的原声。 可选值：`auto`, `origin` 是否开启prompt智能改写。开启后使用大模型对输入prompt进行智能改写，对较短的prompt生成效果提升明显，但会增加耗时。 反向提示词，用于描述不希望在视频画面中出现的内容。支持中英文，最多500个字符。 长度限制：0 - 500 参考图像URL。可用于提供编辑所需的视觉参考（如替换衣物、风格迁移等）。格式支持JPEG、JPG、PNG（不支持透明通道）、BMP、WEBP。分辨率宽高范围\[240,8000]像素，宽高比1:8\~8:1，文件大小不超过20MB。最多可传入3张参考图像。 第二张参考图像URL，格式限制同reference\_image\_url。 第三张参考图像URL，格式限制同reference\_image\_url。 ## 响应信息 使用 task\_id 请求 [查询任务结果 API](/docs/models/reference-get-async-task-result) 来检索生成的输出。 # 审计日志 Source: https://docs.jiekou.ai/docs/support/audit-log 审计日志查看和分析指南 **审计日志**记录了账号的操作行为，您可以根据需要进行查询，并审计是否存在异常操作。 1. 进入[审计日志页面](https://jiekou.vip/settings/audit-logs)。 2. 设置查询条件，单击「搜索」， 支持以下查询条件： * 日期范围：设置要查询的操作时间段。 * 成员：如果是团队账号，选择要查询的成员。 * 操作：选择要查询的操作，默认为「全部」。 * 资源：选择要查询的资源对象，默认为「全部」。 # 自动充值 Source: https://docs.jiekou.ai/docs/support/auto-top-up 启用 **“自动充值”** 后，当账户余额低于指定阈值时，系统将自动为您的账户充值。请按照以下步骤设置此功能： ### 1. 添加支付方式。 在控制台中访问 支付方式。 如果您还没有支付方式，请点击 **“添加支付方式”**。您将被重定向到 Stripe 的安全页面以添加支付方式，我们不会存储任何支付信息。 ### 2. 启用自动充值并配置设置。 在 **“自动支付”** 面板中点击 **“修改”** 以配置您的自动充值设置。 启用 **“启用自动充值”** 开关后，设置 **“当余额低于”** 和 **“将余额充值至”** 的有效值，然后点击 **“保存设置”** 以完成该过程。 # 账单管理 Source: https://docs.jiekou.ai/docs/support/bill 账单查看和管理指南 ## 计费说明 大模型 API 服务：仅支持按使用量计费。 ## 查看账单 访问 [费用明细](https://jiekou.vip/billing/details) 页面以查看详细账单信息。 # 预算管理 Source: https://docs.jiekou.ai/docs/support/budgets 预算设置和管理指南 **团队成员预算**功能允许您为每个成员设置灵活的支出限额，帮助您有效控制整体成本。 > **注意**：此功能仅适用于团队账户。个人账户或不属于团队的账户将看到菜单，但无法访问预算管理功能。您可以将个人账户转换为团队账户，或加入现有团队以与他人协作。 ## 权限 * 只有**所有者**、**管理员**和**财务管理员**可以查看和管理团队预算。 * **开发者**和**基础用户**只能查看自己的预算类型和预算限额，无法进行更改。 ## 预算控制模式 对于所有团队成员，系统根据每个成员的**预算类型**执行预算执行和重置逻辑。 ### 1. 预算类型描述 | **预算类型** | **描述** | **示例** | | :------: | :----: | :-----: | | **无限制** | 无限制 | 无限使用 | | **一次性** | 一次性预算 | 消耗后预算冻结 | ### 2. 预算类型切换 当管理员更改成员的预算类型时，系统应用以下转换规则： | **切换路径** | **处理逻辑** | | :-------- | :------------------------------- | | 无限制 → 一次性 | 新预算将立即生效，当前支出重置为零，并在新的预算周期内进行跟踪。 | | 一次性 → 无限制 | 当前配额和限制立即被丢弃，并开始无限制配额。 | ## 调整成员预算限额 请按照以下步骤调整成员的预算： 1. 访问 [**团队成员预算**](https://jiekou.vip/billing/budgets)页面。 2. 在列表中找到相关成员，或使用搜索框快速定位他们。预算可以为当前团队成员和待接受邀请的成员配置。 3. 点击“**编辑**”按钮并选择所需的预算类型。 * 新成员默认设置为**无限制**，可以随时更改。 * **一次性**预算类型允许您设置特定的预算限额。 4. 点击“**刷新**”按钮以获取最新的预算和消费数据。 > **注意**：预算更改立即生效。一旦成员的配额用尽，他们将无法发起新的服务调用。 ## 预算使用和服务调用规则 * 由成员创建的所有 API 密钥共享同一个预算池。 * 在任何服务启动之前，系统将自动检查钱包余额和成员的剩余配额。如果任一不足，请求将被拒绝。 * 达到预算限额后，所有相关任务将自动停止。 # 账户与代金券 Source: https://docs.jiekou.ai/docs/support/faq_account ## 1. 邀请 / 注册代金券如何获得？ * 新用户： * 通过邀请码完成注册并绑定 Github 后，获得 \$2 代金券 * 填写问卷后，再获得 \$1 代金券 * 老用户： * 新用户通过邀请链接或填写邀请码注册，并绑定 Github 后，老用户获得 \$1 代金券 * 受邀用户的前 5 次充值也会按一定比例给老用户发放代金券（以活动规则为准） 详细请参考活动页：[https://jiekou.vip/referral](https://jiekou.vip/referral) ## 2. 绑定 Github 后的 \$2 代金券没有到账？ 请确认： 1. 完成 Github 绑定 2. 注册时填写了邀请码（如注册时未填，可能无法获得，可联系客服补发） 3. 刷新页面或重新登录查看 4. 代金券怎么使用？ 代金券用于抵扣账户在按量计费调用模型时产生的账单费用，在有效期内会按照自动触发抵扣。 ## 4. 为什么代金券显示为 0，但我明明没用完？ 可能存在系统延迟或显示 Bug。请提供 UUID 联系客服核查。历史上有过因 Bug 导致显示异常的情况，实际余额可能仍在。 ## 5. 个人开发者有优惠政策吗？ 春节前后会推出订阅包活动，届时请关注订阅包优惠政策。 ## 6. 有包月或者包年套餐吗？ 春节前后会推出订阅包活动，届时请关注订阅包优惠政策。 *** **联系支持** 如以上 FAQ 无法解决您的问题，请通过以下方式联系技术支持： * 企业微信/微信技术支持群（推荐，响应最快） * 提供信息格式： * 问题描述 + 截图 * 账号 ID (UUID) * Trace ID（如有，通常在错误信息中） * 请求参数（脱敏后） # API 配置与技术接入 Source: https://docs.jiekou.ai/docs/support/faq_api ## 1. API 基础 URL 应该填什么？ 根据协议不同，主要有以下几种： * OpenAI 兼容格式：[https://api.highwayapi.ai/openai](https://api.highwayapi.ai/openai) 或 [https://api.highwayapi.ai/openai/v1/chat/completions](https://api.highwayapi.ai/openai/v1/chat/completions) * Anthropic 原生协议：[https://api.highwayapi.ai/anthropic](https://api.highwayapi.ai/anthropic) （用于 Claude Code 等工具） * 生图/生视频专用：[https://api.highwayapi.ai/v3/](https://api.highwayapi.ai/v3/) （如 Gemini、Nano Banana 等） 注意：如遇到 404 错误，请检查 URL 末尾是否多写了 /v1，不同工具对路径拼接逻辑不同。 ## 2. 调用时返回 401 "无效令牌" 怎么办？ 1. 确认 API Key 已正确创建：[https://jiekou.vip/settings/key-management](https://jiekou.vip/settings/key-management) 2. 确认请求头中 Authorization 格式为：Bearer sk\_xxxxxx 3. 如使用 Claude Code，环境变量应设置为 ANTHROPIC\_AUTH\_TOKEN=sk\_xxxxx（不需要加 Bearer 前缀，工具会自动添加） ## 3. 调用返回 404 "page not found" 怎么排查？ 常见原因： * URL 错误：如使用了 /v3/glm-asr 却拼写错误 * 模型路由错误：如 Codex 模型需要使用 /v1/responses 而非 /v1/chat/completions * 工具自动拼接问题：部分工具（如 cc-switch）会自动添加 /chat/completions，此时 Base URL 不应包含该路径 ## 4. 如何在 Claude Code 中配置 Jiekou.AI？ 环境变量配置如下： Windows cmd： ``` set ANTHROPIC_BASE_URL=https://api.highwayapi.ai/anthropic set ANTHROPIC_AUTH_TOKEN=sk_您的API密钥 set ANTHROPIC_MODEL=claude-opus-4-1-20250805 set ANTHROPIC_SMALL_FAST_MODEL=claude-sonnet-4-20250514 ``` Mac/Linux bash： ``` export ANTHROPIC_BASE_URL=https://api.highwayapi.ai/anthropic export ANTHROPIC_AUTH_TOKEN=sk_您的API密钥 export ANTHROPIC_MODEL=claude-opus-4-1-20250805 export ANTHROPIC_SMALL_FAST_MODEL=claude-sonnet-4-20250514 ``` 参考文档：[https://docs.jiekou.ai/docs/integration/claudecode](https://docs.jiekou.ai/docs/integration/claudecode) ## 5. Claude Code 提示强制登录/需要验证怎么解决？ 最新版 Claude Code 可能强制要求登录。解决方案： * 使用 Cline 插件替代（VSCode 插件市场搜索） * 或配合 cc-switch 等转发工具使用 ## 6. GPT-5.1 / Codex 模型如何调用？为什么返回 400 错误？ GPT-5.1 系列（包括 Codex）需要使用 OpenAI 的 Responses API，而非 Chat Completions： ``` curl "https://api.highwayapi.ai/openai/v1/responses" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer " \ -d '{ "model": "gpt-5.1-codex", "input": [...], "max_output_tokens": 64000 }' ``` ## 7. Claude 4.5 返回 "thinking block" 相关错误怎么办？ 错误通常提示：Expected 'thinking' or 'redacted\_thinking', but found 'text'。这是因为 Claude 4.5 启用 Thinking 功能后，要求上下文必须包含特定的思考块格式。建议： * 清除对话历史重新开始 * 或禁用 Thinking 功能（如不需要） * 使用原生 Anthropic 协议而非 OpenAI 兼容协议（后者对 Thinking 支持可能不完整） ## 8. 调用 Claude API 返回 "输入过长" 错误？ Claude 模型对输入长度有限制（通常 max\_tokens 最大支持 64000）。请检查： * 输入文本长度 * Base64 图片的大小（过大图片建议先压缩） * 历史对话上下文累积长度 *** **联系支持** 如以上 FAQ 无法解决您的问题，请通过以下方式联系技术支持： * 企业微信/微信技术支持群（推荐，响应最快） * 提供信息格式： * 问题描述 + 截图 * 账号 ID (UUID) * Trace ID（如有，通常在错误信息中） * 请求参数（脱敏后） # 充值与计费 Source: https://docs.jiekou.ai/docs/support/faq_billing ## 1. 充值后余额未实时到账怎么办？ 正常情况下充值是随充随到账。如遇到账延迟，请提供以下信息联系客服： * 账号 ID (UUID) * 充值订单号 (product\_xxx) * 支付截图 注：系统偶尔会出现延迟，一般会在排查后手动到账。如确认是系统问题，平台通常会发放代金券作为补偿。 ## 2. 充值比例是多少？人民币如何充值？ 充值按照美元计算，您可以通过支付宝直接充值，点击充值页面即可看到实时汇率。 ## 3. 如何避免充值失败？ 充值失败通常由两个主要原因引起： * 发卡行拒绝。 可能由于以下原因导致，请检查或联系您的发卡行了解详情： * 相应的支付通道未激活。 * 信用卡已过期或被冻结。 * 信用卡余额不足。 * 卡号不正确。 * 安全码不正确。 * 支付通道的风控措施。 请检查并进行必要的调整： * 设备 ID 关联的卡片数量过多。 * 使用此电子邮件地址拒绝的卡片数量非常高。 * 此卡在 Stripe 网络中与此设备 ID 首次出现的时间非常短。 * 与此电子邮件地址关联的授权率非常低。 * 电子邮件地址上的姓名与卡上的姓名不匹配。 ## 4. 价格是如何计算的？ 不同模型/能力按不同计费方式收取： * 大语言模型 / Embedding / Reranker： 按 token 计费，包含 input / output / cache write / cache read 等维度。 * 图片 / 视频 / 音频： 按调用次数收费。 ## 5. 如何查看详细的账单和用量？ * 账单总览：[https://jiekou.vip/billing/transactions](https://jiekou.vip/billing/transactions) * 详细用量：[https://jiekou.vip/billing/details](https://jiekou.vip/billing/details) （可查看各模型的 Token 用量明细） * 价格表：[https://jiekou.vip/pricing](https://jiekou.vip/pricing) ## 6. 为什么调用量很少却被扣了大量费用？ 请检查以下情况： * 模型选择：Claude Opus 4.5 等高端模型消耗较快（输入 11W token 可能就需 0.45 美金以上） * Token 计算：Gemini 等模型的图片输入按分辨率计算 Token，高分辨率图片可能产生大量 Token * 缓存计费：部分模型（如 Claude）的 Prompt Caching 如未命中，会以"缓存输入"价格计费，可能比普通输入更贵 ## 7. 为什么代金券/余额还有，却提示余额不足(403)？ 可能原因包括： * 账户确实费用不足（现金+代金券总和不足） * 系统计费延迟显示（实际已扣完） * 超过单分钟 RPM/TPM 限制被限流（错误提示可能显示为余额不足） ## 8. 免费模型为什么也在扣费？ 请确认是否在使用过程中切换过模型。如果在付费模型会话中切换至免费模型，可能因上下文 tokens 计算产生费用。建议检查账单详情中的模型调用记录。 ## 9. 支持退款吗？如何申请？ 一般情况下，已使用的余额不支持退款。如确需退款（如平台无法满足业务需求），请提供： * 账号 ID (UUID) * 注册邮箱 * 退款原因 注：通过第三方工具（如 Cursor）使用遇到兼容性问题通常不支持退款，建议先使用小额充值测试。 ## 10. 退款是原路返回吗？ 是的，退款会原路退回至原支付账户。如为公司充值，需与财务确认原支付渠道。 *** **联系支持** 如以上 FAQ 无法解决您的问题，请通过以下方式联系技术支持： * 企业微信/微信技术支持群（推荐，响应最快） * 提供信息格式： * 问题描述 + 截图 * 账号 ID (UUID) * Trace ID（如有，通常在错误信息中） * 请求参数（脱敏后） # 图像与视频生成 Source: https://docs.jiekou.ai/docs/support/faq_images ## 1. Nano Banana Pro 和 Light 版本有什么区别？ * Nano Banana Pro：直连官方正式版，稳定性好，支持完整功能（如参考图） * Nano Banana Pro Light：逆向/破解版本，价格便宜，但稳定性较差，某些特性不支持（如参考图功能可能失效），且可能触发内容审核（PROHIBITED\_CONTENT） 建议：生产环境建议使用非 Light 版本，测试环境可使用 Light 版本节约成本。 ## 2. 图像高清化(Upscale)接口只是放大了图片，没有变清晰？ 目前 Upscale 接口主要是通过提高分辨率实现"高清化"，并不具备 AI 重绘细节的能力。如需真正的细节增强，建议使用： * Midjourney 的 Upscale 功能（需配合 MJ 生成的图片使用） * 或其他专门的图像增强模型 ## 3. 生图接口返回 500 错误或排队时间过长？ 可能原因： * 资源紧张：高峰期（如下午、晚上）生视频/生图任务可能排队（TASK\_STATUS\_QUEUED），建议避开高峰期 * Light 版不稳定：如使用 Light 版本，可能出现间歇性失败，建议重试或改用正式版 * 内容审核：提示词触发安全审核（如 Gemini 返回 PROHIBITED\_CONTENT），请修改提示词 ## 4. 生成的图片 URL 无法访问？ 平台返回的 COS URL 是预签名链接（Presigned URL），通常可以公开访问。如无法访问请检查： * 是否在复制 URL 时截断或添加了多余字符 * 如用于微信小程序等场景，需配置 CORS（跨域）支持，平台已默认配置，如仍报错请联系客服 ## 5. Sora 2 / Veo 3.1 生成慢或失败？ 生视频属于重资源任务： * 排队正常：高峰期可能需要等待 2-30 分钟 * 任务丢失：如超过 30 分钟仍无结果且查询返回 "task not found"，可能是任务失败，建议重试 * 横竖屏问题：部分版本（如 Sora2）的横竖屏参数可能失效，建议先使用默认横屏 *** **联系支持** 如以上 FAQ 无法解决您的问题，请通过以下方式联系技术支持： * 企业微信/微信技术支持群（推荐，响应最快） * 提供信息格式： * 问题描述 + 截图 * 账号 ID (UUID) * Trace ID（如有，通常在错误信息中） * 请求参数（脱敏后） # 发票与合规 Source: https://docs.jiekou.ai/docs/support/faq_invoice ## 1. 支持开具国内发票（增值税专票/普票）吗？ 目前平台主要提供海外服务，只能提供 Invoice（形式发票），无法开具中国大陆的增值税发票。如需报销，请提供公司抬头和税号申请 Invoice。 * 进入【充值记录】，点击对应记录的 发票-下载。 * 充值后 Stripe 也会自动向您的邮箱发送 invoice 和 receipt。 ## 2. 微信小程序审核需要"第三方技术在用证明"怎么获取？ 可提供平台的备案信息截图，或访问 [https://beian.cac.gov.cn](https://beian.cac.gov.cn) 查询平台备案情况作为辅助证明。 *** **联系支持** 如以上 FAQ 无法解决您的问题，请通过以下方式联系技术支持： * 企业微信/微信技术支持群（推荐，响应最快） * 提供信息格式： * 问题描述 + 截图 * 账号 ID (UUID) * Trace ID（如有，通常在错误信息中） * 请求参数（脱敏后） # 其他常见问题 Source: https://docs.jiekou.ai/docs/support/faq_others ## 1. 对话历史记录在哪里查看？ 平台不保存用户对话数据（隐私保护原则）。如需历史记录功能，建议： * 使用第三方客户端如 ChatBox、Cherry Studio 等 * 在本地保存日志 ## 2. Prompt Caching（提示词缓存）为什么显示命中率为 0？ 请确认： 1. 使用的模型支持缓存（如 Claude 3.5 Sonnet、GPT-4o 等，GPT-5-mini 目前不支持） 2. 缓存需要预设的提示词前缀完全一致（逐字符匹配） 3. 首次调用会写入缓存（产生写入费用），后续调用才能命中 ## 3. 平台模型是代理还是自部署？ 闭源模型（如 OpenAI、Claude、Gemini）为官方 API 代理；开源模型 部分为平台自行部署。所有模型均通过统一网关提供稳定接入。 *** **联系支持** 如以上 FAQ 无法解决您的问题，请通过以下方式联系技术支持： * 企业微信/微信技术支持群（推荐，响应最快） * 提供信息格式： * 问题描述 + 截图 * 账号 ID (UUID) * Trace ID（如有，通常在错误信息中） * 请求参数（脱敏后） # 速率限制与性能 Source: https://docs.jiekou.ai/docs/support/faq_rpm ## 1. 生图/生视频模型有 RPM 限制吗？ 是的，各模型 RPM（每分钟请求数）限制不同： * Veo 3.1：约 50 RPM * Seedance：约 200 RPM * Kling：视具体模型而定 ## 2. 可以申请增加 RPM 限制吗？ 可以。允许根据使用需求灵活升级 RPM，请联系我们并告知您的需求。 ## 3. 如果实际使用未达到承诺的 RPM 会怎样？ 如果用户的实际 RPM 连续一周低于承诺水平，平台将调整速率限制，政策如下（以较低者为准）： * 将限制减少到过去一周的峰值 RPM * 恢复到模型的默认速率限制 ## 4. 返回 429 "server overload" 或 "RPM limit exceeded" 怎么办？ 这是触发了速率限制。各模型限制请参考：[https://docs.jiekou.ai/docs/model/llm-rate-limits](https://docs.jiekou.ai/docs/model/llm-rate-limits) 临时解决方案： * 降低请求频率 * 在代码中加入指数退避重试（exponential backoff） * 联系客服根据充值金额提升 RPM 配额 ## 5. 模型响应经常出现超时（Timeout）？ 特别是 Gemini 等图像编辑模型，处理时间较长（可能 1-10 分钟）。建议： * 将超时时间设置为 10 分钟以上 * 使用异步任务模式（如适用） * 避免在高峰期调用重型任务 *** **联系支持** 如以上 FAQ 无法解决您的问题，请通过以下方式联系技术支持： * 企业微信/微信技术支持群（推荐，响应最快） * 提供信息格式： * 问题描述 + 截图 * 账号 ID (UUID) * Trace ID（如有，通常在错误信息中） * 请求参数（脱敏后） # 支付方式 Source: https://docs.jiekou.ai/docs/support/payment-methods 支持的支付方式说明 JieKou.AI 使用 **Stripe** 进行所有支付处理。 您的所有支付信息都由 Stripe 安全存储，我们 **不存储** 任何支付信息。 您可以手动充值指定金额的信用，金额必须大于 \$1。此外，您可以启用[自动充值](/docs/support/auto-top-up)，当您的余额低于指定阈值时，系统将自动充值。 # 快速开始 Source: https://docs.jiekou.ai/docs/support/quickstart 接口AI 是一个一站式的大模型 API 平台，提供稳定、高效且经济的企业级 API 解决方案。 如果您有任何疑问，请先查看我们的[常见问题](/docs/support/faq_billing)，或联系我们 [support@jiekou.ai](mailto:support@jiekou.ai)。 ## 1. 登录 [接口AI](https://jiekou.vip/user/login) 您可以使用 Google 或 GitHub 认证登录，首次登录时将自动创建新账户。您也可以[使用电子邮件地址注册](https://jiekou.vip/user/register)。 ## 2. 管理 API 密钥 接口AI 使用 Bearer 认证通过请求头中的 API 密钥进行 API 访问认证，例如："Authorization: Bearer \{API Key}"。 如果您需要访问 API，可以前往[密钥管理](https://jiekou.vip/settings/key-management)设置页面创建或管理您的 API 密钥。 ## 3. 保持账户中有足够的账户余额 我们为新用户提供了一些信用额度的代金券以试用我们的产品。要添加更多信用，请访问[账单和支付](https://jiekou.vip/billing)并按照[支付方式](/docs/support/payment-methods)指南进行操作。 此外，为避免服务中断，请确保您的账户中有足够的账户余额，[设置自动充值](/docs/support/auto-top-up)是推荐的做法。 ## 4. 使用 接口AI [模型服务使用指南](/docs/model/overview) ## 5. 在 AI 编程工具中使用接口AI ### MCP（Model Context Protocol） 接口AI 提供了官方 MCP 服务，让您可以在 Cursor、Claude Desktop 等支持 MCP 的 Agent 中直接查询接口AI 文档与 API 信息。 点击页面右上角的 **MCP 安装入口**，按照引导完成一键安装，无需手动配置。 ### Skills（Agent 技能） 接口AI 提供了 [Agent Skills](https://github.com/jiekouai/jiekou-skills)，安装后可在 Agent 中直接调用接口AI 相关能力。 运行以下命令安装： ```bash theme={null} npx skills add jiekouai/jiekou-skills --skill jiekou-docs ``` # 团队管理 Source: https://docs.jiekou.ai/docs/support/team 团队创建和管理指南 通过团队功能，您可以将个人账户转换为团队账户，或加入现有团队与他人协作。 请注意，一旦您将个人账户转换为团队账户，您将无法降级回个人账户。 此外，您可以： * 邀请其他用户加入您的团队，并与他们共享团队资源； * 通过分配不同的角色来管理成员对团队资源的权限； * 分析每个团队成员的使用数据。 ## 升级为团队账户 默认情况下，您的账户是个人账户。要将个人账户转换为团队账户，请前往[团队设置](https://jiekou.vip/settings/team)，点击**升级为团队账户**按钮，并按照说明完成升级。 ## 角色 角色是一组权限，定义了成员在团队中可以执行的操作。一个团队中有 5 种角色： **所有者** 所有者成员拥有与管理员成员相同的权限。所有者是创建团队的成员。这是一个特殊角色，每个团队只能有一个所有者。 **管理员** 管理员成员可以编辑任何 JieKou AI 设置、进行购买、更新账单和管理成员资格。他们还可以撤销其他超级管理员的访问权限。 **开发者** 开发者成员可以访问完整的账户资源，但不包括成员管理和账单。 **基础用户** 基础用户只能访问他们个人创建的资源，无法查看或管理其他团队成员创建的资源。 **财务管理员** 财务管理员可以管理所有与账单相关的功能，包括处理付款、查看发票和管理订阅。 有关角色权限的详细信息，请访问：[角色权限](https://jiekou.vip/team-permission-details)。 ## 邀请成员 一旦您升级为团队账户，您可以通过点击[团队设置](https://jiekou.vip/settings/team)中的**邀请成员**按钮邀请其他用户加入您的团队。 **请注意：** * 目前，您最多可以邀请50名成员加入您的团队。 * 每个成员需要被分配一个角色以访问团队的资源。 * 您输入的电子邮件地址将用于向成员发送邀请链接。成员可以在使用一致的电子邮件地址登录 JieKou AI 后加入团队。 ## 管理成员 在[团队设置](https://jiekou.vip/settings/team)中，您可以管理团队成员或待处理的邀请。 ### 编辑成员角色 要编辑成员的角色，请点击成员行右侧的**设置图标**，然后点击**编辑**按钮并按照说明更改角色。 请注意，角色更改后，成员需要重新登录 JieKou AI 以使新角色生效。 ### 移除成员 要从团队中移除活跃成员，请点击目标成员行右侧的**设置图标**，然后点击**移除**按钮，会显示一个确认对话框。点击**移除**以确认移除。 ### 取消待处理邀请 要取消待处理的邀请，请点击成员行右侧的**设置图标**，然后点击**取消邀请**按钮，会显示一个确认对话框。点击**确认**以确认取消。 ## 审计日志 审计日志提供了团队内执行的重要资源操作的详细记录，可用于跟踪团队成员的活动。目前，只有所有者和管理员成员可以查看审计日志。 要查看审计日志，请前往[团队设置](https://jiekou.vip/settings/team)。