Skip to main content

aiPromptsDelete

AiSuccessResponse aiPromptsDelete(AiPromptsDeleteRequest)

DELETE /api/2.0/ai/prompts/delete

Delete a saved prompt

Deletes one saved prompt from the caller's library. The ID may be sent in the body or as a query parameter, and it is required. An ID that does not exist, or that belongs to another user, is not reported: the call answers success without deleting anything. The deletion is permanent.

Parameters​

NameInTypeDescriptionNotes
AiPromptsDeleteRequestbodyStringThe ID of the prompt to delete, as a bare JSON string.[required]

Responses​

Status codeDescriptionTypeResponse headers
200Confirms the request was accepted, whether or not a prompt was deleted.AiSuccessResponse-
400The prompt ID is missing.AiErrorResponse-
401Missing asc_auth_key cookie or Authorization header.AiErrorResponse-
403AI is disabled for this portal, the caller is a guest, or the room named by entityId is one the caller cannot open. Relayed from the DocSpace AI service or the Files API.AiErrorResponse-
413The request body is larger than 100 KB, the JSON parser's limit on this route.AiErrorResponse-
500Unhandled failure. The reason is logged server-side and never echoed back.AiErrorResponse-

Return type​

AiSuccessResponse

Authorization​

cookieAuth, bearerAuth

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json