快速开始
使用 OpenAI 兼容、Anthropic 或 Gemini API 发出你的第一个 ApiFlux 请求。
依照本指南通过 ApiFlux 发送一个简短的文本请求，并确认网关已记录该请求。
你将完成什么
你会选择一个接口模型 ID，通过其中一种支持的 API 协议调用模型，然后在 ApiFlux 记录中找到该请求。
成功标准
请求会回传 ApiFlux is ready.，并出现在相同 API 密钥的使用记录中。
开始之前
- 创建 ApiFlux API 密钥。评估网关时请使用非生产环境密钥。
- 选择模型，并复制支持你预计使用的协议的 接口模型 ID。
- 打开一个可用 cURL、Python 3 或 Node.js 18 以上版本的终端。
执行示例前，先设置下列环境变量：
export APIFLUX_BASE_URL="https://apiflux.ai"
export APIFLUX_API_KEY="YOUR_APIFLUX_API_KEY"
export APIFLUX_MODEL="YOUR_INTERFACE_MODEL_ID"使用 python3 quickstart.py 执行 Python 示例，使用 npx tsx quickstart.ts 执行 TypeScript 示例。
妥善保管密钥
请勿将 ApiFlux API 密钥提交到版本控制，也不要暴露在浏览器端应用代码中。
发送第一个请求
选择符合现有 SDK 或请求格式的协议。若没有特定协议需求，建议从 OpenAI 兼容界面开始。
使用 Bearer 验证向 POST /v1/chat/completions 发送 Chat Completions 请求。
curl "${APIFLUX_BASE_URL}/v1/chat/completions" \
--header "Authorization: Bearer ${APIFLUX_API_KEY}" \
--header "Content-Type: application/json" \
--data @- <<JSON
{
"model": "${APIFLUX_MODEL}",
"messages": [
{
"role": "user",
"content": "Reply with exactly: ApiFlux is ready."
}
]
}
JSON成功回应会在 choices[0].message.content 中包含助理消息：
{
"choices": [
{
"message": {
"role": "assistant",
"content": "ApiFlux is ready."
}
}
]
}使用 Anthropic 验证请求头向 POST /v1/messages 发送 Messages 请求。
curl "${APIFLUX_BASE_URL}/v1/messages" \
--header "x-api-key: ${APIFLUX_API_KEY}" \
--header "anthropic-version: 2023-06-01" \
--header "Content-Type: application/json" \
--data @- <<JSON
{
"model": "${APIFLUX_MODEL}",
"max_tokens": 64,
"messages": [
{
"role": "user",
"content": "Reply with exactly: ApiFlux is ready."
}
]
}
JSON成功回应会在 content[0].text 中包含助理消息：
{
"content": [
{
"type": "text",
"text": "ApiFlux is ready."
}
],
"stop_reason": "end_turn"
}使用 Gemini 验证请求头向 POST /v1beta/models/{model}:generateContent 发送 Generate Content 请求。
curl "${APIFLUX_BASE_URL}/v1beta/models/${APIFLUX_MODEL}:generateContent" \
--header "x-goog-api-key: ${APIFLUX_API_KEY}" \
--header "Content-Type: application/json" \
--data @- <<JSON
{
"contents": [
{
"role": "user",
"parts": [
{ "text": "Reply with exactly: ApiFlux is ready." }
]
}
]
}
JSON成功回应会在 candidates[0].content.parts[0].text 中包含助理消息：
{
"candidates": [
{
"content": {
"role": "model",
"parts": [
{ "text": "ApiFlux is ready." }
]
}
}
]
}验证请求
在 ApiFlux 控制台打开使用记录，找到刚才发送的请求。确认模型、时间戳、Token 用量与请求状态都和终端中的响应一致。
请在请求失败时保留响应头 X-Request-Id。它会对应到 ApiFlux 记录中的同一条请求，也是支持人员排查问题时需要的标识。
回应成功，但没有出现记录
确认 API 密钥属于你目前在控制台使用的同一个账号，等待数秒后再重新整理记录。
疑难排解
| 结果 | 检查项目 |
|---|---|
401 Unauthorized | API 密钥与该协议使用的验证请求头。 |
400 Bad Request | 模型目录显示的接口模型 ID、请求正文与协议兼容性。 |
404 Not Found | 基础 URL 与协议端点路径。 |
429 Too Many Requests | 账号点数、模型限制与已设置的速率限制。 |