DeleteFile

Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.

Operation description

• Deleting data tables via API is not supported. To delete a data table or specific data within a table, go to Application Data to perform the operation.

• This API is used to delete files in Application Data and does not affect any knowledge bases that have already been built. To delete a file from a knowledge base, invoke the DeleteIndexDocument API.

• A RAM user must first obtain the API permissions for Alibaba Cloud Model Studio (requiring AliyunBailianDataFullAccess, which includes the sfm:DeleteFile permission point) and join a workspace before invoking this API. An Alibaba Cloud account can invoke this API directly without authorization. We recommend that you use the latest version of the Alibaba Cloud Model Studio SDK to invoke this API.

• This API can only delete files whose status is either Failed to Parse (PARSE_FAILED) or Parse Succeeded (PARSE_SUCCESS).

• This API is idempotent.

Rate Limiting Notice: Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage. Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

• Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

• API: The API that you can call to perform the action.

• Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

• Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

  • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

  • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (***** ) in the Resource element of the policy.

• Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

• Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action	Access level	Resource type	Condition key	Dependent action
sfm:DeleteFile	delete	*All Resource *	None	None

Request syntax

HELPCODEESCAPE-plaintext
DELETE /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
FileId	string	Yes	The file ID, which is the FileId returned by the AddFile API. You can also obtain it on the Application Data page by clicking the ID icon next to the file name.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
WorkspaceId	string	Yes	The ID of the workspace to which the file belongs. For information about how to obtain the ID, see How to use workspaces.	llm-3shx2gu255oxxxx

Request parameters

Parameter	Type	Required	Description	Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	string	The error status code.	InvalidParameter
Data	object	The business data field of the API response.
FileId	string	The file ID.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
Message	string	The error message.	Current file status does not support delete.
RequestId	string	Id of the request	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	The status code returned by the API.	200
Success	boolean	Indicates whether the API call succeeded. Valid values: - true: Succeeded. - false: Failed.	true

Examples

Success response

JSON format

HELPCODEESCAPE-json
{
  "Code": "InvalidParameter",
  "Data": {
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx"
  },
  "Message": "Current file status does not support delete.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.