Skip to Content
GGPU API快速接入

GGPU API 快速接入

用一套固定网关和访问凭证完成首次调用,并建立后续接入都能复用的请求结构。

统一 Base URL: https://api.ggpu.ai。它不包含额外的 /api 后缀;调用时直接在其后拼接 /v1/... 接口路径。

接入前准备

必需信息使用值从哪里获得
Base URLhttps://api.ggpu.aiGGPU API 固定网关
访问凭证一把完整、可用的 API Key控制台 API Key 管理
模型名称当前账号实际可用的模型 ID/v1/models 或控制台模型列表

先确认这三项,再排查请求参数。这样可以把“连接不到网关”“鉴权失败”和“模型不可用”分开处理。

一次请求由什么组成

一次 API 调用由三部分组成
接入配置地址与凭证Base URL、API Key 与模型名称
HTTP 请求方法、路径与 JSON请求头负责鉴权,请求体描述任务
调用结果状态、内容与用量先判断状态,再读取业务字段
统一地址
固定网关拼接接口路径
Bearer 鉴权
密钥仅保存在服务端
JSON 数据
按能力组织请求参数
请求标识
保留 ID 便于定位问题

完成第一条请求

配置环境变量

export BASE_API_URI="https://api.ggpu.ai" export GGPU_ACCESS_CREDENTIAL_SECRET="<access-credential-secret>"

把完整密钥保存在服务端环境变量或密钥管理工具中。不要提交到代码仓库,也不要放进浏览器端代码。

发送最小文本请求

curl -X POST "${BASE_API_URI}/v1/chat/completions" \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer ${GGPU_ACCESS_CREDENTIAL_SECRET}" \ -H 'X-Request-Id: quickstart-001' \ -d '{ "model": "<model-name>", "messages": [ { "role": "user", "content": "请用一句话介绍GGPU API。" } ] }'

将 <model-name> 替换为当前账号可用的模型 ID。完整请求地址是:

https://api.ggpu.ai/v1/chat/completions

判断调用是否成功

先检查 HTTP 状态码,再确认响应体中存在可读取的结果字段。文本对话的典型成功响应会包含 choices:

{ "id": "chatcmpl_xxx", "choices": [ { "message": { "role": "assistant", "content": "GGPU API 提供统一的模型调用入口。" }, "finish_reason": "stop" } ] }

如果返回非 2xx 状态,不要只重复发送请求。保留状态码、响应体、请求时间和 X-Request-Id,再按 错误处理 分流。

通用请求约定

每个 JSON 请求至少包含以下请求头:

Content-Type: application/json Authorization: Bearer <access-credential-secret>

需要追踪调用来源时,可以增加:

请求头作用建议
X-Request-Id标识某一次具体请求每次请求使用唯一值,并记录到服务端日志
X-Tenant-Id标识项目、租户或应用仅在你的接入方案需要时传入

按目标选择接口

目标方法与路径下一步
获取完整文本结果POST /v1/chat/completions文本对话
边生成边展示文本POST /v1/chat/completions + stream: true流式响应
生成图片POST /v1/images/generations图片生成
查询可用模型GET /v1/models模型与任务
跟踪异步任务/v1/tasks 相关接口模型与任务

上线前检查

检查项合格标准
地址Base URL 为 https://api.ggpu.ai,路径从 /v1/... 开始
密钥只在服务端保存,不出现在日志、前端或公开仓库
模型来自当前账号可用列表,并经过真实请求验证
超时客户端设置了合理的连接与读取超时
错误401、429 和临时 5xx 有明确处理分支
追踪能用时间、请求 ID、模型和状态码定位一次调用

继续接入