Skip to main content
POST
Create or retrieve an entity

Body

application/json

Request body for POST /entities.

name
string
required

Entity display name.

Required string length: 1 - 512
type
string
required

Entity type (e.g. 'company', 'person'). Stored title-cased.

Required string length: 1 - 100
source
EntitySourceInput · object | null

Optional source reference. When provided, a source node is created/merged in FalkorDB and a :MENTIONED_IN edge is added from the entity to the source. The FalkorDB node label is derived from source_type (e.g. 'knowledge_document'KnowledgeDocument).

Response

Successful Response

Response for POST /entities.

entity_id
string
required
entity_type
string
required
name
string
required
created
boolean
required

True if a new entity was inserted; False if it already existed.