使用 API

用户指南

使用 API

将平台地址替换 OpenAI 的 base_url,使用平台颁发的令牌作为 api_key,即可开始调用

将平台地址替换 OpenAI 的 `base_url`,使用平台颁发的令牌作为 `api_key`,即可开始调用。生产环境接口路径为 `/v1/*`;在线操练场会调用 `/pg/chat/completions` 便于调试,与正式 API 路径不同。

操练场在线测试

操练场是内置的在线测试工具,无需编写代码即可直接与模型对话,适合快速验证令牌是否可用。

访问操练场

  1. 顶部导航点击「演示 → 对话演示」,或直接访问 /demo/chat
  2. 令牌管理 列表中点击「聊天」,可携带指定令牌进入操练场

使用操练场

  1. 在左侧选择文本 / 图片 / 视频模式,以及分组与模型(若从令牌页进入,会自动限制可用模型)
  2. 在底部输入框输入消息内容,点击发送
  3. 对话区域显示模型回复
easyapi.com/demo/chat
你好,请用一句话介绍 EasyAPI。
EasyAPI 是 OpenAI 兼容的 AI 网关,统一接入多家模型并提供令牌与配额管理。
输入消息…发送

操练场示意:左侧选模型,中间对话,右侧可查看请求与响应(示例页布局类似)

获取 API 地址

默认 API 地址为 https://ai-api.easyapi.com。部署时可通过环境变量 NUXT_PUBLIC_API_BASE_URL 自定义;OpenAI SDK 的 base_url 需追加 /v1

复制 API 地址

  1. 在代码示例操练场右侧查看当前站点生成的请求地址
  2. 或在部署环境 / 管理员提供的文档中确认 NUXT_PUBLIC_API_BASE_URL
  3. 生产调用使用 https://ai-api.easyapi.com/v1 作为 OpenAI 兼容 base_url

OpenAI 兼容 Base URL

https://ai-api.easyapi.com/v1

配置客户端

将复制的地址填入客户端或代码中作为 base_url,配合 平台颁发的令牌 作为 api_key 即可开始调用。

  • HTTP 请求头:Authorization: Bearer YOUR_API_KEY
  • 令牌管理页「聊天」菜单支持一键导入 Lobe Chat、OpenCat 等客户端,会自动带上 API 基址
  • 详细鉴权说明见 API 鉴权

代码示例

以下示例中的地址与当前站点配置一致;请将 sk-xxxxxxxx 替换为你的真实令牌。

Python(OpenAI SDK)

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxxxxxxxxxx",  # 平台颁发的令牌
    base_url="https://ai-api.easyapi.com/v1"
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)

Claude 原生格式

curl https://ai-api.easyapi.com/v1/messages \
  -H "x-api-key: sk-xxxxxxxx" \
  -H "anthropic-version: 2023-06-01" \
  -H "content-type: application/json" \
  -d '{"model": "claude-3-5-sonnet-20241022", "max_tokens": 1024, "messages": [{"role": "user", "content": "Hello"}]}'

Gemini 原生格式

curl "https://ai-api.easyapi.com/v1beta/models/gemini-1.5-pro:generateContent?key=sk-xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"contents": [{"parts": [{"text": "Hello"}]}]}'

支持的接口端点

EasyAPI 提供 OpenAI 兼容 REST 接口;具体模型是否支持某端点取决于后台渠道配置。

接口路径说明
聊天补全POST /v1/chat/completions对话生成,支持流式输出
文本补全POST /v1/completions传统补全接口
向量嵌入POST /v1/embeddings文本向量化
图像生成POST /v1/images/generations文生图
图像编辑POST /v1/images/edits图像编辑
语音转文字POST /v1/audio/transcriptionsWhisper 等
文字转语音POST /v1/audio/speechTTS
重排序POST /v1/rerank文档重排序
Responses APIPOST /v1/responsesOpenAI Responses 格式
实时对话GET /v1/realtime(WebSocket)OpenAI Realtime API
模型列表GET /v1/models查询可用模型