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 | 否 | — | — |