GPTNB Docs
Docs
Docs
  1. OpenClaw 集成
  • 发出请求
  • OpenClaw 集成
    • OpenClaw + GPTNB 集成
      POST
  • OpenAI接口
    • Realtime文档
    • 聊天接口(Chat)
      • 生成音乐
    • 自动补全接口(Completions)
      • 创建完成
    • 图像接口(Images)
      • 创建图像
      • 生成
    • 向量生成接口(Embeddings)
      • 创建嵌入
    • 音频接口(Audio)
      • 创建转录
      • 创建翻译
      • 创建语音
  • 图片接口
    • Midjourney
      • 补充 - 其他参数以及回调
      • 换脸任务提交
        • 提交swap_face任务
      • 任务提交
        • 执行动作(所有的关联按钮动作UPSCALE; VARIATION; REROLL; ZOOM等)
        • 绘图变化-simple(UPSCALE; VARIATION; REROLL)
        • 提交Blend任务(图生图)
        • 提交Describe任务(图生文)
        • 提交Imagine任务(文生图、文图生图)
        • 提交Modal(提交局部重绘、ZOOM)
        • Change
        • 提交Shorten任务(prompt分析)
      • 任务查询
        • 根据ID列表查询任务
        • 指定ID获取任务
        • 获取任务图片的seed
    • Stable Diffusion(官方格式)
      • SD3
        • Stable Image Ultra
        • Stable Image Core
        • Stable Diffusion 3
      • SDXL
        • Text-to-image
    • Flux
      • 官方格式
        • 生成图像(image)
        • 查询任务(get_result)
      • OpenAI格式
        • Flux
    • Ideogram(官方格式)
      • Generate(文生图)
      • Remix(混合图)
      • Upscale(放大高清)
      • Describe(描述)
  • 音乐接口
    • Suno
      • 官方格式(v2)
        • 所有接口
          • 音乐链接转成suno(upload)
          • 音乐生成(generations)
          • 查询任务(feed)
          • 获取完整音乐(concat)
        • 场景1 生成自定义音乐(带歌词)
          • 音乐生成(generations)
          • 查询任务(feed)
        • 场景 2 通过提示词直接生成音乐(带歌词)
          • 音乐生成(generations)
          • 查询任务(feed)
        • 场景 4 通过提示词直接生成音乐(纯音乐)
          • 音乐生成(generations)
          • 查询任务(feed)
        • 场景 3 生成自定义音乐(纯音乐)
          • 音乐生成(generations)
          • 查询任务(feed)
        • 场景 5 上传自定义音频并续写
          • 续写自定义音频步骤介绍
          • 音乐链接转成suno(upload)
          • 音乐生成(generations)
          • 查询任务(feed)
        • 场景 6 续写音乐并获取完整音乐
          • 步骤 1 音乐生成
          • 步骤 3 扩展音乐
          • 步骤 2 查询任务
          • 步骤 4 查询拓展的任务
          • 步骤 6 查询完整音乐的任务
          • 步骤 5 获取完整音乐
        • 场景 7 Cover音乐(音乐翻版,修改风格)
          • 步骤 1 音乐生成
          • 步骤 2 查询任务
          • 步骤 3 Cover 音乐
          • 步骤 4 查询拓展的任务
        • 场景 8 Replace Section (替换片段)
          • 步骤 1 音乐生成
          • 步骤 2 查询任务
          • 步骤 3 Replace Section
          • 步骤 4 查询拓展的任务
    • Udio
      • Udio 说明
      • 根据描述创建音乐 - 场景1
      • 根据歌词创建音乐 - 场景2
      • 音乐续写 - 场景3
      • 获取任务进度
  • 视频接口
    • Luma
      • 官方格式(v2)
        • 提交生成视频任务
        • 获取视频无水印链接
        • 查询单个任务
        • 扩展视频
    • CogVideoX(官方格式)
      • 生成(generations)
      • 查询(async-result)
    • Pika
      • generate(文本)
      • generate(参考图片)
      • generate(参考视频/扩展视频)
      • feed
    • Runway
      • v1格式
        • generate(文本)
        • generate(参考图片)
        • feed
      • 官方格式(v2)
        • 生成视频(tasks)
        • 查询任务
    • Pixverse
      • @回调说明
      • @接口说明
      • generate(文本)
      • feed
      • generate(参考图片)
    • 可灵(官方格式)
      • 文生视频
      • 图生视频
      • 查询任务
    • Veo
      • 统一格式
        • 提交视频不垫图异步任务
        • 提交视频垫图异步任务
        • 查询视频异步任务
      • 官方格式
        • 视频生成
          • 提交视频生成任务
          • 视频延长
        • 任务查询
          • 查询任务状态
    • sora-2
      • 视频统一格式
        • 创建视频 带图片
        • 创建视频
        • 查询任务
  • PPT接口
    • 文多多(官方格式)
      • 创建接口token
      • 查询API信息
      • 分页查询 PPT 模板
      • 更换 PPT 模板
      • 修改大纲
      • 接口鉴权
      • 解析文件内容
      • 生成大纲
      • 生成大纲内容
      • 随机 PPT 模板
      • 直接生成PPT
      • 获取 PPT 列表
      • 加载 PPT 数据
      • 下载 PPT
      • 更新 PPT 属性
      • 保存 PPT
      • 删除PPT
      • 生成大纲内容同时异步生成PPT
      • 查询异步生成PPT信息
      • ppt转json
      • json转ppt
    • 韦尼克(官方格式)
      • 申请PPT生成任务(PPT描述/主题一键生成)
      • 获取PPT生成状态和预览页(PPT描述/主题一键生成)
      • 通过描述生成PPT标题大纲(逐步生成PPT)
      • 申请PPT生成任务(逐步生成PPT)
      • 获取PPT生成状态和预览页(逐步生成PPT)
      • 根据标题生成封面预览图(模版封面图预览)
      • 根据标题以及封面预览信息生成不同主题色的预览(设置主题色)
      • 通过task_id增加PPT单页(PPT中插入单页)
      • 基于当前模板生成(基于当前模版生成)
      • 短文本文件生成PPT(文件内容解析)
      • 获取PPT生成状态和预览页(文件内容解析)
      • 获取PPT生成状态和预览页(文件内容解析)
      • 通过文件生成PPT(文件内容解析)
      • 更换模版(更换模版)
      • 生成PPT备注(演讲稿备注)
      • 获取PPT下载链接(获取下载链接)
  • 帮助中心
    • 常见问题及解决办法
  • OpenAI官方文档
    • 介绍
    • 项目说明
    • 导言
    • 身份验证
    • 发出请求
    • 参数详情
    • 音频(Audio)
      • 创建翻译
      • 创建转录
    • 聊天(Chat)
      • gpts 请求
      • 聊天完成块对象
      • 创建聊天补全
    • 自动补全(Completions)
      • 完成对象
    • 嵌入(Embeddings)
      • 嵌入对象
    • 微调(Fine-tuning)
      • 微调作业对象
      • 微调作业事件对象
      • 创建微调作业
      • 列出微调作业
      • 检索微调作业
      • 取消微调
      • 列出微调事件
    • 图像(Images)
      • README
      • 图像对象
      • 创建图片编辑
      • 创建图像变体
    • 模型(Models)
      • 模型对象
      • 列出模型
      • 检索模型
      • 删除微调模型
    • 文件(Files)
      • README
      • 文件对象
      • 上传文件
      • 删除文件
      • 检索文件
      • 检索文件内容
      • 列出文件
    • 审查(Moderations)
      • 调节对象
      • 创建内容审核
    • 助手测试版(AssistantsBeta)
      • 辅助对象
      • 辅助文件对象
      • 创建助手
      • 检索助手
      • 修改助手
      • 删除助手
      • 列出助手
      • 创建辅助文件
      • 检索助手文件
      • 删除辅助文件
      • 列出助手文件
    • 线程数(Threads)
      • 线程对象
      • 创建线程
      • 检索线程
      • 修改线程
      • 删除话题
    • 留言(Messages)
      • 消息对象
      • 消息文件对象
      • 创建消息
      • 检索消息
      • 修改留言
      • 列出消息
      • 检索消息文件
      • 列出消息文件
    • 运行(Runs)
      • 运行对象
      • 运行步骤对象
      • 创建运行
      • 检索运行
      • 修改运行
      • 列表运行
      • 提交工具输出以运行
      • 取消运行
      • 创建线程并运行
      • 检索运行步骤
      • 列出运行步骤
  • 数据模型
    • Schemas
      • Blend提交参数
      • BaseCreateCompletionRequest
      • Blend提交参数
      • CheckActivationDTO
      • ChatMessageContent
      • SubmitTaskRequest
      • Describe提交参数
      • ChatCompletionRequestMessage
      • BaseCreateCompletionRequest
      • Discord账号
      • ChatCompletionResponseMessage
      • SubmitTaskResponse
      • Filter
      • ChatCompletionMessageToolCalls
      • CheckActivationDTO
      • Imagine提交参数
      • ChatCompletionMessageToolCall
      • StatusResponse
      • Map«string,object»
      • UsageInfo
      • ChatMessageContent
      • Message«Discord账号»
      • ChatCompletionTool
      • ErrorResponse
      • Message«Map«string,object»»
      • CreateChatCompletionExclusiveFields
      • Describe提交参数
      • Message«Void»
      • FunctionObject
      • ChatCompletionRequestMessage
      • Message«string»
      • FunctionParameters
      • Discord账号
      • Modal提交参数
      • GenerationID
      • ChatCompletionResponseMessage
      • Option
      • ImageToVideoRequest
      • Filter
      • Pageable
      • ContentModerationResponse
      • ChatCompletionMessageToolCalls
      • Page«Map«string,object»»
      • InpaintingSearchModeRequestBody
      • Imagine提交参数
      • Page«任务»
      • InpaintingMaskingModeRequestBody
      • ChatCompletionMessageToolCall
      • Shorten提交参数
      • Creativity
      • Map«string,object»
      • Sort
      • Engine
      • UsageInfo
      • SwapFace提交参数
      • Error
      • Message«Discord账号»
      • TaskQueryDTO
      • CfgScale
      • ChatCompletionTool
      • 任务
      • ClipGuidancePreset
      • Message«Map«string,object»»
      • 任务查询参数
      • UpscaleImageHeight
      • CreateChatCompletionExclusiveFields
      • 变化任务提交参数
      • UpscaleImageWidth
      • Message«Void»
      • 变化任务提交参数-simple
      • DiffuseImageHeight
      • FunctionObject
      • 可执行按钮
      • DiffuseImageWidth
      • Message«string»
      • 可执行按钮_1
      • Sampler
      • FunctionParameters
      • 执行动作参数
      • Samples
      • Modal提交参数
      • 提交结果
      • Seed
      • GenerationID
      • 激活服务参数
      • Steps
      • Option
      • 账号修改参数
      • Extras
      • ImageToVideoRequest
      • 账号创建参数
      • StylePreset
      • Pageable
      • 账号查询参数
      • TextPrompt
      • ContentModerationResponse
      • 账号筛选条件
      • TextPrompts
      • Page«Map«string,object»»
      • TextPrompts
      • InpaintingSearchModeRequestBody
      • InputImage
      • Page«任务»
      • InitImage
      • InpaintingMaskingModeRequestBody
      • InitImageStrength
      • Shorten提交参数
      • InitImageMode
      • Creativity
      • StepScheduleStart
      • Sort
      • StepScheduleEnd
      • Engine
      • MaskImage
      • SwapFace提交参数
      • MaskSource
      • Error
      • GenerationRequestOptionalParams
      • TaskQueryDTO
      • RealESRGANUpscaleRequestBody
      • CfgScale
      • ImageToImageRequestBody
      • 任务
      • ImageToImageUsingImageStrengthRequestBody
      • ClipGuidancePreset
      • ImageToImageUsingStepScheduleRequestBody
      • 任务查询参数
      • MaskingRequestBody
      • UpscaleImageHeight
      • MaskingUsingMaskImageRequestBody
      • 变化任务提交参数
      • MaskingUsingInitImageAlphaRequestBody
      • UpscaleImageWidth
      • TextToImageRequestBody
      • 变化任务提交参数-simple
      • AccountResponseBody
      • DiffuseImageHeight
      • BalanceResponseBody
      • 可执行按钮
      • ListEnginesResponseBody
      • DiffuseImageWidth
      • FinishReason
      • 可执行按钮_1
      • Image
      • Sampler
      • OrganizationMembership
      • 执行动作参数
      • Samples
      • 提交结果
      • Seed
      • 激活服务参数
      • Steps
      • 账号修改参数
      • Extras
      • 账号创建参数
      • StylePreset
      • 账号查询参数
      • TextPrompt
      • 账号筛选条件
      • TextPrompts
      • TextPrompts
      • InputImage
      • InitImage
      • InitImageStrength
      • InitImageMode
      • StepScheduleStart
      • StepScheduleEnd
      • MaskImage
      • MaskSource
      • GenerationRequestOptionalParams
      • RealESRGANUpscaleRequestBody
      • ImageToImageRequestBody
      • ImageToImageUsingImageStrengthRequestBody
      • ImageToImageUsingStepScheduleRequestBody
      • MaskingRequestBody
      • MaskingUsingMaskImageRequestBody
      • MaskingUsingInitImageAlphaRequestBody
      • TextToImageRequestBody
      • AccountResponseBody
      • BalanceResponseBody
      • ListEnginesResponseBody
      • FinishReason
      • Image
      • OrganizationMembership
    • Response
      • 401
      • 401
      • 403
      • 403
      • 404
      • 404
      • 500
      • 500
      • GenerationResponse
      • GenerationResponse
      • 400FromGeneration
      • 400FromGeneration
      • 400FromUpscale
      • 400FromUpscale
    • 示例数据模型
      • Pet
      • Pet
      • Category
      • Category
      • Tag
      • Tag
  1. OpenClaw 集成

