OpenAI 兼容接口说明
VLX FLUX 为购买分发 API 的用户提供 OpenAI 兼容接口。大多数 SDK、CLI 工具和第三方客户端中,只需要替换 API Key 和 Base URL,就可以通过 VLX FLUX 调用可用模型。
基础配置
当工具要求填写 OpenAI 兼容接口配置时,通常按下面填写:
| 字段 | 填写内容 |
|---|---|
| API Key | 你的 VLX FLUX API Key |
| Base URL | https://api.vlxflux.io/v1 |
| Authorization | Bearer YOUR_API_KEY |
| Model | 使用当前账号可调用的模型名 |
TIP
如果客户端要求填写完整接口地址,使用 https://api.vlxflux.io/v1/chat/completions。如果客户端要求填写 Base URL,只填写 https://api.vlxflux.io/v1。
请求头格式
所有 HTTP 请求都需要在 Authorization 请求头中携带 API Key:
http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/jsonAPI Key 前后不要加引号,也不要带多余空格。
常用接口
| 用途 | 方法 | 路径 |
|---|---|---|
| 获取模型列表 | GET | /models |
| 聊天模型调用 | POST | /chat/completions |
| 生图模型调用 | POST | /images/generations |
完整接口地址由 Base URL 和请求路径拼接而成。
示例:
text
https://api.vlxflux.io/v1/chat/completions使用 curl 测试
先确认 API Key 可以访问模型列表:
bash
curl https://api.vlxflux.io/v1/models \
-H "Authorization: Bearer YOUR_API_KEY"再发送一条最小聊天请求:
bash
curl https://api.vlxflux.io/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "gpt-4o",
"messages": [
{ "role": "user", "content": "你好" }
]
}'请把 gpt-4o 替换为当前账号可调用的模型名。
Python SDK
安装 OpenAI Python SDK:
bash
pip install openai调用接口:
python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://api.vlxflux.io/v1"
)
response = client.chat.completions.create(
model="gpt-4o",
messages=[
{"role": "user", "content": "你好"}
]
)
print(response.choices[0].message.content)Node.js SDK
安装 OpenAI Node.js SDK:
bash
npm install openai调用接口:
js
import OpenAI from "openai";
const client = new OpenAI({
apiKey: process.env.VLXFLUX_API_KEY,
baseURL: "https://api.vlxflux.io/v1",
});
const response = await client.chat.completions.create({
model: "gpt-4o",
messages: [
{ role: "user", content: "你好" },
],
});
console.log(response.choices[0].message.content);环境变量
本地开发时,建议把 API Key 放在环境变量中,不要直接写入代码:
bash
export VLXFLUX_API_KEY="YOUR_API_KEY"
export VLXFLUX_BASE_URL="https://api.vlxflux.io/v1"有些工具只识别 OpenAI 风格的变量名,这时可以使用:
bash
export OPENAI_API_KEY="YOUR_API_KEY"
export OPENAI_BASE_URL="https://api.vlxflux.io/v1"模型名
模型名必须和当前 API Key 可调用的模型保持一致。如果请求返回 model not found,请先查询模型列表:
bash
curl https://api.vlxflux.io/v1/models \
-H "Authorization: Bearer YOUR_API_KEY"你也可以在模型市场或控制台中查看最新模型可用性和价格。
计费
请求会根据所选模型、账户余额和模型分组倍率进行扣费。最终价格和可用性以控制台实时展示为准。
排查问题
401 Unauthorized:检查 API Key 是否正确、有效、未被禁用。403 Forbidden:当前 Key 可能无权调用所选模型或分组。404 Not Found:检查 Base URL 或请求路径是否填写错误。429 Too Many Requests:降低请求频率或并发数。model not found:通过模型列表接口确认准确模型名。- 余额不足:请充值账户,或切换到成本更低的模型。
更多说明请阅读 错误码与排查。