API Reference

原生Claude格式

请求地址：http://localhost:3000/v1/messages

Anthropic Claude Messages API 格式的请求。 需要在请求头中包含 anthropic-version。

请求参数

请求体

响应

Gemini媒体识别

请求地址：http://localhost:3000/v1beta/models/{model}:generateContent

Gemini图像、PDF、音频、视频识别请求 ⚠️注意：仅支持通过 inlineData 以 base64 方式上传图像、PDF、音频、视频，不支持 fileData.fileUri 或 File API。

请求参数

请求体

响应

Gemini文本聊天

请求地址：http://localhost:3000/v1beta/models/{model}:generateContent

代理 Gemini API 请求。 路径格式: /v1beta/models/{model_name}:{action}

例如:

/v1beta/models/gemini-2.5-pro:generateContent

/v1beta/models/gemini-2.5-pro:streamGenerateContent?alt=sse

请求参数

请求体

响应

ChatCompletions格式

请求地址：http://localhost:3000/v1/chat/completions

根据对话历史创建模型响应。支持流式和非流式响应。 兼容 OpenAI Chat Completions API。

请求体

响应

Responses格式

请求地址：http://localhost:3000/v1/responses

OpenAI Responses API，用于创建模型响应。 支持多轮对话、工具调用、推理等功能。

请求体

响应

Gemini原生格式

请求地址：http://localhost:3000/v1beta/models/{model}:generateContent/

Gemini 图片生成

请求参数

请求体

响应

OpenAI聊天格式

请求地址：http://localhost:3000/v1/chat/completions

Gemini 图片生成

请求体

响应

编辑图像

请求地址：http://localhost:3000/v1/images/edits/

请求体

响应

生成图像

请求地址：http://localhost:3000/v1/images/generations/

在给定提示的情况下创建图像。了解更多。

请求体

响应

原生OpenAI格式

请求地址：http://localhost:3000/v1/models

获取当前可用的模型列表。 根据请求头自动识别返回格式：

包含 x-api-key 和 anthropic-version 头时返回 Anthropic 格式

包含 x-goog-api-key 头或 key 查询参数时返回 Gemini 格式

其他情况返回 OpenAI 格式

请求参数

响应

原生Gemini格式

请求地址：http://localhost:3000/v1beta/models

以 Gemini API 格式返回可用模型列表

响应

批量删除渠道

请求地址：http://localhost:3000/api/channel/batch

👨‍💼 需要管理员权限（Admin）

请求体

响应

批量设置渠道标签

请求地址：http://localhost:3000/api/channel/batch/tag

👨‍💼 需要管理员权限（Admin）

请求体

响应

复制渠道

请求地址：http://localhost:3000/api/channel/copy/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

删除已禁用渠道

请求地址：http://localhost:3000/api/channel/disabled

👨‍💼 需要管理员权限（Admin）

响应

获取可用模型列表

请求地址：http://localhost:3000/api/channel/fetch_models/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取模型列表

请求地址：http://localhost:3000/api/channel/fetch_models

👨‍💼 需要管理员权限（Admin）

请求体

响应

修复渠道能力

请求地址：http://localhost:3000/api/channel/fix

👨‍💼 需要管理员权限（Admin）

响应

获取所有渠道

请求地址：http://localhost:3000/api/channel/

👨‍💼 需要管理员权限（Admin）

请求参数

响应

删除渠道

请求地址：http://localhost:3000/api/channel/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取指定渠道

请求地址：http://localhost:3000/api/channel/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取渠道密钥

请求地址：http://localhost:3000/api/channel/{id}/key

👑 需要超级管理员权限（Root）+ 安全验证

请求参数

响应

获取已启用模型列表

请求地址：http://localhost:3000/api/channel/models_enabled

👨‍💼 需要管理员权限（Admin）

响应

获取渠道模型列表

请求地址：http://localhost:3000/api/channel/models

👨‍💼 需要管理员权限（Admin）

响应

管理多密钥

请求地址：http://localhost:3000/api/channel/multi_key/manage

👨‍💼 需要管理员权限（Admin）

请求体

响应

添加渠道

请求地址：http://localhost:3000/api/channel/

👨‍💼 需要管理员权限（Admin）

请求体

响应

更新渠道

请求地址：http://localhost:3000/api/channel/

👨‍💼 需要管理员权限（Admin）

响应

搜索渠道

