Ontology Management

Create Ontology Endpoint `POST` /api/v1/ontology/create

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

Description

Create a new ontology.

Request Body

Parameter	Description	Required	Type	Default Value
name	Name of the ontology	Yes	String	N/A
description	Ontology description	Yes	String	N/A
client_id	Client identifier	Yes	String	N/A
created_user	User who created it	Yes	String	N/A

Example Request

curl -X 'POST' \
'https://braegen.ai/api/v1/ontology/create' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Sample Ontology",
    "description": "A test ontology",
    "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 All Ontology Endpoint `GET` /api/v1/ontology

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

Description

Retrieve a paginated list of all ontologies.

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	Ontology name filter	No	String	N/A

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/ontology?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

Update Ontology Endpoint `PUT` /api/v1/ontology/{identifier}

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

Description

Update an existing ontology by its identifier.

Parameters

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

Request Body

Parameter	Description	Required	Type	Default Value
name	Name of the ontology	Yes	String	N/A
description	Ontology description	Yes	String	N/A

Example Request

curl -X 'PUT' \
'https://braegen.ai/api/v1/ontology/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Updated Ontology",
    "description": "Updated description"
}'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Delete Ontology Endpoint `DELETE` /api/v1/ontology/{identifier}

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

Description

Delete an ontology by its identifier.

Parameters

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

Example Request

curl -X 'DELETE' \
'https://braegen.ai/api/v1/ontology/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

Ontology Management

Create Ontology Endpoint POST /api/v1/ontology/create

HTTP Responses

Get All Ontology Endpoint GET /api/v1/ontology

HTTP Responses

Update Ontology Endpoint PUT /api/v1/ontology/{identifier}

HTTP Responses

Delete Ontology Endpoint DELETE /api/v1/ontology/{identifier}

HTTP Responses

On this page

Create Ontology Endpoint `POST` /api/v1/ontology/create

Get All Ontology Endpoint `GET` /api/v1/ontology

Update Ontology Endpoint `PUT` /api/v1/ontology/{identifier}

Delete Ontology Endpoint `DELETE` /api/v1/ontology/{identifier}