Describe File

Get a file's metadata, including size, MD5, tags, and timestamps.

POST

/api/v1/connector/dash/describeFile

cURL

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

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "fileId": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
    "status": "PARSE_SUCCESS",
    "fileName": "a.md",
    "fileType": "md",
    "parser": "DOCMIND_DIGITAL",
    "sizeBytes": 21,
    "uploadTime": "2026-04-01 16:03:45",
    "category": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx"
  },
  "status": 200
}

Authorizations

string

header

required

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

Body

application/json

string

required

File ID. Returned by listFile.

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

string

File ID.

string

File name.

string

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

string

ID of the category the file belongs to.

enum<string>

File status.

Available options:INIT,PARSING,PARSE_SUCCESS,FAIL

integer

File size in bytes.

Required range:x >= 1

string

Parsing method, such as DASHSCOPE_DOCMIND.

string

Upload time.

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/describeFile" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileId": "file_abc123"
  }'

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "fileId": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
    "status": "PARSE_SUCCESS",
    "fileName": "a.md",
    "fileType": "md",
    "parser": "DOCMIND_DIGITAL",
    "sizeBytes": 21,
    "uploadTime": "2026-04-01 16:03:45",
    "category": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx"
  },
  "status": 200
}