请求地址：http://localhost:3000/api/channel/search

👨‍💼 需要管理员权限（Admin）

请求参数

响应

禁用标签渠道

请求地址：http://localhost:3000/api/channel/tag/disabled

👨‍💼 需要管理员权限（Admin）

请求体

响应

启用标签渠道

请求地址：http://localhost:3000/api/channel/tag/enabled

👨‍💼 需要管理员权限（Admin）

请求体

响应

获取标签模型

请求地址：http://localhost:3000/api/channel/tag/models

👨‍💼 需要管理员权限（Admin）

请求参数

响应

编辑标签渠道

请求地址：http://localhost:3000/api/channel/tag

👨‍💼 需要管理员权限（Admin）

请求体

响应

测试所有渠道

请求地址：http://localhost:3000/api/channel/test

👨‍💼 需要管理员权限（Admin）

响应

测试指定渠道

请求地址：http://localhost:3000/api/channel/test/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

更新所有渠道余额

请求地址：http://localhost:3000/api/channel/update_balance

👨‍💼 需要管理员权限（Admin）

响应

更新指定渠道余额

请求地址：http://localhost:3000/api/channel/update_balance/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

使用兑换码

请求地址：http://localhost:3000/api/user/topup

🔐 需要登录（User权限）

请求体

响应

获取所有分组

请求地址：http://localhost:3000/api/group/

👨‍💼 需要管理员权限（Admin）

响应

获取预填分组

请求地址：http://localhost:3000/api/prefill_group/

👨‍💼 需要管理员权限（Admin）

响应

删除预填分组

请求地址：http://localhost:3000/api/prefill_group/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

创建预填分组

请求地址：http://localhost:3000/api/prefill_group/

👨‍💼 需要管理员权限（Admin）

响应

更新预填分组

请求地址：http://localhost:3000/api/prefill_group/

👨‍💼 需要管理员权限（Admin）

响应

删除历史日志

请求地址：http://localhost:3000/api/log/

👨‍💼 需要管理员权限（Admin）

响应

获取所有日志

请求地址：http://localhost:3000/api/log/

👨‍💼 需要管理员权限（Admin）

请求参数

响应

搜索日志

请求地址：http://localhost:3000/api/log/search

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取个人日志

请求地址：http://localhost:3000/api/log/self

🔐 需要登录（User权限）

响应

搜索个人日志

请求地址：http://localhost:3000/api/log/self/search

🔐 需要登录（User权限）

请求参数

响应

获取个人日志统计

请求地址：http://localhost:3000/api/log/self/stat

🔐 需要登录（User权限）

响应

获取日志统计

请求地址：http://localhost:3000/api/log/stat

👨‍💼 需要管理员权限（Admin）

响应

通过令牌获取日志

请求地址：http://localhost:3000/api/log/token

🔓 无需鉴权（通过令牌查询）

请求参数

响应

获取所有模型元数据

请求地址：http://localhost:3000/api/models/

👨‍💼 需要管理员权限（Admin）

响应

删除模型

请求地址：http://localhost:3000/api/models/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取指定模型

请求地址：http://localhost:3000/api/models/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取缺失模型

请求地址：http://localhost:3000/api/models/missing

👨‍💼 需要管理员权限（Admin）

响应

创建模型元数据

请求地址：http://localhost:3000/api/models/

👨‍💼 需要管理员权限（Admin）

响应

更新模型元数据

请求地址：http://localhost:3000/api/models/

👨‍💼 需要管理员权限（Admin）

响应

搜索模型

请求地址：http://localhost:3000/api/models/search

👨‍💼 需要管理员权限（Admin）

请求参数

响应

同步可用模型

请求地址：http://localhost:3000/api/models/sync_upstream

👨‍💼 需要管理员权限（Admin）

响应

预览可用模型同步

请求地址：http://localhost:3000/api/models/sync_upstream/preview

👨‍💼 需要管理员权限（Admin）

响应

Discord OAuth登录

请求地址：http://localhost:3000/api/oauth/discord

🔓 无需鉴权（OAuth回调）

请求参数

响应

绑定邮箱

请求地址：http://localhost:3000/api/oauth/email/bind

🔓 无需鉴权

请求参数

响应

GitHub OAuth登录

请求地址：http://localhost:3000/api/oauth/github

🔓 无需鉴权（OAuth回调）

请求参数

响应

