Relationships Management

Add Relationship Details Endpoint `POST` /api/v1/relationships/create

Resource URL	/api/v1/relationships/create
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Add details for a new relationship.

Request Body

Parameter	Description	Required	Type	Default Value
name	Relationship name	Yes	String	N/A
attributes	List of attributes	Yes	Array	N/A
source_id	Source entity ID	Yes	String	N/A
target_id	Target entity ID	Yes	String	N/A
client_id	Client identifier	Yes	String	N/A
created_user	User who created it	No	String	null
style	Style object	No	Object	null

Example Request

curl -X 'POST' \
'https://braegen.ai/api/v1/relationships/create' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Sample Relationship",
    "attributes": ["attr1"],
    "source_id": "1",
    "target_id": "2",
    "client_id": "client_123",
    "created_user": "user_456"
}'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Get Relationship Details By Id Endpoint `GET` /api/v1/relationships/{identifier}

Resource URL	/api/v1/relationships/{identifier}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Retrieve details of a relationship by its identifier.

Parameters

Parameter	Description	Required	Type	Default Value
identifier	Relationship ID	Yes	Integer	N/A

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/relationships/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Update Relationship Endpoint `PUT` /api/v1/relationships/{identifier}

Resource URL	/api/v1/relationships/{identifier}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Update an existing relationship by its identifier.

Parameters

Parameter	Description	Required	Type	Default Value
identifier	Relationship ID	Yes	Integer	N/A

Request Body

Parameter	Description	Required	Type	Default Value
name	Relationship name	No	String	N/A
attributes	List of attributes	Yes	Array	null
source_id	Source entity ID	No	Integer	null
target_id	Target entity ID	No	Integer	null
client_id	Client identifier	No	String	null
style	Style object	No	Object	null

Example Request

curl -X 'PUT' \
'https://braegen.ai/api/v1/relationships/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "attributes": ["attr1", "attr2"]
}'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Delete Relationship Endpoint `DELETE` /api/v1/relationships/{identifier}

Resource URL	/api/v1/relationships/{identifier}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Delete a relationship by its identifier.

Parameters

Parameter	Description	Required	Type	Default Value
identifier	Relationship ID	Yes	Integer	N/A

Example Request

curl -X 'DELETE' \
'https://braegen.ai/api/v1/relationships/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Get All Relationship Details Endpoint `GET` /api/v1/relationships

Resource URL	/api/v1/relationships
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Retrieve a paginated list of all relationships.

Parameters

Parameter	Description	Required	Type	Default Value
page	Page number to retrieve	No	Integer	1
page_size	Number of items per page	No	Integer	10
client_id	Client identifier	No	String	N/A
name	Relationship name filter	No	String	N/A

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/relationships?page=1&page_size=10&client_id=client_123' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Relationships Management

Add Relationship Details Endpoint POST /api/v1/relationships/create

HTTP Responses

Get Relationship Details By Id Endpoint GET /api/v1/relationships/{identifier}

HTTP Responses

Update Relationship Endpoint PUT /api/v1/relationships/{identifier}

HTTP Responses

HTTP Responses

Get All Relationship Details Endpoint GET /api/v1/relationships

HTTP Responses

On this page

Add Relationship Details Endpoint `POST` /api/v1/relationships/create

Get Relationship Details By Id Endpoint `GET` /api/v1/relationships/{identifier}

Update Relationship Endpoint `PUT` /api/v1/relationships/{identifier}

Get All Relationship Details Endpoint `GET` /api/v1/relationships