API 參考
聊天補全
呼叫 NeonAPI 所需的端點、請求參數與回應結構。
POST /v1/chat/completions
身分驗證
將 NeonAPI 金鑰放入 Authorization: Bearer YOUR_API_KEY 請求標頭,在可信應用環境中保管金鑰。
可用性與相容性
呼叫前核對模型的協定、權限、報價與支援參數。不支援的參數可能被拒絕。範例中的金鑰與模型均為佔位符。
請求參數
application/json
| 欄位 | 類型 | 必填 | 限制 | 意義 |
|---|---|---|---|---|
model | string | 是 | — | 模型廣場發布的準確 ID。 |
messages | Message[] | 是 | — | 依序提供角色與內容組成的對話訊息。 |
temperature | number | 否 | ≥ 0; ≤ 2; default: 1 | 模型支援時使用的取樣溫度。 |
top_p | number | 否 | ≥ 0; ≤ 1; default: 1 | 核取樣機率。 |
n | integer | 否 | ≥ 1; default: 1 | 生成結果數量,受模型限制。 |
stream | boolean | 否 | default: false | 請求增量串流事件。 |
stream_options | object | 否 | — | 串流選項,例如模型支援的用量回傳。 |
stop | string / string[] | 否 | — | — |
max_tokens | integer | 否 | — | 輸出 token 上限,取決於模型。 |
max_completion_tokens | integer | 否 | — | 相容模型的補全 token 預算。 |
presence_penalty | number | 否 | ≥ -2; ≤ 2; default: 0 | — |
frequency_penalty | number | 否 | ≥ -2; ≤ 2; default: 0 | — |
logit_bias | object | 否 | — | — |
user | string | 否 | — | — |
tools | Tool[] | 否 | — | 由應用提供的工具定義。 |
tool_choice | string / object | 否 | — | 控制工具的選擇方式。 |
response_format | ResponseFormat | 否 | — | 模型支援的輸出格式。 |
seed | integer | 否 | — | — |
reasoning_effort | string | 否 | low, medium, high | — |
modalities | string[] | 否 | — | — |
audio | object | 否 | — | — |
完整欄位定義、巢狀物件和引用結構可在下載的規格中查看。
請求範例
export NEON_API_KEY="YOUR_API_KEY"
curl https://neon-api.com/v1/chat/completions \
-H "Authorization: Bearer $NEON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "YOUR_MODEL_ID",
"messages": [
{
"role": "user",
"content": "Hello"
}
]
}'回應說明
實際欄位因模型與協定而異。下方結構描述文件中的成功回應;串流請求使用對應協定的事件。
| 狀態碼 | 意義 |
|---|---|
| 200 | 請求成功 |
| 400 | 請求參數錯誤 |
| 429 | 請求頻率受限 |
回應結構
| 欄位 | 類型 | 必填 | 限制 | 意義 |
|---|---|---|---|---|
id | string | 否 | — | 該結果或任務的識別碼。 |
object | string | 否 | — | — |
created | integer | 否 | — | — |
model | string | 否 | — | 模型廣場發布的準確 ID。 |
choices | object[] | 否 | — | 產生的補全候選結果。 |
usage | Usage | 否 | — | 目前協定回傳的用量資料。 |
system_fingerprint | string | 否 | — | — |
另見常見錯誤與串流回應和非同步任務。