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 | 否 | — | 当前协议返回的用量数据。 |