BREAGEN Logo
Document Understanding

Predictor Management

Initiate Generate Prediction POST /v1/api/predictor/predictor

Resource URL/v1/api/predictor/predictor
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Description

Initiate the generation of a prediction for a specific opportunity.

Request Body

ParameterDescriptionRequiredTypeDefault Value
opportunityIdentifier of the opportunityYesStringN/A
session_idUnique session identifierYesStringN/A
prediction_typeType of prediction to generateYesStringN/A

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/predictor/predictor' \
-H 'accept: application/json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'opportunity=opp_001&session_id=sess_123&prediction_type=revenue'

Example Response

{
    "is_error": false,
    "message": "Prediction generation initiated successfully",
    "results": {
        "task_id": "pred_task_001",
        "opportunity": "opp_001",
        "prediction_type": "revenue"
    }
}

HTTP Response

HTTP CodeMessage
200Successful Response
422Validation Error

Predictor Management

Get Prediction GET /v1/api/predictor/get_prediction

Resource URL/v1/api/predictor/get_prediction
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Description

Retrieve a prediction for a specific opportunity based on the prediction type.

Parameters

ParameterDescriptionRequiredTypeDefault Value
opportunityIdentifier of the opportunityYesStringN/A
prediction_typeType of prediction to retrieveYesStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/predictor/get_prediction?opportunity=opp_001&prediction_type=revenue' \
-H 'accept: application/json'

Example Response

curl -X 'GET' \
'https://braegen.ai/v1/api/predictor/get_prediction?opportunity=opp_001&prediction_type=revenue' \
-H 'accept: application/json'

HTTP Response

HTTP CodeMessage
200Successful Response
422Validation Error

Initiate Generate Predictions

POST /v1/api/predictor/generate_predictions

Resource URL/v1/api/predictor/generate_predictions
Response FormatJSON
MethodPOST
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Description

Initiate the generate of a prediction

Request Body

ParameterDescriptionRequiredTypeDefault Value
opportunityIdentifier of the opportunityYesStringN/A
session_idUnique session identifierYesStringN/A
documentlesschecking documentYesBooleanfalse

Example Request

$ curl -X POST \
http://your-api-endpoint/v1/api/predictor/generate_predictions \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'opportunity=opp-123&session_id=session-456&documentless=false'

Example Response

{
    "status": "success",
    "batch_id": "batch-101"
}

HTTP Responses

HTTP CodeMessage
200Success
422Validation Error

Predictor Operations

Get Generated Predictions GET /v1/api/predictor/get_generated_predictions

Resource URL/v1/api/predictor/get_generated_predictions
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Description

Retrieve previously generated predictions for a specified opportunity.

Parameters

ParameterDescriptionRequiredTypeDefault Value
opportunityQuery parameter: Identifier of the opportunityYesStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/predictor/get_generated_predictions?opportunity=opp123' \
-H 'accept: application/json'

Example Response

{
  "is_error": false,
  "message": "Predictions retrieved successfully",
  "results": {
    "predictions": [
      {"type": "success_probability", "value": "0.85", "timestamp": "2025-04-07T10:00:00Z"},
      {"type": "resource_estimate", "value": "100 hours", "timestamp": "2025-04-07T10:00:00Z"}
    ]
  }
}

HTTP Response

HTTP CodeMessage
200Successful Response
422Validation Error

Previous

Document Processing API

Next

Task Status Management

On this page