文件信息更新

line1

https://cn2us02.opapi.win

POST

/api/v1/user/files/update

简介

更新文件信息

参数描述

字段名	类型	必需	示例值	备注
fileUniqueId	string	是	ENthMCy_5zr5zN3GRJseM	文件UID 必填
filename	string	是	example-new.png	新文件名必填
purpose	integer	否	0	文件目的
is_public	boolean	否	true	是否公开
tags	array	否	["tag1", "tag2"]	新的文件Tag
expires_at	string	否	2024-12-31T23:59:59	到期时间
unset_expires_at	boolean	否	false	是否取消设置到期时间

调用此接口需要提供有效的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 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://cn2us02.opapi.win/api/v1/user/files/update' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileUniqueId": "ENthMCy_5zr5zN3GRJseM",
    "filename": "new-pic.jpg",
    "purpose": "0",
    "is_public": true,
    "tags": [
        "t1",
        "t2"
    ],
    "expires_at": "2024-11-29T22:14:53+08:00",
    "unset_expires_at": false
}'

响应示例

{
    "statusCode": 200,
    "message": "File info updated successfully",
    "data": {
        "affectedRows": 1
    }
}

修改于 2024-11-27 15:48:57

文件上传

删除文件

文件信息更新

简介#

参数描述#

请求参数

返回响应

简介

参数描述