BREAGEN Logo
Ontology Management

Entity Management

Add Entities Details Endpoint POST /api/v1/entity/create

Resource URL/api/v1/entity/create
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Add details for a new entity.

Request Body

ParameterDescriptionRequiredTypeDefault Value
nameEntity nameYesStringN/A
attributesList of attributesYesArrayN/A
typeEntity typesYesArrayN/A
client_idClient identifierYesStringN/A
ontology_idOntology identifierYesIntegerN/A
created_userUser who created itNoStringnull
styleStyle objectNoObjectnull

Example Request

curl -X 'POST' \
'https://braegen.ai/api/v1/entity/create' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Sample Entity",
    "attributes": ["attr1", "attr2"],
    "type": ["type1"],
    "client_id": "client_123",
    "ontology_id": 1,
    "created_user": "user_456"
}'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Get Entity Details By Id Endpoint GET /api/v1/entity/{identifier}

Resource URL/api/v1/entity/{identifier}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Retrieve details of an entity by its identifier.

Parameters

ParameterDescriptionRequiredTypeDefault Value
identifierEntity IDYesIntegerN/A

Example Request

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

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Update Entity Endpoint PUT /api/v1/entity/{identifier}

Resource URL/api/v1/entity/{identifier}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Update an existing entity by its identifier.

Parameters

ParameterDescriptionRequiredTypeDefault Value
identifierEntity IDYesIntegerN/A

Request Body

ParameterDescriptionRequiredTypeDefault Value
nameEntity nameNoStringnull
attributesList of attributesYesArrayN/A
typeEntity typesYesArrayN/A
client_idClient identifierNoStringnull
ontology_idOntology identifierYesIntegerN/A
created_userUser who created itNoStringnull
styleStyle objectNoObjectnull

Example Request

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

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Delete Entity Endpoint DELETE /api/v1/entity/{identifier}

Resource URL/api/v1/entity/{identifier}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Delete an entity by its identifier.

Parameters

ParameterDescriptionRequiredTypeDefault Value
identifierEntity IDYesIntegerN/A

Example Request

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

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Get All Entities Details Endpoint GET /api/v1/entity

Resource URL/api/v1/entity
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Retrieve a paginated list of all entities.

Parameters

ParameterDescriptionRequiredTypeDefault Value
pagePage number to retrieveNoInteger1
page_sizeNumber of items per pageNoInteger10
client_idClient identifierNoStringN/A
ontology_idOntology identifierNoIntegerN/A
nameEntity name filterNoStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/entity?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 CodeMessage
200Successful Response
422Validation Error

Add Node Endpoint POST /api/v1/entity/add_node

Resource URL/api/v1/entity/add_node
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Add a new node to the entity graph.

Request Body

ParameterDescriptionRequiredTypeDefault Value
nodeEntity detailsYesObjectN/A
linkRelationship detailsYesObjectN/A

Example Request

curl -X 'POST' \
'https://braegen.ai/api/v1/entity/add_node' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "node": {"name": "Node1", "attributes": ["attr1"], "type": ["type1"], "client_id": "client_123", "ontology_id": 1},
    "link": {"name": "Link1", "attributes": ["attr1"], "source_id": "1", "target_id": "2", "client_id": "client_123"}
}'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Bulk Upload Data Endpoint POST /api/v1/entity/bulk_upload

Resource URL/api/v1/entity/bulk_upload
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Bulk upload entity data via a file.

Request Body

ParameterDescriptionRequiredTypeDefault Value
fileFile to uploadYesBinaryN/A

Example Request

curl -X 'POST' \
'https://braegen.ai/api/v1/entity/bulk_upload' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: multipart/form-data' \
-F '[email protected]'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Download CSV Template For Bulk Upload Endpoint GET /api/v1/entity/download-bulk-format/

Resource URL/api/v1/entity/download-bulk-format/
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Download the bulk upload CSV template file for uploading a set of entity data.

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/entity/download-bulk-format/' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Previous

Pipeline Management

Next

Graph Management

On this page

Add Entities Details Endpoint POST /api/v1/entity/createDescriptionRequest BodyExample RequestExample ResponseHTTP ResponsesGet Entity Details By Id Endpoint GET /api/v1/entity/{identifier}DescriptionParametersExample RequestExample ResponseHTTP ResponsesUpdate Entity Endpoint PUT /api/v1/entity/{identifier}DescriptionParametersRequest BodyExample RequestExample ResponseHTTP ResponsesDelete Entity Endpoint DELETE /api/v1/entity/{identifier}DescriptionParametersExample RequestExample ResponseHTTP ResponsesGet All Entities Details Endpoint GET /api/v1/entityDescriptionParametersExample RequestExample ResponseHTTP ResponsesAdd Node Endpoint POST /api/v1/entity/add_nodeDescriptionRequest BodyExample RequestExample ResponseHTTP ResponsesBulk Upload Data Endpoint POST /api/v1/entity/bulk_uploadDescriptionRequest BodyExample RequestExample ResponseHTTP ResponsesDownload CSV Template For Bulk Upload Endpoint GET /api/v1/entity/download-bulk-format/DescriptionExample RequestExample ResponseHTTP Responses