文件检索

开发指南 API参考

模型价格模型发布

使用本接口，检索云知声 Token Hub大模型服务平台上的文件。

GET/v1/files/retrieve

授权

Authorizationstringheader必填

HTTP: Bearer Auth

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

查询参数

file_id integer (int64) 必填

文件的唯一标识符。本接口支持异步任务中查询任务状态接口获得的 file_id。

响应体结构

fileobject

file.file_idinteger<int64>

文件的唯一标识符

file.bytesinteger<int64>

文件大小，以字节为单位

file.created_atinteger<int64>

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

file.filenamestring

文件的名称

file.purposestring

文件的使用目的

file.download_urlstring

文件的下载链接（特定用途文件生成）

base_respobject

base_resp.status_codeinteger

状态码如下：

100001, 请求参数错误
101999, 服务内部错误

更多内容可查看错误码了解详情

base_resp.status_msgstring

状态详情

Retrieve File

curl --request GET \
  --url 'https://maas-api.hivoice.cn/v1/files/retrieve?file_id=123456789' \
  --header 'Authorization: Bearer <api_key>'

200

{
  "file": {
    "file_id": 123456789,
    "bytes": 6863158,
    "created_at": 1774268796,
    "filename": "test.mp3",
    "purpose": "ocr_async_md",
    "download_url": "http://www.test.com/test.md"
  },
  "base_resp": {
    "status_code": 0,
    "status_msg": "success"
  }
}