OpenClaw + GPTNB 集成

POST
/v1/chat/completions

如何将 GPTNB 集成到 OpenClaw#

本指南将带你一步一步把 OpenClaw 连接到 GPTNB。GPTNB 是一个完全兼容 OpenAI / Claude / Gemini 官方格式的 API 网关,OpenClaw 会把它当作标准的端点,因此无需修改任何代码。

前置条件#

1.
已安装 OpenClaw —— 任意支持自定义 LLM Provider 的版本
2.
GPTNB API Key —— 在 Dashboard > API Keys 中创建

第 1 步:获取你的 GPTNB API Key#

1.
前往 api.GPTNB.ai 注册或登录
2.
进入 API Keys 页面(菜单栏 > 令牌)
3.
点击 Create New Key,并为它命名,例如 openclaw
4.
请立即复制这个 Key —— 它只会显示一次。该 Key 以 sk- 开头

第 2 步:选择模型#

GPTNB 的所有模型 ID 都采用 model-id 格式。请根据你的需求选择模型:

预算型模型(最佳性价比)#

模型 ID上下文输入 / 输出(每 1M tokens)亮点
deepseek-chat128K0.27/1.10DeepSeek V3。OpenClaw 的整体最佳预算选择。编码、推理和通用任务能力都很强。
MiniMax-M2.51M0.21/0.84最便宜的编码模型。SWE-bench 80.2%。1M 上下文窗口。
gpt-5-nano1M0.035/0.28超低成本。适合简单任务、摘要和分类。
gemini-2.5-flash1M0.105/0.42快速、便宜、1M 上下文。适合大规模代码库分析。

