API 快速開始
用以下範例將 AI 接入應用或腳本。Claude Code、Codex 等編程工具請參考工具設定指南。
- 充值錢包,並建立 API Key。
- 從模型目錄選擇下方端點支援的模型。
- 按下方步驟設定
CODEBYAI_API_KEY,將MODEL_ID換成所選模型,再執行請求。成功的請求會消耗餘額,請勿分享 API Key。
Messages 支援 Claude;Responses 支援 GPT、Codex 和 Claude,Chat Completions 另外支援 Grok。Gemini 模型使用 Gemini 端點。未知 ID 會回傳 HTTP 400。只有 Messages、Responses 與 Chat Completions 的 JSON model 欄位可省略以使用預設模型;Gemini URL 必須包含模型 ID。
設定終端環境
請使用 curl 7.76+、Python 3.10+ 或 Node.js 20+,無需安裝 SDK 套件。將設定指令中的 YOUR_API_KEY 換成你的 Key,保留 CODEBYAI_API_KEY 名稱不變。在準備執行請求的終端輸入指令;開啟新的終端後需要重新設定。
macOS / Linux (bash / zsh):
1 export CODEBYAI_API_KEY="YOUR_API_KEY"
Windows PowerShell(用於 Python 與 JavaScript 範例):
1 $env:CODEBYAI_API_KEY="YOUR_API_KEY"
執行產生的範例
在首頁生成器選擇協議、模型和語言,複製範例。腳本請儲存為純文字檔,並在剛才設定 Key 的同一個終端切換到檔案所在資料夾執行。
| 語言 | 儲存檔名 | 執行方式 |
|---|---|---|
| curl | 不需要 | 貼到 bash / zsh 執行 |
| Python | request.py | python3 request.py |
| JavaScript | request.mjs | node request.mjs |
Windows 的 Python 使用 python request.py;Node.js 指令相同。curl 範例使用 bash / zsh 語法,Windows 請使用 Git Bash 或 WSL。不要將 Python 或 JavaScript 原始碼直接貼進 shell。下方 curl 範例也讀取同一個環境變數。
如果看到 Set CODEBYAI_API_KEY,請在同一個終端重新設定 Key 後再執行。HTTP 錯誤會顯示狀態碼和錯誤內容,請先確認原因再重試。
Anthropic Messages
1 curl --fail-with-body --max-time 120 https://www.codebyai.net/api/agent/v1/messages \2 -H "x-api-key: ${CODEBYAI_API_KEY:?Set CODEBYAI_API_KEY}" \3 -H "anthropic-version: 2023-06-01" \4 -H "content-type: application/json" \5 -d '{"model":"MODEL_ID","max_tokens":256,"messages":[{"role":"user","content":"Hello"}]}'
只服務 Claude 模型。這個端點最先讀 x-api-key。anthropic-version 會轉給 Claude 通道。
OpenAI Responses
1 curl --fail-with-body --max-time 120 https://www.codebyai.net/api/agent/v1/responses \2 -H "Authorization: Bearer ${CODEBYAI_API_KEY:?Set CODEBYAI_API_KEY}" \3 -H "content-type: application/json" \4 -d '{"model":"MODEL_ID","input":"Hello"}'
服務 GPT、Codex,以及 claude-*。claude-* 會轉到 Claude 通道並按 Claude 價格計費。
OpenAI Chat Completions
1 curl --fail-with-body --max-time 120 https://www.codebyai.net/api/agent/v1/chat/completions \2 -H "Authorization: Bearer ${CODEBYAI_API_KEY:?Set CODEBYAI_API_KEY}" \3 -H "content-type: application/json" \4 -d '{"model":"MODEL_ID","messages":[{"role":"user","content":"Hello"}]}'
Chat Completions 支援 GPT、Codex、Claude 和 Grok;Responses 不支援 Grok。OpenAI SDK 的 base URL 設為 https://www.codebyai.net/api/agent/v1 或 https://www.codebyai.net/api/agent。
Gemini
1 curl --fail-with-body --max-time 120 "https://www.codebyai.net/api/agent/v1beta/models/MODEL_ID:generateContent" \2 -H "x-goog-api-key: ${CODEBYAI_API_KEY:?Set CODEBYAI_API_KEY}" \3 -H "content-type: application/json" \4 -d '{"contents":[{"role":"user","parts":[{"text":"Hello"}]}]}'
只服務 Gemini 模型。API Key 標頭是 x-goog-api-key。
確認回應
成功的請求會回傳 HTTP 200。可在下列欄位查看生成文字與 token 用量,完整回應會依模型而異。
| 協定 | 生成文字 | Token 用量 |
|---|---|---|
| Messages | content[].text | usage |
| Responses | output[].content[].text | usage |
| Chat Completions | choices[].message.content | usage |
| Gemini | candidates[].content.parts[].text | usageMetadata |
若收到 400,請檢查模型 ID 與端點。API Key 或餘額問題請參考常見錯誤。