Hard Delete Examples

This endpoint hard deletes all versions of a dataset example(s). Deletion is performed by setting inputs, outputs, and metadata to null and deleting attachment files while keeping the example ID, dataset ID, and creation timestamp. IMPORTANT: attachment files can take up to 7 days to be deleted. inputs, outputs and metadata are nullified immediately.

POST /v1/platform/datasets/examples/delete

Error

A valid request URL is required to generate request examples

200

{
  "count": 1,
  "example_ids": [
    "[\"123e4567-e89b-12d3-a456-426614174000\"]"
  ]
}

{
  "details": "{\"field\":\"dataset_id\",\"reason\":\"required\"}",
  "error": "Invalid request: missing required fields"
}

{
  "details": "{\"field\":\"dataset_id\",\"reason\":\"required\"}",
  "error": "Invalid request: missing required fields"
}

{
  "details": "{\"field\":\"dataset_id\",\"reason\":\"required\"}",
  "error": "Invalid request: missing required fields"
}

{
  "details": "{\"field\":\"dataset_id\",\"reason\":\"required\"}",
  "error": "Invalid request: missing required fields"
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

example_ids · string[] · required

ExampleIDs is a list of UUIDs identifying the examples to delete.

Required array length: 1 - 1000 elements

hard_delete · boolean · required

HardDelete indicates whether to perform a hard delete. Currently only True is supported.

Response

200

application/json

OK

count · integer

Example:

1

example_ids · string[]

Example:

[
  "[\"123e4567-e89b-12d3-a456-426614174000\"]"
]