Delete a record

DELETE

/api/v1/knowledge/bases/{kb_id}/records/{record_id}

Deletes the record's file, and with it its 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

kb_id*string

record_id*string

Response Body

Successful Response

application/json

response

status?string

Default"deleting"

curl -X DELETE "https://api.synapseorch.com/api/v1/knowledge/bases/kb_01a10d3f5a7c9e1b3d5f7a9c1e3b5d7f/records/T-1042" \  -H "Authorization: Bearer sk-syn-..."

{  "status": "deleting"}