Delete a document

DELETE

/api/v1/knowledge/documents/{doc_id}

Deletes the document's Vault file, and with it the document.

Authorization

apiKey

headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

Path Parameters

doc_id*string

Response Body

Successful Response

application/json

response

status?string

Default"deleting"

curl -X DELETE "https://api.synapseorch.com/api/v1/knowledge/documents/kdoc_01a10f6c8e0a2c4e6a8c0e2a4c6e8a0c" \  -H "Authorization: Bearer sk-syn-..."

{  "status": "deleting"}