文件列出

分页列出当前账户下已上传的文件列表;可按用途筛选,并按关键字搜索。user_id 从请求头 User-Id 获取(如适用),无需在 Query 中传入。

GET/v1/files/list

授权

Authorizationstringheader必填
HTTP: Bearer Auth
  • Security Scheme Type: http
  • HTTP Authorization Scheme: Bearer API_key,用于验证账户信息,可在 项目管理>API Key 中查看。

请求头

User-Id string 选填

部分接入方式下用于标识用户;与账户关联逻辑以后端为准。

查询参数

purpose string 选填

按文件用途筛选;不传则返回全部用途的文件。可选取值及含义如下:

  • voice_clone: 快速克隆原始文件
  • prompt_audio: 声音克隆的风格音频
  • t2a_async_input: 异步长文本语音合成输入文件
  • t2a_async: 异步长文本语音合成生成音频文件
  • a2t_async_input: 异步语音转写输入音频文件
  • ocr_async_input: 文档解析输入文档文件
  • ocr_async_md: 文档解析输出md文件
  • ocr_async_json: 文档解析输出json文件

keyword string 选填

搜索关键字:对文件名进行模糊匹配,或对 file_id 进行精确匹配。

page integer 选填

页码,从 1 开始;默认 1。

size integer 选填

每页条数;默认 10,最大 100。

响应体结构

totalinteger

符合条件的文件总条数(用于分页)。无数据时为 0。

filesarray<object>

本页文件列表;无数据时为空数组 []。每个文件对象包括:

files[i].file_idlong

文件的唯一标识符

files[i].bytesinteger

文件大小,以字节为单位

files[i].created_atinteger

创建文件时的 Unix 时间戳,以秒为单位

files[i].filenamestring

文件的名称

files[i].purposestring

文件的使用目的

base_respobject

base_resp.status_codeinteger

状态码如下:
  • 100001, 请求参数错误
  • 101999, 服务内部错误
更多内容可查看错误码了解详情

base_resp.status_msgstring

状态详情