快速開始
使用 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 | 帳號點數、模型限制與已設定的速率限制。 |