Get Groups Filtered Endpoint GET /v1/group/all_filtered/
| Resource URL | /v1/group/all_filtered/ |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Retrieve groups with optional filtering and search.
| Parameter | Description | Required | Type | Default Value |
|---|
| page | Page number | No | Integer | 1 |
| page_size | Number of items per page | No | Integer | 10 |
| search_query | Text to search by group name | No | String | N/A |
curl -X 'GET' \
'https://braegen.ai/v1/group/all_filtered/?page=1&page_size=10&search_query=sample' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Get By Id Endpoint GET /v1/group/{group_id}
| Resource URL | /v1/group{id} |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Retrieve a group by its ID.
| Parameter | Description | Required | Type | Default Value |
|---|
| group_id | Group ID | Yes | Integer | N/A |
curl -X 'GET' \
'https://braegen.ai/v1/group/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
| Resource URL | /v1/group/{group_id} |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Update an existing group by its ID.
| Parameter | Description | Required | Type | Default Value |
|---|
| group_id | Group ID | Yes | Integer | N/A |
| user_id | User ID | No | String | N/A |
| Parameter | Description | Required | Type | Default Value |
|---|
| group_name | Group name | No | String | null |
| description | Group description | No | String | null |
curl -X 'PUT' \
'https://braegen.ai/v1/group/1?user_id=user_123' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"group_name": "Updated Group",
"description": "Updated description"
}'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Delete Endpoint DELETE /v1/group/{group_id}
| Resource URL | /v1/group/{group_id} |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Delete a group by its ID.
| Parameter | Description | Required | Type | Default Value |
|---|
| group_id | Group ID | Yes | Integer | N/A |
| user_id | User ID | No | String | N/A |
curl -X 'DELETE' \
'https://braegen.ai/v1/group/1?user_id=user_123' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Groups By Question Id Endpoint GET /v1/group/get_groups_by_question_id/{question_id}
| Resource URL | /v1/group/get_groups_by_question_id/{question_id} |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Retrieve groups associated with a specific question ID.
| Parameter | Description | Required | Type | Default Value |
|---|
| question_id | Question ID | Yes | Integer | N/A |
curl -X 'GET' \
'https://braegen.ai/v1/group/get_groups_by_question_id/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Create Endpoint POST /v1/group/
| Resource URL | /v1/group/ |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Create a new group.
| Parameter | Description | Required | Type | Default Value |
|---|
| user_id | User ID | No | String | N/A |
| Parameter | Description | Required | Type | Default Value |
|---|
| group_name | Group name | No | String | null |
| description | Group description | No | String | null |
curl -X 'POST' \
'https://braegen.ai/v1/group/?user_id=user_123' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"group_name": "Sample Group",
"description": "Group description"
}'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
