API 文档
火速AI 提供完全兼容 OpenAI 格式的 RESTful API,支持聊天补全、文本嵌入、图片生成等多种能力。如果您已经熟悉 OpenAI API,可以零成本迁移到火速AI。
Base URL
https://api.huosu.com/v1所有 API 请求均使用 HTTPS 协议,不支持 HTTP 明文传输。
认证方式
火速AI 使用 Bearer Token 认证。在每个请求的 HTTP Header 中携带您的 API Key:
http
Authorization: Bearer YOUR_API_KEYAPI Key 可在 火速AI 控制台 的「API 密钥」页面创建和管理。
支持的 API 端点
聊天补全 (Chat Completions)
POST /v1/chat/completions最核心的对话接口,支持多轮对话、流式输出、函数调用、JSON Mode 等功能。
请求示例:
json
{
"model": "gpt-4o",
"messages": [
{"role": "system", "content": "你是一个有用的助手。"},
{"role": "user", "content": "请解释什么是大语言模型。"}
],
"temperature": 0.7,
"max_tokens": 2048,
"stream": false
}响应示例:
json
{
"id": "chatcmpl-abc123",
"object": "chat.completion",
"created": 1710000000,
"model": "gpt-4o",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "大语言模型(Large Language Model,LLM)是一种基于深度学习的人工智能模型..."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 25,
"completion_tokens": 150,
"total_tokens": 175
}
}关键参数说明:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 模型标识符,如 gpt-4o、claude-sonnet-4-20250514、deepseek-chat |
messages | array | 是 | 对话消息数组,包含 role 和 content |
temperature | number | 否 | 采样温度,0-2 之间,默认 1。值越低输出越确定 |
max_tokens | integer | 否 | 最大生成 Token 数 |
stream | boolean | 否 | 是否启用流式输出,默认 false |
top_p | number | 否 | 核采样参数,0-1 之间 |
tools | array | 否 | 函数调用工具定义 |
response_format | object | 否 | 响应格式控制,如 {"type": "json_object"} |
文本嵌入 (Embeddings)
POST /v1/embeddings将文本转换为向量表示,用于语义搜索、文本相似度计算、RAG 等场景。
请求示例:
json
{
"model": "text-embedding-3-small",
"input": "火速AI是一个智能模型聚合平台",
"encoding_format": "float"
}响应示例:
json
{
"object": "list",
"data": [
{
"object": "embedding",
"index": 0,
"embedding": [0.0023064255, -0.009327292, ...]
}
],
"model": "text-embedding-3-small",
"usage": {
"prompt_tokens": 12,
"total_tokens": 12
}
}图片生成 (Image Generations)
POST /v1/images/generations基于文本描述生成图片,支持 DALL-E 等图片生成模型。
请求示例:
json
{
"model": "dall-e-3",
"prompt": "一只可爱的橙色猫咪坐在电脑前写代码",
"n": 1,
"size": "1024x1024",
"quality": "standard"
}补全 (Completions)
POST /v1/completions传统文本补全接口,适用于代码补全等场景。
模型列表 (Models)
GET /v1/models获取当前可用的模型列表。
响应示例:
json
{
"object": "list",
"data": [
{
"id": "gpt-4o",
"object": "model",
"created": 1710000000,
"owned_by": "openai"
},
{
"id": "claude-sonnet-4-20250514",
"object": "model",
"created": 1710000000,
"owned_by": "anthropic"
}
]
}音频转写 (Audio Transcriptions)
POST /v1/audio/transcriptions将音频文件转换为文本,支持 Whisper 模型。
音频翻译 (Audio Translations)
POST /v1/audio/translations将音频文件翻译为英文文本。
内容审核 (Moderations)
POST /v1/moderations检测文本内容是否包含不当信息。
流式输出 (Streaming)
对于聊天补全接口,可以通过设置 stream: true 启用流式输出,获得更好的用户体验。流式响应使用 Server-Sent Events (SSE) 格式:
data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","choices":[{"delta":{"content":"你"},"index":0}]}
data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","choices":[{"delta":{"content":"好"},"index":0}]}
data: [DONE]错误码说明
当 API 请求出错时,会返回相应的 HTTP 状态码和错误信息:
| HTTP 状态码 | 错误类型 | 说明 |
|---|---|---|
| 400 | invalid_request_error | 请求参数错误,请检查请求体格式和参数值 |
| 401 | authentication_error | API Key 无效或已过期,请检查认证信息 |
| 403 | permission_error | 没有权限访问请求的资源或模型 |
| 404 | not_found_error | 请求的端点或模型不存在 |
| 429 | rate_limit_error | 请求频率超限,请稍后重试或联系客服提升限额 |
| 500 | server_error | 服务器内部错误,请稍后重试 |
| 502 | upstream_error | 上游模型服务异常,请稍后重试或切换其他模型 |
| 503 | service_unavailable | 服务暂时不可用,通常因为维护或过载 |
错误响应格式:
json
{
"error": {
"message": "Incorrect API key provided: sk-xxxx. You can find your API key at https://huosu.com",
"type": "authentication_error",
"code": "invalid_api_key"
}
}请求限制
| 限制项 | 默认值 | 说明 |
|---|---|---|
| 请求频率 | 60 RPM | 每分钟最大请求数,可申请提升 |
| 并发数 | 10 | 同时进行的请求数量 |
| 单次最大 Token | 取决于模型 | 不同模型支持的最大上下文长度不同 |
| 请求体大小 | 10 MB | 单次请求的最大 Payload 大小 |
如需更高的请求限制,请联系客服或在控制台提交工单。
