OhMyGPT公开API文档
  1. Files文件存储服务 开放API
OhMyGPT公开API文档
  • 本站介绍
  • 更新日志
  • 新版网站介绍
  • 自助开票系统使用文档
  • Telegram Bot使用文档
  • 自建Cloudflare Worker反代教程
  • OhMyGPT Socket.IO 实时端点 [Alpha开放中]
  • Files文件存储服务 开放API
    • 文件存储服务
    • 文件上传
      POST
    • 文件信息更新
      POST
    • 删除文件
      POST
    • 用户查询 (分页)
      POST
    • 用户元数据查询 (by fileUinqueIds)
      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. Files文件存储服务 开放API

文件上传

line1
https://cn2us02.opapi.win
line1
https://cn2us02.opapi.win
POST
/api/v1/user/files/upload

简介#

上传一个文件到文件存储服务中,目前此接口仅支持约100MB以下的文件上传,有计划支持大文件上传,大文件分段上传接口会在后续开发。

参数描述#

字段名类型必需示例值备注
filefiletrue文件文件数据
filenamestringtrueGdIDB9HakAAiVFK.jpg文件名
purposestringtrue0文件用途
is_publicstringfalsetrue是否公开(可选) 默认私有
tagsstringfalse["t1"]文件标签标记(可选) 可用于筛选文件
expires_atstringfalse2024-11-29T22:14:53+08:00文件过期时间(可选) 若到期系统会自动删除 用于存储临时文件时推荐设置此属性
调用此接口需要提供有效的APIKey凭证,如果启用了APIKey权限检查,需要具备 file-v1 的权限
附:
文件用途purpose定义:
{
  COMMON = 0,
  FINETUNE = 1,
  CHAT = 2,
  LLM_TMP = 3,
  OPENAI_BATCH = 4,
  ANTHROPIC_BATCH = 5,
}

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数multipart/form-data
file
file 
文件数据
必需
示例值:
file://C:\Users\hash070\Downloads\GdIDB9HakAAiVFK.jpg
filename
string 
文件名
必需
示例值:
GdIDB9HakAAiVFK.jpg
purpose
string 
文件用途
必需
示例值:
0
is_public
string 
可选
是否公开(可选) 默认私有
示例值:
true
tags
array[string]
可选
文件标签标记(可选) 可用于筛选文件
示例值:
["t1","t2"]
expires_at
string 
可选
文件过期时间(可选) 若到期系统会自动删除 用于存储临时文件时推荐设置此属性
示例值:
2024-11-29T22:14:53+08:00

示例代码

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/files/upload' \
--form 'file=@"C:\\Users\\hash070\\Downloads\\GdIDB9HakAAiVFK.jpg"' \
--form 'filename="GdIDB9HakAAiVFK.jpg"' \
--form 'purpose="0"' \
--form 'is_public="true"' \
--form 'tags="t1"' \
--form 'tags="t2"' \
--form 'expires_at="2024-11-29T22:14:53+08:00"'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{
    "statusCode": 200,
    "message": "File Upload Success",
    "data": {
        "fileUniqueID": "ENthMCy_5zr5zN3GRJseM"
    }
}
上一页
文件存储服务
下一页
文件信息更新
Built with