OhMyGPT公开API文档
  1. OAuth开放API
OhMyGPT公开API文档
  • 本站介绍
  • 更新日志
  • 新版网站介绍
  • 自助开票系统使用文档
  • Telegram Bot使用文档
  • 自建Cloudflare Worker反代教程
  • OhMyGPT Socket.IO 实时端点 [Alpha开放中]
  • Files文件存储服务 开放API
    • 文件存储服务
    • 文件上传
      POST
    • 文件信息更新
      POST
    • 删除文件
      POST
    • 用户查询 (分页)
      POST
    • 文件下载接口(Public公开文件下载)
      GET
    • 文件下载接口(Private私有文件下载)
      GET
  • OAuth开放API
    • 开放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
  • Midjourney、SD图像生成 API
    • Midjourney开放API接口
      • Midjourney服务说明文档
      • Midjourney 文生图 任务创建
      • Midjourney 执行动作 任务创建
      • Midjourney Blend 混合图生图 任务创建
      • Midjourney Describe prompt提取 任务创建
      • Midjourney 查询指定任务ID 的执行状态
      • Midjourney 分页批量查询任务
      • 从对象存储获取Midjourney生成的图片
      • 通过WSRV反代Discord图片
      • 通过WSRV反代并压缩Discord图片
      • 从对象存储+WSRV获取Midjourney生成的图片
      • 从对象存储+WSRV获取Midjourney生成的图片(压缩)
    • 其它图像生成API
      • ND图像生成 API
    • Flux图像生成
      • Flux Schnell 图像生成
      • Flux Dev 图像生成
      • Flux Pro 图像生成
      • Flux Pro 1.1 图像生成
      • Flux 1.1 Pro Ultura 图像生成
  • 管理API列表
    • 创建新的API Key
    • 修改API Key信息
    • 查询用户所有的API Key
    • 删除指定API Key
    • 查询用户会员到期日期接口
    • 用户余额查询接口
    • 查询当前模型倍率接口
  • Claude
    • Anthropic 原生 Messages API
    • Anthropic 原生 Completions 企业商用 API
    • Anthropic 原生 Messages Token Count API
  • OpenAI
    • 关于OpenAI兼容API接口说明
    • 关于Azure OpenAI API接口服务说明
    • Audio
      • TTS文本转语音服务
    • Chat
      • Chat Completion
      • Completion (Legacy)
    • Images
      • 图像生成
      • Image Edit
    • Embeddings
      • Embeddings
    • Realtime 实时通话端点
    • Models
  • 其它开放API
    • 搜索API
      • Google Custom Search API
      • Google Search By Serper
    • Azure API
      • Azure 文本转语音
      • Azure 获取TTS 语音列表
  1. OAuth开放API

申请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
client_id
string 
可选
OA APP的client_id
示例值:
6680e0785ffd0e948c705db7
client_secret
string 
可选
OA APP的client_secret
示例值:
TREAHK4hnqEmST4YjD8Ki8338HyrmEDc
code
string 
可选
OA APP从用户那边拿到的授权码
示例值:
code

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
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'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{
  "statusCode": 200,
  "message": "Issue OAuth Token success",
  "data": {
    "user_id": "888",
    "client_id": "6681463833ebdbb2566d1def",
    "token": "omg-oat-v1-VVfxxxx4BG6xaxxxxrnS"
  }
}
上一页
Code展示页
下一页
读取用户基本信息
Built with