LinuxDO OAuth登录

请求地址：http://localhost:3000/api/oauth/linuxdo

🔓 无需鉴权（OAuth回调）

响应

OIDC登录

请求地址：http://localhost:3000/api/oauth/oidc

🔓 无需鉴权（OAuth回调）

响应

生成OAuth State

请求地址：http://localhost:3000/api/oauth/state

🔓 无需鉴权

响应

绑定Telegram

请求地址：http://localhost:3000/api/oauth/telegram/bind

🔓 无需鉴权

响应

Telegram登录

请求地址：http://localhost:3000/api/oauth/telegram/login

🔓 无需鉴权（OAuth回调）

响应

绑定微信

请求地址：http://localhost:3000/api/oauth/wechat/bind

🔓 无需鉴权

响应

微信OAuth登录

请求地址：http://localhost:3000/api/oauth/wechat

🔓 无需鉴权（OAuth回调）

响应

Creem Webhook

请求地址：http://localhost:3000/api/creem/webhook

🔓 无需鉴权（Webhook回调）

响应

Stripe Webhook

请求地址：http://localhost:3000/api/stripe/webhook

🔓 无需鉴权（Webhook回调）

响应

获取支付金额

请求地址：http://localhost:3000/api/user/amount

🔐 需要登录（User权限）

响应

发起Creem支付

请求地址：http://localhost:3000/api/user/creem/pay

🔐 需要登录（User权限）

响应

易支付回调

请求地址：http://localhost:3000/api/user/epay/notify

🔓 无需鉴权（支付回调）

响应

发起易支付

请求地址：http://localhost:3000/api/user/pay

🔐 需要登录（User权限）

响应

获取Stripe支付金额

请求地址：http://localhost:3000/api/user/stripe/amount

🔐 需要登录（User权限）

响应

发起Stripe支付

请求地址：http://localhost:3000/api/user/stripe/pay

🔐 需要登录（User权限）

响应

获取充值信息

请求地址：http://localhost:3000/api/user/topup/info

🔐 需要登录（User权限）

响应

获取用户充值记录

请求地址：http://localhost:3000/api/user/topup/self

🔐 需要登录（User权限）

响应

获取所有兑换码

请求地址：http://localhost:3000/api/redemption/

👨‍💼 需要管理员权限（Admin）

请求参数

响应

删除兑换码

请求地址：http://localhost:3000/api/redemption/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取指定兑换码

请求地址：http://localhost:3000/api/redemption/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

删除无效兑换码

请求地址：http://localhost:3000/api/redemption/invalid

👨‍💼 需要管理员权限（Admin）

响应

创建兑换码

请求地址：http://localhost:3000/api/redemption/

👨‍💼 需要管理员权限（Admin）

响应

更新兑换码

请求地址：http://localhost:3000/api/redemption/

👨‍💼 需要管理员权限（Admin）

响应

搜索兑换码

请求地址：http://localhost:3000/api/redemption/search

👨‍💼 需要管理员权限（Admin）

请求参数

响应

通用安全验证

请求地址：http://localhost:3000/api/verify

🔐 需要登录（User权限）

响应

获取验证状态

请求地址：http://localhost:3000/api/verify/status

🔐 需要登录（User权限）

响应

获取所有额度数据

请求地址：http://localhost:3000/api/data/

👨‍💼 需要管理员权限（Admin）

响应

获取个人额度数据

请求地址：http://localhost:3000/api/data/self

🔐 需要登录（User权限）

响应

获取系统选项

请求地址：http://localhost:3000/api/option/

👑 需要超级管理员权限（Root）

响应

迁移控制台设置

请求地址：http://localhost:3000/api/option/migrate_console_setting

👑 需要超级管理员权限（Root）

响应

更新系统选项

请求地址：http://localhost:3000/api/option/

👑 需要超级管理员权限（Root）

响应

重置模型倍率

请求地址：http://localhost:3000/api/option/rest_model_ratio

👑 需要超级管理员权限（Root）

响应

获取可同步渠道

请求地址：http://localhost:3000/api/ratio_sync/channels

👑 需要超级管理员权限（Root）

响应

获取可用倍率

请求地址：http://localhost:3000/api/ratio_sync/fetch

👑 需要超级管理员权限（Root）

响应

获取关于信息

请求地址：http://localhost:3000/api/about

🔓 无需鉴权

响应

获取首页内容

