API 參考
Claude 訊息
呼叫 NeonAPI 所需的端點、請求參數與回應結構。
POST /v1/messages
身分驗證
將 NeonAPI 金鑰放入 Authorization: Bearer YOUR_API_KEY 請求標頭,在可信應用環境中保管金鑰。
可用性與相容性
呼叫前核對模型的協定、權限、報價與支援參數。不支援的參數可能被拒絕。範例中的金鑰與模型均為佔位符。
路徑與查詢參數
| 欄位 | In | 類型 | 必填 |
|---|---|---|---|
anthropic-version | header | string | 是 |
x-api-key | header | string | 否 |
請求參數
application/json
| 欄位 | 類型 | 必填 | 限制 | 意義 |
|---|---|---|---|---|
model | string | 是 | — | 模型廣場發布的準確 ID。 |
messages | ClaudeMessage[] | 是 | — | 依序提供角色與內容組成的對話訊息。 |
system | string / object[] | 否 | — | — |
cache_control | object | 否 | — | — |
inference_geo | string | 否 | — | — |
max_tokens | integer | 是 | ≥ 1 | 輸出 token 上限,取決於模型。 |
temperature | number | 否 | ≥ 0; ≤ 1 | 模型支援時使用的取樣溫度。 |
top_p | number | 否 | — | 核取樣機率。 |
top_k | integer | 否 | — | — |
stream | boolean | 否 | — | 請求增量串流事件。 |
stop_sequences | string[] | 否 | — | — |
tools | object[] | 否 | — | 由應用提供的工具定義。 |
tool_choice | object | 否 | — | 控制工具的選擇方式。 |
thinking | object | 否 | — | — |
context_management | object | 否 | — | — |
output_config | object | 否 | — | — |
output_format | object | 否 | — | — |
container | string / object | 否 | — | — |
mcp_servers | object[] | 否 | — | — |
metadata | object | 否 | — | — |
speed | string | 否 | standard, fast | — |
service_tier | string | 否 | auto, standard_only | — |
完整欄位定義、巢狀物件和引用結構可在下載的規格中查看。
請求範例
export NEON_API_KEY="YOUR_API_KEY"
curl https://neon-api.com/v1/messages \
-H "Authorization: Bearer $NEON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "YOUR_MODEL_ID",
"messages": [
{
"role": "user",
"content": "Hello"
}
],
"max_tokens": 256
}'回應說明
實際欄位因模型與協定而異。下方結構描述文件中的成功回應;串流請求使用對應協定的事件。
| 狀態碼 | 意義 |
|---|---|
| 200 | 請求成功 |
回應結構
| 欄位 | 類型 | 必填 | 限制 | 意義 |
|---|---|---|---|---|
id | string | 否 | — | 該結果或任務的識別碼。 |
type | string | 否 | — | — |
role | string | 否 | — | — |
content | object[] | 否 | — | — |
model | string | 否 | — | 模型廣場發布的準確 ID。 |
stop_reason | string | 否 | end_turn, max_tokens, stop_sequence, tool_use | — |
usage | object | 否 | — | 目前協定回傳的用量資料。 |
另見常見錯誤與串流回應和非同步任務。