中档模型(质量 + 价格平衡)#

模型 ID上下文输入 / 输出(每 1M tokens)亮点
gpt-5-mini1M0.175/1.40GPT-5 系列,速度快且价格适中。通用表现均衡。
deepseek-reasoner128K0.55/2.19DeepSeek R1。链式推理能力强。
glm-5128K0.40/1.80Zhipu GLM-5。非常适合中文任务。
gemini-2.5-pro1M0.875/7.00Google 最强模型。1M 上下文,多模态能力强。

高端模型(最高质量)#

模型 ID上下文输入 / 输出(每 1M tokens)亮点
gpt-5.2256K1.225/9.80最新 GPT-5.2。OpenAI 最强模型。
gpt-4o128K1.75/7.00GPT-4o 多模态模型。复杂任务表现稳定可靠。
gpt-4.11M1.40/5.60GPT-4.1,支持 1M 上下文。

支持视觉的模型(用于截图分析)#

如果你会使用 OpenClaw 的截图/视觉功能,则需要选择支持视觉的模型:
模型 ID输入 / 1M说明
gemini-2.5-flash$0.105最便宜的视觉选项
gpt-5-mini$0.175最具性价比的视觉模型
gemini-2.5-pro$0.875最强的 Google 视觉模型
gpt-4o$1.75整体视觉效果最佳
gpt-5.2$1.225最新 GPT-5 视觉模型

