Detach a source

Deletes vectors (keyed by document_id), chunks, and the document row; notifies the crawler to drop crawler_document_id when relevant. The uploaded file goes too when no other document uses it and the document owner is the one who uploaded it; otherwise it is kept. Requires editor+ and document ownership - a non-owner, non-admin editor deleting a document they do not own gets 403 FORBIDDEN.

DELETE /v1/knowledge_bases/{knowledgeBaseId}/documents/{documentId}

Detach a source

cURL

curl --request DELETE \
  --url https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/documents/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "delete_file": false
}
'

200

Example

{ "id": "<string>", "object": "knowledge_base.document", "deleted": true }

Authorizations

Authorization · string · header · required

User session JWT or instance API key (iak_*). Send as Authorization: Bearer <token>.

Path Parameters

knowledgeBaseId · string · required

Knowledge base id. Legacy physical prefix vs_ (the kb_ rename is deferred).

Maximum string length: 128

Pattern: ^vs_[A-Za-z0-9-]+$

documentId · string · required

Document id. Legacy physical prefix vsf_ (the doc_ rename is deferred).

Maximum string length: 128

Pattern: ^vsf_[A-Za-z0-9-]+$

Body

application/json

delete_file · boolean · default: false

Accepted and ignored: whether the file goes is decided by who uploaded it and whether another document uses it.

Response

200

application/json

Detached.

id · string · required

object · enum<string> · required

Available options: knowledge_base.document

deleted · enum<boolean> · required

Available options: true