请求地址：http://localhost:3000/api/home_page_content

🔓 无需鉴权

响应

获取模型列表

请求地址：http://localhost:3000/api/models

🔐 需要登录（User权限）

响应

获取公告

请求地址：http://localhost:3000/api/notice

🔓 无需鉴权

响应

获取定价信息

请求地址：http://localhost:3000/api/pricing

🔓 无需鉴权（可选登录）

响应

获取隐私政策

请求地址：http://localhost:3000/api/privacy-policy

🔓 无需鉴权

响应

获取倍率配置

请求地址：http://localhost:3000/api/ratio_config

🔓 无需鉴权

响应

获取初始化状态

请求地址：http://localhost:3000/api/setup

🔓 无需鉴权

响应

初始化系统

请求地址：http://localhost:3000/api/setup

🔓 无需鉴权

请求体

响应

获取系统状态

请求地址：http://localhost:3000/api/status

🔓 无需鉴权

响应

测试系统状态

请求地址：http://localhost:3000/api/status/test

👨‍💼 需要管理员权限（Admin）

响应

获取Uptime Kuma状态

请求地址：http://localhost:3000/api/uptime/status

🔓 无需鉴权

响应

获取用户协议

请求地址：http://localhost:3000/api/user-agreement

🔓 无需鉴权

响应

获取所有Midjourney任务

请求地址：http://localhost:3000/api/mj/

👨‍💼 需要管理员权限（Admin）

响应

获取个人Midjourney任务

请求地址：http://localhost:3000/api/mj/self

🔐 需要登录（User权限）

响应

获取所有任务

请求地址：http://localhost:3000/api/task/

👨‍💼 需要管理员权限（Admin）

响应

获取个人任务

请求地址：http://localhost:3000/api/task/self

🔐 需要登录（User权限）

响应

批量删除令牌

请求地址：http://localhost:3000/api/token/batch

🔐 需要登录（User权限）

请求体

响应

获取所有令牌

请求地址：http://localhost:3000/api/token/

🔐 需要登录（User权限）

请求参数

响应

删除令牌

请求地址：http://localhost:3000/api/token/{id}

🔐 需要登录（User权限）

请求参数

响应

获取指定令牌

请求地址：http://localhost:3000/api/token/{id}

🔐 需要登录（User权限）

请求参数

响应

创建令牌

请求地址：http://localhost:3000/api/token/

🔐 需要登录（User权限）

响应

更新令牌

请求地址：http://localhost:3000/api/token/

🔐 需要登录（User权限）

响应

搜索令牌

请求地址：http://localhost:3000/api/token/search

🔐 需要登录（User权限）

请求参数

响应

获取令牌使用情况

请求地址：http://localhost:3000/api/usage/token/

🔑 需要令牌认证（TokenAuth）

请求参数

响应

重新生成备用码

请求地址：http://localhost:3000/api/user/2fa/backup_codes

🔐 需要登录（User权限）

响应

禁用2FA

请求地址：http://localhost:3000/api/user/2fa/disable

🔐 需要登录（User权限）

请求体

响应

启用2FA

请求地址：http://localhost:3000/api/user/2fa/enable

🔐 需要登录（User权限）

请求体

响应

设置2FA

请求地址：http://localhost:3000/api/user/2fa/setup

🔐 需要登录（User权限）

响应

获取2FA统计

请求地址：http://localhost:3000/api/user/2fa/stats

👨‍💼 需要管理员权限（Admin）

响应

获取2FA状态

请求地址：http://localhost:3000/api/user/2fa/status

🔐 需要登录（User权限）

响应

发送密码重置邮件

请求地址：http://localhost:3000/api/reset_password

🔓 无需鉴权

请求参数

响应

获取用户分组列表

请求地址：http://localhost:3000/api/user/groups

🔓 无需鉴权

响应

两步验证登录

请求地址：http://localhost:3000/api/user/login/2fa

🔓 无需鉴权（登录流程）

请求体

响应

用户登录

请求地址：http://localhost:3000/api/user/login

🔓 无需鉴权

请求体

响应

用户登出

请求地址：http://localhost:3000/api/user/logout

🔓 无需鉴权

响应

开始Passkey登录

请求地址：http://localhost:3000/api/user/passkey/login/begin

🔓 无需鉴权

响应

完成Passkey登录

请求地址：http://localhost:3000/api/user/passkey/login/finish

