查看可导出文件列表¶

列出指定卷中已生成向量化结果的文件。

POST https://moi.matrixorigin.cn/newmoi/export/volumes/$VOLUME_ID/files

调用前准备¶

准备有目标工作区访问权限的个人访问令牌、目标工作区 ID和卷 ID。

路径参数和请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $VOLUME_ID 替换为实际值。

输入示例

读取一页文件

curl -X POST "https://moi.matrixorigin.cn/newmoi/export/volumes/$VOLUME_ID/files" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "offset": 0,
    "limit": 30
  }'

筛选并排序文件

curl -X POST "https://moi.matrixorigin.cn/newmoi/export/volumes/$VOLUME_ID/files" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": {
      "types": [2, 7],
      "exclude_status": [0]
    },
    "sorter": {
      "sort_by": "created_at",
      "is_desc": true
    },
    "offset": 0,
    "limit": 30
  }'

读取下一页

curl -X POST "https://moi.matrixorigin.cn/newmoi/export/volumes/$VOLUME_ID/files" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "offset": 30,
    "limit": 30
  }'

参数说明

读取一页文件

参数	类型	是否必填	说明
`volume_id`	string	是	路径中的数据卷 ID。
`offset`	integer	否	跳过的文件数。
`limit`	integer	否	本页返回条数；省略或小于等于 0 时为 30。

筛选并排序文件

参数	类型	是否必填	说明
`volume_id`	string	是	路径中的数据卷 ID。
`filters`	object	否	文件筛选条件。
`filters.types`	array of integer	否	文件类型筛选条件；PDF 为 `2`，CSV 为 `7`。
`filters.exclude_status`	array of integer	否	要排除的文件状态；当前返回项目状态固定为 `2`。
`sorter`	object	否	排序条件。
`sorter.sort_by`	string	否	传入任意非空值时按创建时间排序。
`sorter.is_desc`	boolean	否	`true` 降序，`false` 升序。
`offset`	integer	否	跳过的文件数。
`limit`	integer	否	本页返回条数。

读取下一页

参数	类型	是否必填	说明
`volume_id`	string	是	路径中的数据卷 ID。
`offset`	integer	否	上一页的 `offset` 加上本页读取条数。当 `offset` 不小于 `data.total` 时停止读取。
`limit`	integer	否	与上一页相同。

成功响应¶

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 1,
    "items": [{
      "id": "file-001",
      "file_name": "summary.csv",
      "file_status": 2,
      "file_type": 7
    }]
  }
}

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.total`	integer	当前筛选条件下的文件总数。
`data.items`	array of object	已生成向量化结果的文件。不含创建导出任务所需的完整路径、原始文件 ID 或解析产物 ID，不能单独用本响应构造 `files`。
`data.items.id`	string	文件 ID。
`data.items.file_name`	string	文件名称。
`data.items.file_status`	integer	固定为 `2`，表示已生成向量化结果。
`data.items.file_type`	integer	文件类型标识。

错误响应¶

响应示例

{
  "code": "ErrServer",
  "msg": "无法读取卷中的文件",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

后续操作¶

取得完整文件信息后，将文件 ID 和路径填写到创建导出任务的 files。

最后更新于 2026 年 9 月 3 日