BREAGEN Logo
Question Management

Answer Management

Get All Endpoint GET /v1/answer/all/

Resource URL/v1/answer/all/
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Retrieve all answers without pagination.

Example Request

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

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response

Get Filtered Answers Endpoint GET /v1/answer/all_filtered/

Resource URL/v1/answer/all_filtered/
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Get answers with optional filtering by question_id or list_id.

Parameters

ParameterDescriptionRequiredTypeDefault Value
emailUser emailYesStringN/A
pagePage numberNoInteger1
page_sizeNumber of items per pageNoInteger10
question_idFilter by question IDNoIntegerN/A
list_idFilter by question list IDNoIntegerN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/answer/all_filtered/[email protected]&page=1&page_size=10&question_id=1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Get By Id Endpoint GET /v1/answer/{answer_id}

Resource URL/v1/answer/{answer_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Retrieve an answer by its ID.

Parameters

ParameterDescriptionRequiredTypeDefault Value
answer_idAnswer IDYesIntegerN/A

Example Request

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

Example Response

{
    "description": "Successful Response"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Update Endpoint PUT /v1/answer/{answer_id}

Resource URL/v1/answer/{answer_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Update an existing answer by its ID.

Parameters

ParameterDescriptionRequiredTypeDefault Value
answer_idAnswer IDYesIntegerN/A

Request Body

ParameterDescriptionRequiredTypeDefault Value
answerAnswer textNoStringnull
question_idQuestion IDNoIntegernull
emailUser emailNoStringnull

Example Request

curl -X 'PUT' \
'https://braegen.ai/v1/answer/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "answer": "Updated answer",
    "question_id": 1,
    "email": "[email protected]"
}'

Example Response

{
    "description": "Successful Response"
}
HTTP CodeMessage
200Successful Response
422Validation Error

Delete Endpoint DELETE /v1/answer/{answer_id}

Resource URL/v1/answer/{answer_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Delete an answer by its ID.

Parameters

ParameterDescriptionRequiredTypeDefault Value
answer_idAnswer IDYesIntegerN/A
user_idUser IDNoStringN/A

Example Request

curl -X 'DELETE' \
'https://braegen.ai/v1/answer/1?user_id=user_123' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'

Example Response

{
    "description": "Successful Response"
}
HTTP CodeMessage
200Successful Response
422Validation Error

Create Endpoint POST /v1/answer/

Resource URL/v1/answer/
Response FormatJSON
Requires AuthenticationYes
Rate LimitedNo
HTTPSYes

Description

Create a new answer.

Request Body

ParameterDescriptionRequiredTypeDefault Value
answerAnswer textNoStringnull
question_idQuestion IDNoIntegernull
emailUser emailNoStringnull

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/answer/' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
    "answer": "Sample answer",
    "question_id": 1,
    "email": "[email protected]"
}'

Example Response

 
{
    "description": "Successful Response"
}
HTTP CodeMessage
200Successful Response
422Validation Error