第 3 步:配置 OpenClaw#

有三种方式可以将 OpenClaw 连接到 GPTNB。请选择最适合你工作流的一种。

方式 A:环境变量(最简单)#

这是最快的方式。将以下内容添加到你的 shell profile(~/.bashrc、~/.zshrc)或 OpenClaw 的 .env 文件中:
变量说明:
变量必填说明
OPENCLAW_BASE_URL是必须为 https://api.GPTNB.ai/v1。这会让 OpenClaw 将请求发送到 GPTNB,而不是 OpenAI。
OPENCLAW_API_KEY是你的 GPTNB API Key(以 sk- 开头)。
OPENCLAW_MODEL是默认模型 ID,格式为 provider/model-id。例如:deepseek-chat。
OPENCLAW_FALLBACK_MODEL否当主模型不可用或过载时使用的备用模型。例如:gpt-5-mini。
设置完成后,请重启终端和 OpenClaw。

方式 B:openclaw.json 配置文件(最灵活)#

适用于多模型配置和高级设置。编辑 ~/.openclaw/openclaw.json:
{
  "models": {
    "providers": {
      "GPTNB": {
        "baseUrl": "https://api.GPTNB.ai/v1",
        "apiKey": "$GPTNB_API_KEY",
        "api": "openai-completions",
        "models": [
          "deepseek-chat"
          "gpt-5-mini"
        ]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "GPTNB/deepseek-chat"
      }
    }
  }
}
配置字段说明:
字段说明
models.providers.gptnb将 GPTNB 注册为名为 gptnb 的自定义 provider。你也可以使用其他名称。
baseUrlGPTNB 端点。始终为 https://api.GPTNB.ai/v1。
apiKey你的 GPTNB API Key。可使用 $GPTNB_API_KEY 引用环境变量,或直接粘贴 Key(安全性较低)。
api必须为 "openai-completions"。表示 OpenClaw 应使用 OpenAI chat completions 协议。
models通过该 provider 可用的模型 ID 数组。只有列在这里的模型才会出现在 OpenClaw 的模型选择器中。
agents.defaults.model.primary新建 agent 会话的默认模型。格式为 provider-name/model-id,其中 provider-name 要与 models.providers 下定义的 key 一致(此处为 gptnb)。
重要说明:
apiKey 字段支持环境变量语法:"$GPTNB_API_KEY" 会从 GPTNB_API_KEY 环境变量中读取。这比把 Key 写死在文件中更安全。
models 数组决定 OpenClaw 提供哪些模型。你可以按需增减。
primary 模型使用 gptnb/deepseek-chat 这种格式——第一段 gptnb 是你在 models.providers 下定义的 provider 名称,后面才是 gptnb 的模型 ID。

