Skip to main content
PATCH
Update Ontology Component

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key
string | null

Path Parameters

component_key
string
required

Body

application/json
component_type
enum<string> | null
Available options:
entity,
attribute,
action,
relationship,
hierarchy
name
string | null
Maximum string length: 255
content
string | null
Minimum string length: 1
subject_key
string | null
Maximum string length: 255
object_key
string | null
Maximum string length: 255
annotations
Annotations · object | null
status
enum<string> | null
Available options:
active,
deprecated
edit_reason
string | null
Maximum string length: 1000
review_context
string | null

Optional reviewer-facing ticket context from the originating agent or workflow. This is used for governance notifications and is not stored on the ontology component itself.

Maximum string length: 1500

Response

Successful Response

component
OntologyMemoryRead · object
required
impact_warning
OntologyImpactWarning · object | null