Skip to content
OperadeDocs

Search documentation

Type to search documentation.

Documentation
Copy page
Open raw Markdown

Delete a knowledge document

Delete a knowledge document and remove it from dependent current configurations.

Endpoint

DELETE/api/v1/workspaces/{workspace_id}/knowledge/{document_id}

Authentication

Operation classAuthenticationMinimum roleAPI key
dashboard-session-apiDashboard session cookie; mutations also require X-CX-Request: 1.adminNot allowed

Parameters

NameInTypeRequiredDescription
workspace_idpathstringYes—
document_idpathstringYes—

Request body

This operation has no request body.

Example

cURL
curl --request DELETE 'https://operade.ai/api/v1/workspaces/ws_demo/knowledge/doc_demo' \
  --cookie 'cx_session=YOUR_SESSION_COOKIE' \
  --header 'X-CX-Request: 1'

Responses

StatusDescriptionContent
4XXHandled client errorapplication/json: ErrorResponse
204Successful ResponseNo body

4XX application/json response schema

Field pathTypeReferenceFormatNullableRequiredEnumDescription
$objectErrorResponse—NoYes——
errorobjectErrorItem—NoYes——
error.codestring——NoYes——
error.detailsobject——NoNo——
error.messagestring——NoYes——

Response example

HTTP
HTTP 204
This response has no body.

Errors

Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.

StatusCodeDescription
401unauthenticatedAuthentication is missing, invalid, or revoked.
403forbiddenThe authenticated caller does not have access to this operation.
404not_foundThe requested workspace resource was not found.
On this page
  1. Endpoint
  2. Authentication
  3. Parameters
  4. Request body
  5. Example
  6. Responses
  7. 4XX application/json response schema
  8. Response example
  9. Errors
  10. Related operations