Skip to main content
DELETE
Delete Data

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dataset_id
string<uuid>
required

Dataset UUID, the id field from GET /api/v1/datasets (not the name)

Example:

"b8a7c3de-4f5a-4b6c-8d9e-0f1a2b3c4d5e"

data_id
string<uuid>
required

Data item UUID, from GET /api/v1/datasets/{dataset_id}/data

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

Successful Response

The deletion receipt datasets.delete_data returns.

This is the single definition of the receipt: delete_data builds it and hands SDK callers its model_dump (snake_case keys), and the REST routes that return it (DELETE /datasets/{dataset_id}/data/{data_id}, DELETE /delete, DELETE /forget with a data_id) carry the same dict, this route validating it as its response_model (camelCase on the wire).

status never contradicts the outcome: success when something was removed (graph elements other data still shares lose only the id's ownership, so the counts can be 0), not_found when neither a Data row nor a graph element existed for the id (nothing removed, counts 0; deleting is idempotent, so this is a 200, and delete_dataset_if_empty is still honoured). A delete whose Data row is still present afterwards raises DataDeletionIncompleteError (500) instead of any receipt. So data_remaining is false (observed by an existence check after the delete, the verified outcome — read it together with data_record_found: true) or null (no Data row existed, so there was nothing to observe).

status
enum<string>
required

'success' when something was removed; 'not_found' when neither a Data row nor a graph element existed for the id (nothing removed). A Data row that survives the delete answers 500 instead of a receipt.

Available options:
success,
not_found
datasetId
string<uuid>
required

The dataset the item was deleted from.

dataId
string<uuid>
required

The resolved id of the deleted item (differs from the path when a legacy id was given).

dataRecordFound
boolean
required

A Data row existed for the id. False means only graph elements owned by the id were removed (custom graph model).

deletedNodes
integer
required

Graph nodes removed by this delete. Approximate on the legacy (pre-provenance) graph path, where it also counts the chunk 'contains' edge-vector ids removed with the nodes.

deletedEdges
integer
required

Graph edges removed by this delete. 0 on the legacy (pre-provenance) graph path, which does not track the edges it detaches.

dataRemaining
boolean | null
required

False when an existence check after the delete no longer finds the Data row (the verified outcome; meaningful only with dataRecordFound true). Null when no Data row existed. Never true on a returned receipt: that case fails with 500.

datasetDeleted
boolean
required

The now-empty dataset was removed as well (only when delete_dataset_if_empty was requested).