Skip to content

API 参考 ​

ModelFold 的 HTTP 接口分成两组:

分组前缀鉴权用途
模型网关/v1API Key调用图像、视频、对话模型
控制台接口/api登录令牌(JWT)注册登录、账号资料、API Key、钱包、邮件

两组接口都在同一个域名下:

text
https://ai.modelfold.online          # 当前部署地址
https://ai.modelfold.online     # 正式域名(上线后启用)

模型网关 /v1 ​

方法路径说明
GET/v1/models列出当前可用的模型
POST/v1/images/generations图像生成与编辑
POST/v1/videos/generations视频生成
POST/v1/chat/completions对话补全(OpenAI 兼容)

详见 API 网关。

控制台接口 /api ​

方法路径说明
POST/api/auth/register注册
POST/api/auth/login登录,返回 JWT
GET/api/auth/me当前登录用户
POST/api/auth/logout退出登录,吊销当前会话
GET/api/account用户中心概览
PUT/api/account/profile修改昵称
POST/api/account/avatar上传头像
DELETE/api/account/avatar删除头像
POST/api/account/password修改密码
GET/api/account/sessions登录设备列表
DELETE/api/account/sessions/:id退出指定设备
DELETE/api/account/sessions退出其它全部设备
GET/api/keys列出 API Key
POST/api/keys创建 API Key
DELETE/api/keys/:id吊销 API Key
GET/api/wallet余额与流水
POST/api/wallet/topup充值
GET/api/wallet/usage调用记录
GET/api/mail/status邮件通道状态
POST/api/mail/test发送测试邮件
POST/api/email/verify完成邮箱验证
POST/api/email/resend重发验证邮件
POST/api/email/forgot申请重置密码
POST/api/email/reset用令牌重置密码
GET/api/health健康检查

分页说明:目前所有列表接口都返回最近若干条记录(流水 50 条、调用记录 100 条),未提供分页参数。

统一响应结构 ​

成功时:

json
{ "ok": true, "...": "各接口自有字段" }

失败时:

json
{ "ok": false, "error": { "type": "insufficient_credits", "message": "积分不足:需要 18,当前 5" } }

少数控制台接口的 error 是字符串而非对象(例如登录失败返回 {"ok":false,"error":"invalid_credentials"}),以各接口页面上的说明为准。

速率限制 ​

范围限制
/v1 网关每 Key 每分钟 60 次
创建 API Key每账号每分钟 30 次
注册 / 登录每 IP 每 10 分钟 30 次
修改密码每账号每 10 分钟 30 次
充值每账号每分钟 10 次
邮箱相关(重发 / 找回 / 重置)每 IP 每 10 分钟 10 次
发送测试邮件每账号每 10 分钟 5 次

超限返回 429。响应头使用 RateLimit / RateLimit-Policy(draft-7)。

错误码 ​

HTTP含义
400参数不合法(邮箱格式、密码强度、模型与端点不匹配等)
401未认证或凭证已失效
402余额不足
403账号被停用
404资源不存在
409冲突(邮箱已注册)
429触发速率限制
500服务端异常
502上游调用失败(网关场景下已自动退款)
503上游尚未配置

健康检查 ​

bash
curl https://ai.modelfold.online/api/health
json
{ "ok": true, "db": "up" }

数据库不可用时返回 503 与 {"ok":false,"db":"down"}。

ModelFold — 一个 API,接入所有主流 AI 模型。