方式 C:CLI 命令(快速配置)#

使用 OpenClaw 内置 CLI 进行配置,无需手动编辑文件:
验证配置是否已生效:

第 4 步:验证集成#

4.1 直接测试 API Key#

在 OpenClaw 中测试之前,先确认你的 gptnb Key 可以正常工作:
你应该收到一个包含 choices[0].message.content 的 JSON 响应。如果看到错误,请检查:
API Key 是否正确(以 sk- 开头)
模型 ID 是否使用 model-id 格式
账号是否还有余额

4.2 测试流式输出#

你应该会看到类似 data: {"choices":[{"delta":{"content":"1"}}]} 的 SSE 事件持续输出。

4.3 在 OpenClaw 中测试#

启动 OpenClaw 并给它一个简单任务:
2 + 2 等于多少?
如果 OpenClaw 能正常回复,说明集成已成功。你可以在 OpenClaw 的日志或 gptnb Usage Dashboard 中查看实际使用了哪个模型。

4.4 测试工具调用#

OpenClaw 高度依赖工具/函数调用(shell 命令、文件操作、网页浏览)。请验证:
列出当前目录中的文件。
OpenClaw 应该会调用 shell 工具执行 ls 并返回结果。所有 gptnb 文本模型都支持函数调用。

4.5 检查你的使用情况#

