概述
本文档详细介绍了如何使用我们的 API 服务。通过本 API,您可以轻松集成我们的AI能力到您的应用程序中,实现智能对话、内容生成、数据分析等功能。
API 采用 RESTful 架构设计,支持 HTTP/HTTPS 协议,返回数据格式为 JSON。所有请求都需要通过身份验证,确保数据安全性和访问控制。
身份验证
API 使用 API Key 进行身份验证。每次请求都需要在 HTTP Header 中包含您的 API Key。
安全提示
请妥善保管您的 API Key,不要在代码中硬编码或在公开的代码仓库中提交。建议使用环境变量或配置文件来存储 API Key。
在请求头中添加以下字段:
1
Authorization: Bearer your-api-key-here
API 端点
以下是主要的 API 端点列表:
| 方法 | 端点 | 描述 |
|---|---|---|
GET |
/v1/models |
获取可用模型列表 |
POST |
/v1/chat/completions |
创建对话完成 |
GET |
/v1/completions/{id} |
获取完成结果 |
POST |
/v1/image/generations |
生成图像 |
POST |
/v1/video/generations |
生成视频 |
POST |
/v1/tasks/{id} |
查询生成任务 |
GET |
/v1/usage |
查询使用统计 |
示例端点详情
POST
/api/v1/chat/completions
创建新的对话完成请求,支持流式和非流式响应。
使用示例
以下是如何使用 API 的实际代码示例:
cURL 示例
1
curl -X POST https://api.aitumo.cn/v1/chat/completions \
2
-H "Authorization: Bearer YOUR_API_KEY" \
3
-H "Content-Type: application/json" \
4
-d
'{
5
"model": "deepseek-v4-flash",
6
"messages": [
7
{"role": "user", "content": "Hello, how are you?"}
8
]
9
}'
Python 示例
1
import requests
2
3
url = "https://api.aitumo.cn/v1/chat/completions"
4
headers = {
5
"Authorization": f"Bearer {YOUR_API_KEY}",
6
"Content-Type": "application/json"
7
}
8
data = {
9
"model": "deepseek-v4-flash",
10
"messages": [
11
{"role": "user", "content": "Hello, how are you?"}
12
]
13
}
14
15
response = requests.post(url, headers=headers, json=data)
16
print(response.json())
JavaScript 示例
1
const url = 'https://api.aitumo.cn/v1/chat/completions';
2
const headers = {
3
'Authorization': `Bearer ${YOUR_API_KEY}`,
4
'Content-Type': 'application/json'
5
};
6
const data = {
7
model: 'deepseek-v4-flash',
8
messages: [
9
{role: 'user', content: 'Hello, how are you?'}
10
]
11
};
12
13
fetch(url, {
14
method: 'POST',
15
headers,
16
body: JSON.stringify(data)
17
})
18
.then(response => response.json())
19
.then(data => console.log(data));
错误处理
API 使用标准的 HTTP 状态码来指示请求的成功或失败。错误响应会包含详细的错误信息。
| 状态码 | 描述 | 解决方案 |
|---|---|---|
200 |
请求成功 | 无需处理 |
400 |
请求参数错误 | 检查请求参数格式和内容 |
401 |
未授权 | 检查 API Key 是否正确 |
403 |
禁止访问 | 检查权限或联系管理员 |
404 |
资源不存在 | 检查请求端点是否正确 |
429 |
请求过于频繁 | 降低请求频率或升级套餐 |
500 |
服务器内部错误 | 稍后重试或联系技术支持 |
错误响应示例
1
{
2
"error": {
3
"code": "invalid_api_key",
4
"message": "Invalid API key provided",
5
"type": "authentication_error"
6
}
7
}
使用限制
重要提示
为了确保服务的稳定性和公平性,我们对 API 调用设置了合理的限制。请在使用前了解这些限制。
速率限制
| 套餐级别 | 每分钟请求 | 每天请求 | 并发连接 |
|---|---|---|---|
| 普通用户 | 20 | 10,000 | 5 |
| OPC会员 | 100 | 50,000 | 20 |
| VIP会员 | 1,000 | 无限制 | 100 |
Token 限制
每次请求的 Token 数量也有以下限制:
- 最大输入 Token 数: 960k
- 最大输出 Token 数: 64k
- 单次请求最大 Token 数: 1024k
优化建议
建议合理控制每次请求的 Token 使用量,避免不必要的资源浪费。对于长文本处理,可以考虑分批次请求或使用流式响应。