Skip to main content
DELETE
Delete contents
Later calls on the id answer 404. A retry of the fetch with its idempotency key, within the key’s 24 hours, answers 404 naming the deletion, never a second fetch. A job that points at the record keeps its contents_id, and that id answers 404. A second delete is 404.

What it costs

The key needs contents:delete. The call is free. The answer is 204 No Content.

Refused before any work

An id of the wrong kind: 400 invalid-request, before any lookup. An unknown query parameter: 400 invalid-request, unknown_field.

Problem types

  • 400 invalid-request, The request is invalid.
  • 401 unauthorized, The key is missing or rejected.
  • 403 insufficient-scope, The key lacks a scope this call needs.
  • 404 not-found, Not found: an unknown or another account’s record, or one already erased.
  • 410 contents-expired, The record has expired: for 30 days after it expired, to the owning account only; then 404.
  • 429 rate-limit-exceeded, The rate limit is exceeded; concurrency-limit-exceeded, Too many calls are in flight.
  • 500 internal-error, The service failed.
  • 503 overloaded, The service is overloaded.

Authorizations

Authorization
string
header
required

An API key from https://app.getclean.ai, or an access token issued by https://auth.getclean.ai/realms/getclean, sent as Authorization: Bearer <key> on every call. The scopes a key carries and what a 401 and a 403 say are on the keys and sign-in page.

Headers

traceparent
string

Your own trace id for the call, the W3C Trace Context traceparent header, optional on every operation. getclean logs it with the call, so a request in your traces can be matched to its Request-Id, and never forwards it to a site or a source, a stated departure from W3C Trace Context section 3.4, which asks a vendor to pass it on. A malformed value is ignored, never refused, as the same recommendation asks.

Path Parameters

contents_id
string
required

The record to erase, a cnt_ id.

Pattern: ^cnt_[A-Za-z0-9]{22}$

Response

Erased; no body.