Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Delete an entity

Deletes an entity and every fact about it.

Deletes an entity and every fact about it. With force it is a data-rights erasure: the episodes the person wrote are deleted too, with their search and embedding entries.

Not available yet. Sylphx Knowledge is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

  • Path DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entities/entity
  • Scope knowledge:write
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection entities
  • Query etag, allow_missing, validate_only, force

#Request

FieldTypeWhat it is
namestringThe name of the entity to delete. Required.
etagstringDelete only if the current etag matches.
allow_missingboolSucceed when the entity does not exist.
validate_onlyboolValidate without deleting anything.
forceboolAlso delete the episodes this person wrote (a data-rights erasure).

#Response

The call answers with an empty object.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entities/entity" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"