Skip to content

Datasets_DeleteDataset

DELETE
/v1/accounts/{account}/datasets/{dataset}
curl --request DELETE \
--url https://junction-api.qualiastudios.dev/v1/accounts/example/datasets/example \
--header 'X-API-Key: <X-API-Key>'

Deletes a mixture, or retires an upload or a merged dataset: it leaves every list and its episodes leave every mixture, but nothing is erased, and versions that pin its episodes keep resolving. A merged dataset is retired with the uploads it holds, which then answer NOT_FOUND; an upload bound to append to it that it does not hold (not appended yet, or taken back out before merges were final) is unbound. Refused with FAILED_PRECONDITION while another mixture reads it by name (for a merged dataset, also a pin of one of its uploads’ tags; any other source left on one of them reads nothing and does not hold it); a mixture that reads it through a label source stops reading it. An upload merged into another is not deleted on its own (FAILED_PRECONDITION naming the merged dataset). A dataset whose episodes are references of Tasks (Dataset.task_references) is refused too unless sent with force, which removes those references.

account
required
string

The account id.

dataset
required
string

The dataset id.

etag
string

The dataset’s current etag, when the caller wants the guard.

force
boolean

Delete it even though its episodes are references of Tasks (Dataset.task_references), removing those references; the Tasks stay. Without it, such a dataset is refused (FAILED_PRECONDITION). Reingests and the ingest report live under uploads and are never deleted here.

OK

Default error response

Media type application/json
One of:
API error

A refusal from the API itself.

object
code
required

The gRPC code name in upper case, e.g. NOT_FOUND.

string
message
required
string
retryable
required

Whether the same call may succeed if retried.

boolean
details
required

Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.

Array<object>
object
Example generated
{
"code": "example",
"message": "example",
"retryable": true,
"details": [
{}
]
}