Skip to main content
POST
Create a relationship definition

Authorizations

Authorization
string
header
required

API key for authentication (format: "Bearer YOUR_API_KEY")

Body

application/json

Relationship definition to create

type
enum<string>
required

Relationship cardinality

Available options:
one_to_one,
one_to_many,
many_to_many
entity_definition_1_id
string
required

First object definition ID

entity_definition_2_id
string
required

Second object definition ID

entity_1_to_2_predicate
string

Label for 1→2 direction (e.g., 'has')

entity_2_to_1_predicate
string

Label for 2→1 direction (e.g., 'belongs to')

Response

Created relationship definition

id
string
type
enum<string>
Available options:
one_to_one,
one_to_many,
many_to_many
entity_definition_1_id
string
entity_definition_2_id
string
entity_1_to_2_predicate
string
entity_2_to_1_predicate
string
created_at
string<date-time>
Last modified on February 17, 2026