Folder

Delete folder

DELETE /v1/folder/:folderId

This endpoint is used to delete a specific folder identified by the folderId. The deletion operation will remove the folder and all its contents from the system.

Request Parameters

  • folderId (path parameter): The unique identifier of the folder that you wish to delete. This parameter is required.

Response Structure

Upon successful deletion, the response will return a JSON object with the following structure:

  • status: A string indicating the status of the operation (e.g., success or failure).

  • message: A string providing additional information about the result of the deletion operation.

Example Response

{
 "status": "success",
 "message": "Folder deleted successfully."
}

In case of an error, the response may contain an appropriate error message indicating what went wrong.

delete/folder/{folderId}

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/folder/{folderId}
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

folderIdstring required

Response

OK

statusstring
messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.