Delete File

The Delete File API allows developers to remove a specific file from the server. This endpoint requires the unique identifier of the file to be deleted.

The Delete File API removes a specific file identified by its file_uri. It sends a DELETE request to the backend server, and upon success, the file is permanently removed from the system.

This API is especially useful for:

  1. Cleaning up unused or outdated files in the system.
  2. Ensuring secure removal of sensitive data from storage.
  3. Managing file lifecycle efficiently within the platform.

Request Parameters

Public Request Parameters

📘

Path Parameters

Field Type Required Description Example
file_uri string Yes The unique identifier of the file. This must be a valid alphanumeric string representing the file's URL. 7ebb4faa8d92e1d627edf9ca61a98993.png

Response Explanation

Public Response Parameters

📘

Success Response

FieldTypeExampleDescription
codestring"Success"Response status (e.g., "Success").
messagestring``Response message.
dataobject

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!