Delete record
Changed onDelete a record from the knowledge base.
Required permission:
WRITER or higher on the record's knowledge base. A READER is answered 403; a caller with no role, an unknown id and a record that is already in the trash are all answered 404. The query string and any request body are ignored.
What gets deleted:
- Record metadata
- Associated storage file
- Indexed content and embeddings
Trash: With "Move Deleted Records to the Trash" on in Labs, the record goes to the trash instead: it disappears from search, chat and lists at once, its embeddings are removed, and the record and its file stay until the scheduled purge. The response then carries softDeleted: true and the batchId, and the record can be brought back with POST /knowledgeBase/record/{recordId}/restore. With the setting off, the delete is immediate and cannot be undone. A folder sent to the trash this way goes alone: the records inside it stay live and readable. DELETE /knowledgeBase/{kbId}/folder/{folderId} trashes a folder with its contents.
Request
- Base URLhttps://app.pipeshub.com/api/v1
- URLhttps://app.pipeshub.com/api/v1/knowledgeBase/record/{recordId}
- Auth
- HTTP bearer
- or OAuth 2Authorization code: /api/v1/oauth2/authorizeClient credentialsToken URL: /api/v1/oauth2/token scopes: kb:delete
Path parameters
Record ID
Response
Record deleted successfully
Changes
- info
added the non-success response with the status
- info
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- info