List Files

List files under the current workspace. Filter by category, file name, or file ID.

POST

/api/v1/connector/dash/listFile

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/listFile" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryId": "cate_abc123"
  }'

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "hasNext": false,
    "maxResult": 20,
    "totalCount": 1,
    "maxId": 338031,
    "fileList": [
      {
        "fileId": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "status": "PARSE_SUCCESS",
        "fileName": "a.md",
        "fileType": "md",
        "parser": "DASHSCOPE_DOCMIND",
        "sizeBytes": 21,
        "uploadTime": "2026-04-01 16:03:45",
        "category": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "autoId": 338031,
        "parseErrorMessage": ""
      }
    ]
  },
  "status": 200
}

When batch-querying with fileIds, you can pass up to 20 file IDs per call.

Authorizations

string

header

required

DashScope API Key, obtained from the API Key page in the console.

Body

application/json

string

required

Category ID. Returned by listCategory.

string

File name. Supports fuzzy matching.

string[]

File IDs to look up in batch. Up to 20.

Required range:items <= 20

string

Pagination cursor. Omit it on the first request; on subsequent requests pass the nextToken value returned by the previous page.

integer

default20

Number of files returned per page. Defaults to 20. Note the parameter name is maxResult (singular); maxResults (plural) is silently ignored.

Response

200-application/json

string

Response code. Success on success.

string

Error or informational message; an empty string on success.

string

Unique request identifier. Include this ID when reporting an issue.

object

Show child attributes

object[]

File list.

Show child attributes

string

File ID.

string

File name.

string

File type, such as pdf, md, or docx.

string

ID of the category the file belongs to.

string

File status, such as PARSE_SUCCESS, PARSING, or FAIL.

integer

File size in bytes.

string

Parsing method, such as DASHSCOPE_DOCMIND or DOCUMENT_PARSE_LLM.

string

Upload time.

string

Error message returned when parsing fails. Empty on success.

integer

Auto-incremented ID.

boolean

Whether more pages are available.

integer

Page size used for this request.

integer

Total number of matching items.

string

Cursor for the next page. Pass this value as nextToken in the next request to paginate.

integer

Business status code. 200 on success, 400 for failures such as invalid parameters. Note that the HTTP status code remains 200 even on failure, so rely on this field and code to determine the result.

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/listFile" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryId": "cate_abc123"
  }'

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "hasNext": false,
    "maxResult": 20,
    "totalCount": 1,
    "maxId": 338031,
    "fileList": [
      {
        "fileId": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "status": "PARSE_SUCCESS",
        "fileName": "a.md",
        "fileType": "md",
        "parser": "DASHSCOPE_DOCMIND",
        "sizeBytes": 21,
        "uploadTime": "2026-04-01 16:03:45",
        "category": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "autoId": 338031,
        "parseErrorMessage": ""
      }
    ]
  },
  "status": 200
}