跳转到内容

使用 API 与游乐场

游乐场用于在线简单测试和体验 AI 模型,用户可以输入问题或指令,与模型进行对话并查看生成结果。入口为左侧导航「游乐场」或 /playground。

  1. 选择分组与模型:在输入框右下方选择可用的模型分组和具体模型,确认本次对话使用的模型。
  2. 设置请求参数:点击参数设置按钮,根据需要启用并调整温度、Top P、频率惩罚、存在惩罚和最大 Tokens 等生成参数。
  3. 填写对话内容:在底部输入框中输入问题、指令或提示词。
  4. 发送请求:确认模型、参数和输入内容后,点击「发送」按钮提交请求。
  5. 查看回复结果:模型生成完成后,可在对话区域查看返回内容,并继续输入新的问题进行多轮对话。

网关的 OpenAI 兼容地址通常为:

https://your-host/v1

使用 API 密钥作为 Bearer Token:

Authorization: Bearer sk-your-api-key

以聊天补全为例:

终端窗口
curl https://your-host/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-your-api-key" \
-d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"你好"}]}'
from openai import OpenAI
client = OpenAI(
api_key="sk-xxxxxxxx",
base_url="https://your-host/v1",
)
response = client.chat.completions.create(
model="gpt-4o-mini",
messages=[{"role": "user", "content": "你好"}],
)
print(response.choices[0].message.content)
终端窗口
curl https://your-host/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"}]}'
终端窗口
curl "https://your-host/v1beta/models/gemini-1.5-pro:generateContent?key=sk-xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"contents": [{"parts": [{"text": "Hello"}]}]}'
接口 路径 说明
聊天补全 POST /v1/chat/completions OpenAI Chat Completions 兼容接口,要求提供 model 和 messages,支持流式或普通响应。
游乐场聊天 POST /pg/chat/completions 网页游乐场专用接口,使用登录会话认证,不需要 API 密钥;计费方式与普通调用一致。
文本补全 POST /v1/completions 传统文本补全接口,要求提供 prompt 和 model。
Responses API POST /v1/responses OpenAI Responses 格式接口,支持输入、工具和响应事件等能力。
Responses 压缩 POST /v1/responses/compact 对 Responses 请求上下文执行压缩处理。
Claude Messages POST /v1/messages Anthropic Claude Messages 兼容接口,要求提供 model 和消息内容,必要时转换为上游协议。
Codex 网页搜索 POST /v1/alpha/search Codex 独立网页搜索格式接口,仅部分模型支持。
实时对话 GET /v1/realtime(WebSocket) OpenAI Realtime 风格的双向实时通信接口,模型通常通过查询参数传入,API 密钥可通过 Bearer Token 或 WebSocket 子协议传递。
接口 路径 说明
向量嵌入 POST /v1/embeddings 将文本或文本数组转换为向量,要求提供 input。
Gemini 嵌入兼容接口 POST /v1/engines/{model}/embeddings 兼容旧版 Gemini 风格的嵌入路径,根据 URL 中的模型名处理嵌入请求。
重排序 POST /v1/rerank 根据 query 对候选 documents 进行相关性排序,要求查询内容和文档列表不为空。
内容审核 POST /v1/moderations 对文本或其他输入执行内容审核;未提供模型时会使用默认审核模型候选。
接口 路径 说明
图像生成 POST /v1/images/generations 根据提示词生成图像;可用的尺寸、质量和数量取决于所选模型。
图像编辑 POST /v1/images/edits 根据输入图像和提示词进行图像编辑,支持 JSON 和 multipart/form-data 请求。
旧版编辑接口 POST /v1/edits 保留的兼容路径,进入图像 Relay 处理;新客户端建议优先使用 /v1/images/edits。
语音转文字 POST /v1/audio/transcriptions 将音频转换为文字,按照 OpenAI 音频接口格式转发到对应语音识别渠道。
音频翻译 POST /v1/audio/translations 识别音频内容并输出翻译后的文字。
文字转语音 POST /v1/audio/speech 将输入文本转换为音频。

视频、音乐等异步生成接口见日志与异步任务中的「异步生成与任务接口」。

接口 路径 说明
模型列表 GET /v1/models 默认返回 OpenAI 格式模型列表;使用 Anthropic 请求头时返回 Claude 格式,使用 x-goog-api-key 或 key 查询参数时返回 Gemini 格式。
模型详情 GET /v1/models/{model} 查询单个模型信息;模型不存在时返回 model_not_found 错误对象。
Gemini 模型列表 GET /v1beta/models 以 Gemini 格式返回可用模型列表,响应字段包括 models 和 nextPageToken。
OpenAI 格式模型列表 GET /v1beta/openai/models 在 Gemini 兼容命名空间下,以 OpenAI 格式返回模型列表。
接口 路径 说明
Gemini 原生模型调用 POST /v1beta/models/{model}:{action} Gemini 原生格式接口,支持 generateContent、streamGenerateContent 和嵌入相关操作。
Gemini 兼容模型调用 POST /v1/models/{model}:{action} 以 /v1 前缀承接 Gemini 风格的模型操作请求,由 Gemini Relay 负责解析和转换。