Hubridge

快速开始

三步完成 API Key 获取与首次调用

本指南帮助你在拿到 API Key 后,通过 OpenAI 兼容接口调用模型。Console 用于管理账号与令牌,实际推理请求请发往 Gateway 地址

准备工作

三步上手

1. 创建 API Key

  1. 进入 令牌管理
  2. 点击 创建令牌,填写名称
  3. 创建成功后 立即复制 完整密钥(格式类似 sk-xxx,之后无法再次查看)

2. 确认 Gateway 地址

API 调用 Base URL 为 Gateway 服务地址,例如:

https://your-gateway.example.com

本地开发时通常为 http://localhost:8000(以实际部署为准)。

所有接口路径在此基础上追加,例如 Chat Completions:POST /v1/chat/completions

3. 发起第一次请求

YOUR_API_KEYYOUR_GATEWAY_BASE_URL 替换为你的密钥与 Gateway 地址,model 替换为平台支持的模型名:

curl -X POST "$YOUR_GATEWAY_BASE_URL/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      { "role": "user", "content": "Hello!" }
    ]
  }'

成功时返回 OpenAI 格式的 JSON,包含 choicesusage 字段。

下一步

主题说明
鉴权API Key 用法与安全建议
对话补全请求参数、多语言 SDK 示例
流式输出stream: true 与 SSE
其他接口Embeddings、图像、Claude 等
错误处理常见状态码与排查

兼容说明

Gateway 提供 OpenAI / Anthropic / Gemini 等兼容端点,多数场景只需替换 Base URL 和 API Key,即可复用现有 SDK 或示例代码。