API 文档

使用 API Key 调用我们的封面生成服务

认证
所有 API 请求都需要在请求头中包含有效的 API Key

请求头格式

Authorization: Bearer YOUR_API_KEY

或者直接使用 API Key(不推荐):

Authorization: YOUR_API_KEY

提示: 您可以在 Dashboard → API Keys 页面创建和管理您的 API Keys

生成封面
根据文字描述生成小红书风格的封面图片

端点

POST /api/generate

请求示例

curl -X POST https://your-domain.com/api/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "今天天气真好"
  }'

JavaScript 示例

const response = await fetch('https://your-domain.com/api/generate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    description: '今天天气真好'
  })
});

const data = await response.json();
console.log(data.data.coverUrl);

Python 示例

import requests

url = 'https://your-domain.com/api/generate'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'description': '今天天气真好'
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
print(result['data']['coverUrl'])

请求参数

参数类型必需说明
descriptionstring要生成封面的文字描述,最大长度 500 字符

响应示例

{
  "success": true,
  "data": {
    "coverUrl": "https://your-domain.com/temp/1234567890-abc123.png",
    "description": "今天天气真好",
    "timestamp": "2024-01-01T12:00:00.000Z"
  },
  "meta": {
    "apiVersion": "v1",
    "requestId": "1234567890-abc123"
  }
}

响应字段说明

字段类型说明
successboolean请求是否成功
data.coverUrlstring生成的封面图片完整 URL
data.descriptionstring描述文本(截取前50字符)
data.timestampstring生成时间(ISO 8601 格式)
meta.apiVersionstringAPI 版本号
meta.requestIdstring请求唯一标识符

响应头

Header说明
X-RateLimit-Limit每小时请求限制数
X-RateLimit-Remaining当前剩余请求数
X-RateLimit-Reset重置时间(Unix 时间戳)
错误处理
API 返回的错误响应格式

错误响应格式

{
  "error": "错误类型",
  "message": "详细的错误信息"
}

常见错误码

状态码说明
400请求参数错误
401未授权,API Key 无效或缺失
429请求频率超限
500服务器内部错误

错误示例

401 - 未授权

{
  "error": "缺少认证信息",
  "message": "请在请求头中添加 Authorization: Bearer <your_api_key>"
}

429 - 请求频率超限

{
  "error": "请求频率超限",
  "message": "已达到每小时 100 次请求的限制",
  "resetAt": "2024-01-01T13:00:00.000Z"
}

响应头会包含 Retry-After 字段,表示需要等待的秒数

速率限制
每个 API Key 都有速率限制,防止滥用

默认限制

  • 默认速率限制:100 次/小时
  • 限制基于每个 API Key 独立计算
  • 限制按小时滚动重置

查看限制信息

每个响应都包含速率限制相关的响应头:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1704110400

提示: 如果您的应用需要更高的速率限制,请联系我们或升级您的订阅计划。

最佳实践
  • 妥善保管您的 API Key,不要将其提交到代码仓库
  • 使用环境变量存储 API Key
  • 监控速率限制响应头,避免触发 429 错误
  • 实现重试机制,处理临时性错误
  • 定期轮换 API Key,提高安全性
  • 为不同环境(开发、测试、生产)创建不同的 API Key