BREAGEN Logo
Data Source Management

Collection Management

Create Collection Endpoint POST /v1/api/dm/collection/create

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

Description

Create a new collection.

Request Body

ParameterDescriptionRequiredTypeDefault Value
collectionCollection nameYesStringN/A
descriptionCollection descriptionYesStringN/A

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/dm/collection/create' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "collection": "Sample Collection",
    "description": "A sample collection for testing"
}'

Example Response

{
    "message": "Collection created successfully"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Get All Collections Endpoint GET /v1/api/dm/collection/get_all_collections

Resource URL/v1/api/dm/collection/get_all_collections
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Get all collections.

Example Request

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

Example Response

{
    "message": "Collections retrieved successfully",
    "results": [
        {
            "collection": "Sample Collection",
            "description": "A sample collection for testing"
        }
    ]
}

HTTP Responses

HTTP CodeMessage
200Successful Response

Get Collection By Id Endpoint GET /v1/api/dm/collection/collection_id/{collection_id}

Resource URL/v1/api/dm/collection/collection_id/{collection_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Get a collection by its ID.

Parameters

ParameterDescriptionRequiredTypeDefault Value
collection_idCollection IDYesStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/dm/collection/collection_id/coll_123' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'

Example Response

{
    "message": "Collection retrieved successfully",
    "collection": "Sample Collection",
    "description": "A sample collection for testing"
}

Update Collection Endpoint PUT /v1/api/dm/collection/{collection_id}

Resource URL/v1/api/dm/collection/{collection_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Update an existing collection by its ID.

Parameters

ParameterDescriptionRequiredTypeDefault Value
collection_idCollection IDYesStringN/A

Request Body

ParameterDescriptionRequiredTypeDefault Value
collection_idCollection IDYesStringN/A
descriptionCollection descriptionYesStringN/A

Example Request

curl -X 'PUT' \
'https://braegen.ai/v1/api/dm/collection/coll_123' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "collection": "Updated Collection",
    "description": "An updated sample collection"
}'

Example Response

{
    "message": "Collection updated successfully",
    "collection": "Updated Collection",
    "description": "An updated sample collection"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Delete Collection Endpoint DELETE /v1/api/dm/collection/{collection_id}

Resource URL/v1/api/dm/collection/{collection_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Delete a collection by its ID.

Parameters

ParameterDescriptionRequiredTypeDefault Value
collection_idCollection IDYesStringN/A

Example Request

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

Example Response

{
    "message": "Collection deleted successfully"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error