🔓 无需鉴权

响应

用户注册

请求地址：http://localhost:3000/api/user/register

🔓 无需鉴权

请求体

响应

重置密码

请求地址：http://localhost:3000/api/user/reset

🔓 无需鉴权

请求体

响应

发送邮箱验证码

请求地址：http://localhost:3000/api/verification

🔓 无需鉴权

请求参数

响应

转换邀请额度

请求地址：http://localhost:3000/api/user/aff_transfer

🔐 需要登录（User权限）

请求体

响应

获取邀请码

请求地址：http://localhost:3000/api/user/aff

🔐 需要登录（User权限）

响应

获取所有用户

请求地址：http://localhost:3000/api/user/

👨‍💼 需要管理员权限（Admin）

请求参数

响应

管理员禁用用户2FA

请求地址：http://localhost:3000/api/user/{id}/2fa

👨‍💼 需要管理员权限（Admin）

请求参数

响应

删除用户

请求地址：http://localhost:3000/api/user/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取指定用户

请求地址：http://localhost:3000/api/user/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

管理员重置用户Passkey

请求地址：http://localhost:3000/api/user/{id}/reset_passkey

👨‍💼 需要管理员权限（Admin）

请求参数

响应

管理用户状态

请求地址：http://localhost:3000/api/user/manage

👨‍💼 需要管理员权限（Admin）

请求体

响应

获取用户可用模型

请求地址：http://localhost:3000/api/user/models

🔐 需要登录（User权限）

响应

删除Passkey

请求地址：http://localhost:3000/api/user/passkey

🔐 需要登录（User权限）

响应

获取Passkey状态

请求地址：http://localhost:3000/api/user/passkey

🔐 需要登录（User权限）

响应

开始注册Passkey

请求地址：http://localhost:3000/api/user/passkey/register/begin

🔐 需要登录（User权限）

响应

完成注册Passkey

请求地址：http://localhost:3000/api/user/passkey/register/finish

🔐 需要登录（User权限）

响应

开始验证Passkey

请求地址：http://localhost:3000/api/user/passkey/verify/begin

🔐 需要登录（User权限）

响应

完成验证Passkey

请求地址：http://localhost:3000/api/user/passkey/verify/finish

🔐 需要登录（User权限）

响应

创建用户

请求地址：http://localhost:3000/api/user/

👨‍💼 需要管理员权限（Admin）

响应

更新用户

请求地址：http://localhost:3000/api/user/

👨‍💼 需要管理员权限（Admin）

响应

搜索用户

请求地址：http://localhost:3000/api/user/search

👨‍💼 需要管理员权限（Admin）

请求参数

响应

注销当前用户

请求地址：http://localhost:3000/api/user/self

🔐 需要登录（User权限）

响应

获取当前用户信息

请求地址：http://localhost:3000/api/user/self

🔐 需要登录（User权限）

响应

获取当前用户分组

请求地址：http://localhost:3000/api/user/self/groups

🔐 需要登录（User权限）

响应

更新当前用户信息

请求地址：http://localhost:3000/api/user/self

🔐 需要登录（User权限）

请求体

响应

更新用户设置

请求地址：http://localhost:3000/api/user/setting

🔐 需要登录（User权限）

请求体

响应

生成访问令牌

请求地址：http://localhost:3000/api/user/token

🔐 需要登录（User权限）

响应

管理员完成充值

请求地址：http://localhost:3000/api/user/topup/complete

👨‍💼 需要管理员权限（Admin）

响应

获取所有充值记录

请求地址：http://localhost:3000/api/user/topup

👨‍💼 需要管理员权限（Admin）

响应

获取所有供应商

请求地址：http://localhost:3000/api/vendors/

👨‍💼 需要管理员权限（Admin）

响应

删除供应商

请求地址：http://localhost:3000/api/vendors/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

获取指定供应商

请求地址：http://localhost:3000/api/vendors/{id}

👨‍💼 需要管理员权限（Admin）

请求参数

响应

创建供应商

请求地址：http://localhost:3000/api/vendors/

👨‍💼 需要管理员权限（Admin）

响应

更新供应商

请求地址：http://localhost:3000/api/vendors/

👨‍💼 需要管理员权限（Admin）

响应

搜索供应商

请求地址：http://localhost:3000/api/vendors/search

👨‍💼 需要管理员权限（Admin）

请求参数

响应