Describe File

Prerequisites

You have an Alibaba Cloud Model Studio API key (see the API Key page in the console) and authentication configured. For details, see RAG API overview and Authentication. Data import endpoints use the same base URL and authentication as other RAG APIs, with the path prefix /api/v1/connector/dash/.

Endpoint

POST /api/v1/connector/dash/describeFile Query details of a file, including size, MD5, tags, and creation and update times.

Request body

Field	Required	Type	Description
`fileId`	Yes	string	File ID. Returned by `listFile`.

Request example

curl -X POST "$BASE_URL/api/v1/connector/dash/describeFile" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileId": "file_abc123"
  }'

BASE_URL is https://{workspace_id}.cn-beijing.maas.aliyuncs.com ({workspace_id} is the Workspace ID), and BAILIAN_API_KEY is your Alibaba Cloud Model Studio API key.

Response example

Returns 200 on success.

{
  "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
}

Response fields

Field	Type	Description
`code`	string	Response code. `Success` on success.
`message`	string	Error or informational message; an empty string on success.
`requestId`	string	Unique request identifier. Include this ID when reporting an issue.
`data`	object	File details. Sub-fields: `fileId` (string, file ID), `fileName` (string, file name), `fileType` (string, file type, such as pdf, md, or docx), `category` (string, ID of the category the file belongs to), `status` (string, file status. Enum: `INIT`, `PARSING`, `PARSE_SUCCESS`, `FAIL`), `sizeBytes` (integer, file size in bytes; minimum 1), `parser` (string, parsing method, such as DASHSCOPE_DOCMIND), `uploadTime` (string, upload time).
`status`	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.

Error codes

HTTP status code	Error code `code`	Description
400	`InvalidParameter`	Invalid request parameters. Example `message`: `Required parameter missing or invalid.`
401	`InvalidApiKey`	Authentication failed; the API key is invalid or missing. Example `message`: `Invalid API-key provided.`

On business failures the HTTP status code remains 200. Check status and code in the response body to determine the result.

​Prerequisites

​Endpoint

​Request body

​Request example

​Response example

​Response fields

​Error codes