DescribeFile

Obtains the basic information of a document, including the document name, type, and status.

Operation description

Before you call this API, make sure that your document is uploaded to the Data Management page of Alibaba Cloud Model Studio.

• You can also call this operation to query unstructured documents that you upload on the Data Management page.
• This operation is idempotent.

Throttling: Make sure that the interval between the two queries is at least 15 seconds. Otherwise, you may trigger system throttling. If throttling is triggered, try again later.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples. Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

• Operation: the value that you can use in the Action element to specify the operation on a resource.
• Access level: the access level of each operation. The levels are read, write, and list.
• Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
  • For mandatory resource types, indicate with a prefix of * .
  • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
• Condition Key: the condition key that is defined by the cloud service.
• Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sfm:DescribeFile	none	* All Resources *	none	none

Request syntax

GET /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the workspace to which the document belongs. On the homepage of the console, click the workspace Details icon in the upper-left corner to view the workspace ID.	ws_3AXoiweeTyTd03IN
FileId	string	Yes	The primary key ID of the document. You can click the ID icon next to the file name on the Data Management page to view the ID.	file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Code	string	The status code.	Success
Data	object	The returned data fields.
CategoryId	string	The ID of the category to which the document belongs.	cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
CreateTime	string	The timestamp when the document was uploaded to Model Studio. Format: yyyy-MM-dd HH:mm:ss. Time zone: UTC + 8.	2024-05-26 12:45:43
FileId	string	The primary key ID of the document.	file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
FileName	string	The name of the document.	test.pdf
FileType	string	The file type of the document. The value is an extension. Valid values: pdf, docx, doc, txt, md, pptx, and ppt.	pdf
Parser	string	The parser that is used to parse the document. Valid value: - DASHSCOPE_DOCMIND: The default document parser.	DASHSCOPE_DOCMIND
SizeInBytes	long	The size of the document. Unit: bytes.	1234
Status	string	The status of the document. Valid values: - INIT: pending parsing. - PARSING - PARSE_SUCCESS - PARSE_FAILED	PARSE_SUCCESS
Tags	array	The tags that are associated with the document. A document can be associated with multiple tags.
Tags	string	The tag of the document.	Product Introduction
Message	string	The error message.	Requests throttling triggered.
RequestId	string	The request ID.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	The HTTP status code.	200
Success	boolean	Indications whether the API call is successful. Valid values: - true - false	true

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX",
    "CreateTime": "2024-05-26 12:45:43",
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX",
    "FileName": "test.pdf",
    "FileType": "pdf",
    "Parser": "DASHSCOPE_DOCMIND",
    "SizeInBytes": 1234,
    "Status": "PARSE_SUCCESS",
    "Tags": [
      "Product Introduction\n"
    ]
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": 200,
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2026-01-15	The response structure of the API has changed	View Change Details