在 api.gptnb.ai/log 实时监控成本。该面板会显示:
每次请求的 token 用量与成本
按天 / 按月统计的支出明细
按模型拆分的成本分析

第 5 步:优化你的配置#

按使用场景推荐的配置#

日常自动化(约 $3/月)
适合:文件管理、网页浏览、shell 脚本、日常任务。
编码助手(约 $8/月)
适合:代码审查、调试、重构。MiniMax M2.5 在 SWE-bench 上得分 80.2%。
质量优先(约 $15/月)
适合:复杂推理、多步骤任务、截图分析。
高级用户(约 $30/月)
适合:追求最高质量、大型代码库分析、高级推理。
中文任务
适合:中文文档、带中文注释的代码、中文网页浏览。

动态切换模型#

使用 openclaw.json 方式(方式 B)时,你可以在配置中列出多个模型,并在会话过程中通过 OpenClaw 的模型选择器切换,无需重启。

成本对比#

按 50M tokens/天(典型重度 OpenClaw 使用)估算的月成本:
方案模型预估月成本
直连 AnthropicClaude Opus~$2,250
直连 OpenAIGPT-4o~$750
GPTNBDeepSeek V3~$20
GPTNBMiniMax M2.5~$16
GPTNBGPT-5 Nano~$5
GPTNB 的所有价格均为最终价格——无附加费、无加价。按量付费,无订阅要求。

故障排查#

问题原因解决方案
工具调用失败模型不支持函数调用所有 GPTNB 文本模型都支持函数调用。请确认模型 ID 是否正确。
流式输出无效网络代理或防火墙拦截了 SSE使用 curl -N(流式方式)测试,并检查代理设置。
响应缓慢模型负载过高或网络延迟尝试更换其他模型(例如 gemini-2.5-flash 非常快)

API 快速参考#

Base URL: https://api.GPTNB.ai/v1
鉴权: Authorization: Bearer sk-your-GPTNB-api-key
端点: POST /v1/chat/completions
模型 ID 格式: model-id(例如 deepseek-chat、gpt-4o)
支持特性: streaming、tool/function calling、vision(图像输入)、JSON mode、system messages

请求参数

Authorization
or
Body 参数application/json

示例
{
    "model": "deepseek-chat",
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful AI assistant."
        },
        {
            "role": "user",
            "content": "Hello from OpenClaw!"
        }
    ],
    "stream": true,
    "max_tokens": 4096
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.gptnb.ai/v1/chat/completions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "deepseek-chat",
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful AI assistant."
        },
        {
            "role": "user",
            "content": "Hello from OpenClaw!"
        }
    ],
    "stream": true,
    "max_tokens": 4096
}'

返回响应

🟢200成功
application/json
聊天补全响应
Body

示例
{
    "id": "chatcmpl-abc123",
    "object": "chat.completion",
    "created": 1709000000,
    "model": "deepseek-chat",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "Hello! I'm DeepSeek V3, running through gptnb. How can I help you today?"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 24,
        "completion_tokens": 18,
        "total_tokens": 42
    }
}
🟠400请求有误
🟠401未认证
🟠402需要付款
修改于 2026-03-10 13:57:19
上一页
发出请求
下一页
Realtime文档
Built with