Skip to main content
POST
创建API Key

概述

创建新的API密钥,用于程序化的API访问。创建的API密钥可以用于聊天接口和其他需要认证的API端点。

认证方式

该接口需要用户已登录,使用访问令牌进行身份验证。

Header参数

string
required
访问令牌,格式为:Bearer your_access_token

请求参数

请求体

string
required
API密钥的名称,用于标识该密钥的用途
string
required
API密钥的描述信息,说明该密钥的用途和权限范围
string
required
API密钥的过期时间,格式为ISO 8601标准的时间字符串
array
required
API密钥的权限列表,例如:[“chat”, “upload”]

响应说明

成功响应

创建成功后,系统会返回新创建的API密钥信息,包括完整的密钥字符串。

响应字段说明

使用示例

创建API密钥

响应示例

权限说明

可用权限

  • chat: 访问聊天接口的权限
  • upload: 文件上传权限
  • admin: 管理员权限(包含所有权限)

权限组合

您可以根据需要组合不同的权限:
  • 仅聊天权限:["chat"]
  • 聊天和上传权限:["chat", "upload"]
  • 完全权限:["chat", "upload", "admin"]

安全建议

  1. 密钥保管:创建后请立即保存full_key值,系统不会再次显示
  2. 最小权限:遵循最小权限原则,只授予必要的权限
  3. 过期时间:设置合理的过期时间,定期轮换密钥
  4. 密钥存储:安全存储API密钥,避免在代码中硬编码
  5. 监控使用:定期监控API密钥的使用情况
  6. 撤销机制:发现密钥泄露时立即撤销并创建新密钥

使用API密钥

创建API密钥后,您可以在API请求的Header中使用:
注意:这与用户登录令牌的使用方式相同,但使用的是API密钥而非登录令牌。

Headers

Authorization
string
required

Body

application/json
name
string
required
description
string
required
expires_at
string
required
permissions
string[]
required

Response

200 - application/json
id
string
required
name
string
required
description
string
required
key_prefix
string
required
created_at
string
required
expires_at
string
required
last_used_at
null
required
permissions
string[]
required
is_active
boolean
required
created_by
string
required
full_key
string
required