OhMyGPT公开API文档
  1. OAuth
  • 本站介绍
  • 更新日志
  • OpenAI
    • Responses
      • 创建 model response
      • 获取 model response
      • 删除 model response
      • 取消响应
      • 列出 input items
    • Conversations
      • 创建 conversation
      • 检索 conversation
      • 更新 conversation
      • 删除 conversation
      • 创建 items
      • 列出 items
      • 检索 item
      • 删除 item
    • 创建 completion
      POST
    • TTS文本转语音
      POST
    • Embeddings
      POST
    • 图像生成
      POST
    • 图像编辑
      POST
  • Claude
    • Anthropic 原生 Completions 企业商用 API
      POST
    • Anthropic 原生 Messages API
      POST
    • Anthropic 原生 Messages Token Count API
      POST
  • 图像生成
    • 其它
      • ND图像生成 API
    • Flux
      • Flux Schnell 图像生成
      • Flux Dev 图像生成
      • Flux Pro 图像生成
      • Flux Pro 1.1 图像生成
      • Flux 1.1 Pro Ultura 图像生成
  • 覆写规则
    • 创建规则
    • 更新规则
    • 删除规则
    • 获取规则
    • 列出规则
    • 批量启用/禁用
    • 复制规则
    • 测试规则
    • 获取统计信息
    • 获取限制配置
    • 检查规则名
    • 批量删除
    • 导出规则
    • 导入规则
  • Store
    • 列出聊天完成项
    • 获取聊天完成
    • 删除聊天完成
  • OAuth
    • 开放OAuth API介绍
    • 用户授权页
      GET
    • Code展示页
      GET
    • 申请access_token
      POST
    • 读取用户基本信息
      POST
    • 读取用户余额信息
      POST
    • 收取用户费用
      POST
    • 为用户创建一个Stripe Checkout充值订单
      POST
    • 为用户创建一个Stripe Invoice充值订单
      POST
    • 调用其它开放API
      POST
    • 通过OAuth Token读取用户管理Token
      POST
    • 通过OAuth Token更新用户管理Token
      POST
  • 存储服务
    • 文件存储服务
    • 文件上传
    • 文件信息更新
    • 删除文件
    • 用户查询 (分页)
    • 用户元数据查询 (by fileUinqueIds)
    • 文件下载接口(Public公开文件下载)
    • 文件下载接口(Private私有文件下载)
    • 公开文件元数据获取
  • API KEY 管理
    • 创建新的API Key
    • 修改API Key信息
    • 查询用户所有的API Key
    • 删除指定API Key
    • 查询用户会员到期日期接口
    • 用户余额查询接口
    • 查询当前模型倍率接口
  • 其它
    • 搜索
      • Google Custom Search API
      • Google Search By Serper
    • Azure
      • Azure 文本转语音
      • Azure 获取TTS 语音列表
    • [Beta] OhMyGPT Socket.IO 统一API端点
  • 归档文档
    • 自助开票系统使用文档
    • Telegram Bot使用文档
    • 自建Cloudflare Worker反代教程
    • Claude Code转发服务
    • CodeX转发服务
    • 新版网站介绍
  • 模型列表
    GET
  1. OAuth

申请access_token

line1
https://cn2us02.opapi.win
line1
https://cn2us02.opapi.win
POST
/api/v1/user/oauth/issue-token
OAuth APP服务端通过自己的client_id+client_secret以及从用户那里拿到的code请求OAuth Access Token
拿到用户的OAuth Token后,即可调用各种开放API以访问用户授权的资源
但需要注意处理OAuth Token被撤销的情况
用户可以随时撤销对您的OAuth App的授权,此时会返回4xx错误+如下格式的响应:
{
    "statusCode": 401,
    "message": "Incorrect OhMyGPT OAuth token provided. Please try to re-authenticate with the OAuth provider.",
    "errorType": "oauth_invalid_token_error",
    "data": null
}
只要发现 errorType 为 oauth_invalid_token_error 即证明此Token无效,可丢弃此Token并要求用户重新授权
如果遇到余额不足的错误:
{
    "statusCode": 402,
    "message": "User balance is insufficient, your request has been rejected, please recharge in time at https://www.ohmygpt.com/pay .",
    "errorType": "insufficient_balance_error",
    "data": null
}
以上报错表示用户余额不足,此时该用户大部分的API调用权限将被限制,建议提示用户前往网站进行充值以解除限制

请求参数

Body 参数application/x-www-form-urlencoded

返回响应

🟢200成功
application/json
Body

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://cn2us02.opapi.win/api/v1/user/oauth/issue-token' \
--data-urlencode 'client_id=6680e0785ffd0e948c705db7' \
--data-urlencode 'client_secret=TREAHK4hnqEmST4YjD8Ki8338HyrmEDc' \
--data-urlencode 'code=code'
响应示例响应示例
成功示例
{
    "statusCode": 200,
    "message": "Issue OAuth Token success",
    "data": {
        "user_id": "888",
        "client_id": "6681463833ebdbb2566d1def",
        "token": "omg-oat-v1-VVfxxxx4BG6xaxxxxrnS"
    }
}
修改于 2024-07-11 04:00:26
上一页
Code展示页
下一页
读取用户基本信息
Built with