chenyme / grok2api

Grok2API **中文** | English | 文档 > [!NOTE] > 本项目仅供学习与研究，使用者必须在遵循 Grok 的 **使用条款** 以及 **法律法规** 的情况下使用，不得用于非法用途。 > [!NOTE] > 开源项目欢迎大家支持二开和PR，但请保留原作者标识和前端标识，尊重他人劳动成果～！ 基于 **FastAPI** 重构的 Grok2API，全面适配最新 Web 调用格式，支持流/非流式对话、工具调用、图像生成/编辑、视频生成/超分（文生视频 / 图生视频）、深度思考，号池并发与自动负载均衡一体化。 快速开始 > 文档 本地开发 Docker Compose > Docker Compose 端口变量： > > - ：容器内应用监听端口 > - ：宿主机映射端口（仅 Docker Compose 使用） > > 小贴士：端口映射规则是 ，你访问的是 ，容器内服务实际监听的是 。 > > 示例： ，访问 。 Vercel 部署 > 请务必设置 并关闭文件日志 。 > > 持久化请使用 MySQL / Redis / PostgreSQL，并设置： 与 。 Render 部署 > Render 免费实例 15 分钟无访问会休眠；重启/重新部署会丢失数据。 > > 持久化请使用 MySQL / Redis / PostgreSQL，并设置： 与 。 管理面板 • 访问地址： （本地运行使用 ，Docker Compose 使用 ，默认均为 ） • 默认密码： （配置项 ，建议修改） **功能说明**： • **Token 管理**：导入/添加/删除 Token，查看状态和配额 • **状态筛选**：按状态（正常/限流/失效）或 NSFW 状态筛选 • **批量操作**：批量刷新、导出、删除、开启 NSFW • **NSFW 开启**：一键为 Token 开启 Unhinged 模式（需代理或 ） • **配置管理**：在线修改系统配置 • **缓存管理**：查看和清理媒体缓存 环境变量 > 配置 文件 | 变量名 | 说明 | 默认值 | 示例 | | :-- | :-- | :-- | :-- | | | 日志级别 | | | | | 是否启用文件日志 | | | | | 数据目录（配置/Token/锁） | | | | | 服务监听地址 | | | | | 服务端口 | | | | | Docker Compose 宿主机映射端口 | | | | | 服务进程数量 | | | | | 存储类型（ / / / ） | | | | | 存储连接串（local 时可为空） | | | > MySQL 示例： （若填 会自动转为 ） 可用次数 • Basic 账号：80 次 / 20h • Super 账号：140 次 / 2h 可用模型 | 模型名 | 计次 | 可用账号 | 对话功能 | 图像功能 | 视频功能 | | :-- | :--: | :-- | :--: | :--: | :--: | | | 1 | Basic/Super | 支持 | 支持 | - | | | 1 | Basic/Super | 支持 | 支持 | - | | | 1 | Basic/Super | 支持 | 支持 | - | | | 1 | Basic/Super | 支持 | 支持 | - | | | 1 | Basic/Super | 支持 | 支持 | - | | | 4 | Super | 支持 | 支持 | - | | | 1 | Basic/Super | 支持 | 支持 | - | | | 1 | Basic/Super | 支持 | 支持 | - | | | 4 | Basic/Super | 支持 | 支持 | - | | | 4 | Basic/Super | 支持 | 支持 | - | | | 1 | Basic/Super | 支持 | 支持 | - | | | - | Basic/Super | - | 支持 | - | | | - | Basic/Super | - | 支持 | - | | | - | Basic/Super | - | 支持 | - | | | - | Basic/Super | - | - | 支持 | 接口说明 > 以下示例默认使用 ；若 Docker Compose 设置了 ，请替换为对应端口。 > 通用接口，支持对话聊天、图像生成、图像编辑、视频生成、视频超分 支持的请求参数 | 字段 | 类型 | 说明 | 可用参数 | | :-- | :-- | :-- | :-- | | | string | 模型名称 | 见上方模型列表 | | | array | 消息列表 | 见下方消息格式 | | | boolean | 是否开启流式输出 | , | | | string | 推理强度 | , , , , , | | | number | 采样温度 | ~ | | | number | nucleus 采样 | ~ | | | array | 工具定义 | OpenAI function tools | | | string/object | 工具选择 | , , 或指定工具 | | | boolean | 是否允许并行工具调用 | , | | | object | **视频模型专用配置对象** | 支持： | | └─ | string | 视频宽高比 | , , , , , , , , , | | └─ | integer | 视频时长 (秒) | ~ | | └─ | string | 分辨率 | , | | └─ | string | 风格预设 | , , , | | | object | **图片模型专用配置对象** | 支持： / / | | └─ | integer | 生成数量 | ~ | | └─ | string | 图片尺寸 | , , , , | | └─ | string | 响应格式 | , , | **消息格式 (messages)**： | 字段 | 类型 | 说明 | | :-- | :-- | :-- | | | string | 角色： , , , | | | string/array | 消息内容，支持纯文本或多模态数组 | **多模态内容块类型 (content array)**： | type | 说明 | 示例 | | :-- | :-- | :-- | | | 文本内容 | | | | 图片 URL | | | | 音频 | | | | 文件 | | **注意事项**： • 仅支持 URL 或 Data URI（ ），裸 base64 会报错。 • ： 表示不输出思考，其他值都会输出思考内容。 • 工具调用为**提示词模拟 + 客户端执行回填**：模型通过 输出调用请求，服务端解析为 ；不执行工具。 • 与瀑布流 imagine 生成链路一致，可直接通过 调用；其 由服务端 统一控制。 • 在 的流式输出仅返回最终成图，不返回中间预览图。 • 流式 URL 出图会保持原始图片名（不追加 后缀）。 • 当图片疑似被审查拦截导致无最终图时，若开启 ，服务端会按 自动并行补偿生成，并优先使用不同 token；若仍无满足 的最终图则返回失败。 • 必须提供图片，多图默认取**最后 3 张**与最后一个文本。 • 支持文生视频与多图参考视频：可通过多个 传最多 张参考图，并在文本中使用 、 这类占位符；服务端会自动替换为对应 。 • 与 的顺序一一对应；若引用了不存在的图片序号，会直接报错。 • 除上述外的其他参数将自动丢弃并忽略。 > OpenAI Responses API 兼容接口 支持的请求参数 | 字段 | 类型 | 说明 | | :-- | :-- | :-- | | | string | 模型名称 | | | string/array | 输入内容，支持字符串、消息数组或多模态内容块 | | | string | 系统指令 | | | boolean | 是否流式输出 | | | number | 采样温度 | | | number | nucleus 采样 | | | array | 工具定义（支持 function 工具；内置工具类型见下方说明） | | | string/object | 工具选择（auto/required/none 或指定工具） | | | boolean | 是否允许并行工具调用 | | | object | 推理参数 | | └─ | string | 推理强度 | , , , , , | **注意事项**： • 内置工具 / / 目前会映射为 function tool **触发调用**，但**不执行托管工具**，需客户端自行执行并回填。 • 流式输出会包含 与 事件。 > 图像生成接口 支持的请求参数 | 字段 | 类型 | 说明 | 可用参数 | | :-- | :-- | :-- | :-- | | | string | 图像模型名 | | | | string | 图像描述提示词 | - | | | integer | 生成数量 | - (流式模式仅限 或 ) | | | boolean | 是否开启流式输出 | , | | | string | 图片尺寸 | , , , , | | | string | 图片质量 | - (暂不支持) | | | string | 响应格式 | , , | | | string | 风格 | - (暂不支持) | **注意事项**： • 、 参数为 OpenAI 兼容保留，当前版本暂不支持自定义。 • 多图编辑若传入超过 3 张，仅取**最后 3 张**作为参考。 > 图像编辑接口（multipart/form-data） 支持的请求参数 | 字段 | 类型 | 说明 | 可用参数 | | :-- | :-- | :-- | :-- | | | string | 图像模型名 | | | | string | 编辑描述 | - | | | file | 待编辑图片 | , , | | | integer | 生成数量 | - (流式模式仅限 或 ) | | | boolean | 是否开启流式输出 | , | | | string | 图片尺寸 | , , , , | | | string | 图片质量 | - (暂不支持) | | | string | 响应格式 | , , | | | string | 风格 | - (暂不支持) | **注意事项**： • 、 参数为 OpenAI 兼容保留，当前版本暂不支持自定义。 > 视频生成接口（OpenAI videos.create 兼容） 支持的请求参数 | 字段 | 类型 | 说明 | 可用参数 | | :-- | :-- | :-- | :-- | | | string | 视频模型名 | | | | string | 视频提示词 | - | | | string | 画面比例（会映射到 aspect_ratio） | , , , , | | | integer | 目标时长（秒） | ~ | | | string | 视频质量（映射到 resolution） | , | | | array | 参考图（可选） | 兼容 OpenAI content block 数组格式 ( ) 或纯 URL 字符串数组；单图也请传单元素数组 | | | file | multipart 参考图（可选） | , , | **注意事项**： • 服务端已支持 6~30 秒自动链式扩展，**无需使用 **。 • 对应 ； 对应 。 • 基础号池请求 时会先产出 再按 执行超分。 • 统一使用数组格式，最多可传 7 张参考图；单图场景也请传单元素数组。 主要以表单上传参考图；若两者同时传入，会按顺序作为参考图合并输入；可在提示词中使用 、 。 参数配置 配置文件： > [!NOTE] > 生产环境或反向代理部署时，请确保 配置为对外可访问的完整 URL， > 否则可能出现文件访问链接不正确或 403 等问题。 > [!TIP] > **v2.0 配置结构升级**：旧版本用户更新后，配置会**自动迁移**到新结构，无需手动修改。 > 旧的 配置节中的自定义值会自动映射到对应的新配置节。 | 模块 | 字段 | 配置名 | 说明 | 默认值 | | :-- | :-- | :-- | :-- | :-- | | **app** | | 应用地址 | 当前 Grok2API 服务的外部访问 URL，用于文件链接访问。 | | | | | 后台密码 | 登录 Grok2API 管理后台的密码（必填）。 | | | | | API 密钥 | 调用 Grok2API 服务的 Token（可选，支持逗号分隔或数组）。 | | | | | Function 开关 | 是否启用 function 功能玩法。 | | | | | Function 密钥 | Function 调用密钥（可选）。 | | | | | 图片格式 | 生成的图片格式（url 或 base64）。 | | | | | 视频格式 | 生成的视频格式（html 或 url，url 为处理后的链接）。 | | | | | 临时对话 | 是否启用临时对话模式。 | | | | | 禁用记忆 | 禁用 Grok 记忆功能，防止响应中出现不相关上下文。 | | | | | 流式响应 | 是否默认启用流式输出。 | | | | | 思维链 | 是否默认启用思维链输出。 | | | | | 动态指纹 | 是否动态生成 Statsig 指纹。 | | | | | 自定义指令 | 多行文本，透传为 Grok 。 | | | | | 过滤标签 | 自动过滤 Grok 响应中的特殊标签。 | | | **proxy** | | 基础代理 URL | 代理请求到 Grok 官网的基础服务地址。 | | | | | 资源代理 URL | 代理请求到 Grok 官网的静态资源（图片/视频）地址。 | | | |…