MAX APIMAX API
使用指南部署安装API 参考AI 应用帮助支持商务合作合规与使用政策
⚠️合规提示:本项目仅用于合法授权的 API 网关、内部管理和私有化部署场景。请遵守上游服务条款、平台规则、监管要求和内容安全要求。
用户指南

使用 API

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

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

操练场在线测试

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

访问操练场

左侧导航点击「操练场」,或直接访问 /console/playground

操练场页面

使用操练场

  1. 在左侧选择要测试的模型
  2. 在底部输入框输入消息内容,点击发送
  3. 右侧对话区域显示模型的回复结果

操练场对话示例

选择模型和分组

在输入区域上方选择模型和可用分组。选择 autoauto:* 分组时,操练场会加载当前用户可用的模型集合;实际可用性仍取决于管理员配置的渠道、分组和权限。

模型参数

点击输入框工具栏中的参数按钮可打开参数设置。桌面端显示为弹出面板,移动端显示为底部面板。每个参数都需要单独启用,只有已启用的参数才会随聊天补全请求发送。设置会保存在当前浏览器中,便于后续继续测试。

参数范围用途
温度(Temperature)0 - 2,步进 0.1控制随机性和创造性。较低的值通常更稳定,较高的值通常更发散。
Top P0 - 1,步进 0.05将候选 Token 限制在指定的累计概率范围内。
频率惩罚(Frequency Penalty)-2 - 2,步进 0.1降低重复用词的倾向。
存在惩罚(Presence Penalty)-2 - 2,步进 0.1鼓励模型引入新的主题。
最大 Token 数(Max Tokens)1 - 200000,整数限制回复长度。
随机种子(Seed)0 - 2147483647,整数,可留空在支持的模型上提高相同请求的可重复性;留空时不会发送 seed

输入值会按控件范围和步进值规范化。模型和上游服务对参数的支持程度不同;如果上游返回参数校验错误,请关闭相应参数或选择兼容模型。

获取 API 地址

复制 API 地址

  1. 访问平台首页
  2. 在页面中部找到 API Base URL 显示区域
  3. 点击复制按钮,将地址复制到剪贴板

首页 API 地址复制区域

配置客户端

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

代码示例

Python(OpenAI SDK)

from openai import OpenAI

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

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

Claude 原生格式

curl https://your-platform.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://your-platform.com/v1beta/models/gemini-1.5-pro:generateContent?key=sk-xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"contents": [{"parts": [{"text": "Hello"}]}]}'

支持的接口端点

接口路径说明
聊天补全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 格式
Alpha SearchPOST /v1/alpha/search独立 Web Search 中继,支持 Codex 和 Advanced Custom 直通,详见 OpenAI Alpha Search
实时对话GET /v1/realtime(WebSocket)OpenAI Realtime API
模型列表GET /v1/models查询可用模型

这篇文档对您有帮助吗?