API 参考
HuanCode API 接口说明
基础信息
| 项目 | 值 |
|---|---|
| Base URL | https://api.huancode.com/v1 |
| 认证方式 | Bearer Token |
| 请求格式 | JSON |
| 响应格式 | JSON / SSE |
所有请求需要在 Header 中携带 API Key:
Authorization: Bearer YOUR_API_KEYResponses
创建模型响应,这是最常用的接口。详细参数请参考 OpenAI Responses 文档。
POST /v1/responses请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 模型名称,如 deepseek-v3.2、gpt-5.4 |
input | string / array | 是 | 输入内容,可以是字符串或消息数组 |
stream | boolean | 否 | 是否使用流式输出,默认 false |
temperature | number | 否 | 采样温度,0-2 之间,默认 1 |
max_output_tokens | integer | 否 | 最大生成 token 数 |
top_p | number | 否 | 核采样参数,0-1 之间 |
instructions | string | 否 | 系统指令,等同于 system message |
tools | array | 否 | 可用工具列表(web_search、function 等) |
input 格式
简单文本:
"你好"消息数组(多轮对话):
[
{"role": "developer", "content": "你是一个有帮助的助手"},
{"role": "user", "content": "你好"}
]支持的 role:developer、user、assistant。
响应示例
{
"id": "resp_abc123",
"object": "response",
"created_at": 1700000000,
"model": "gpt-5.4",
"output": [
{
"type": "message",
"role": "assistant",
"content": [
{
"type": "output_text",
"text": "你好!有什么可以帮助你的吗?"
}
]
}
],
"output_text": "你好!有什么可以帮助你的吗?",
"usage": {
"input_tokens": 10,
"output_tokens": 15,
"total_tokens": 25
}
}Chat Completions(兼容)
同时支持 Chat Completions 接口,适合已有集成的项目。部分模型(如 kimi-k2-thinking、glm-5.1)仅支持此接口。
POST /v1/chat/completions详细参数请参考 OpenAI Chat Completions 文档。
Models
列出可用的模型。
GET /v1/models响应示例
{
"object": "list",
"data": [
{
"id": "gpt-5.4",
"object": "model",
"owned_by": "openai"
},
{
"id": "claude-sonnet-4-20250514",
"object": "model",
"owned_by": "anthropic"
}
]
}错误码
| HTTP 状态码 | 说明 |
|---|---|
| 400 | 请求参数错误 / 余额不足(budget_exceeded) |
| 401 | API Key 无效或缺失 |
| 429 | 请求过于频繁,触发速率限制 |
| 500 | 服务端内部错误 |
| 503 | 上游模型服务不可用 |
错误响应格式
{
"error": {
"message": "Incorrect API key provided",
"type": "invalid_request_error",
"code": "invalid_api_key"
}
}常见错误示例
余额不足(Budget Exceeded)
当 API Key 的已用额度超过预算上限时,返回 HTTP 400:
{
"error": {
"message": "Budget has been exceeded! Current cost: 0.163962, Max budget: 0.1388888888888889",
"type": "budget_exceeded",
"param": null,
"code": "400"
}
}解决方法:前往控制台充值或提升预算上限。
API Key 无效
{
"error": {
"message": "Incorrect API key provided",
"type": "invalid_request_error",
"code": "invalid_api_key"
}
}解决方法:检查 API Key 是否正确,是否包含 Bearer 前缀。