LLM-readable documentation index

Entity Types

Overview of the Entity Types API

Hand off to an LLM

Entity Types are the customer-defined taxonomy for the knowledge graph, scoped to an account+environment. Each type has a unique, immutable name and can be organised into hierarchies via parentTypeID. A type may carry per-type structured attribute metadata in attributeSchema (for example {"unit": "mg", "range": [0, 100]}).

Use these endpoints to create, list, fetch, update, and delete entity types:

  • POST /v3/entity-types creates a type, optionally under a parent.
  • GET /v3/entity-types lists types with cursor pagination (startingAfter / endingBefore over typeID) and an optional parentTypeId filter for direct children.
  • PATCH /v3/entity-types/{typeID} updates description, parentTypeID, and/or attributeSchema. The name is immutable.
  • DELETE /v3/entity-types/{typeID} soft-deletes a type. The request is rejected with 409 Conflict while any live entity is assigned to the type or any live child type points at it.