Prediction Management

Prediction Management provides functionality to manage predictions related to opportunities within the system. This service enables operations such as creating predictions and recalculating scores based on opportunity data.

Prediction Operations

Prediction Operations provide tools to create and manage predictions for opportunities, including generating predictive outcomes and recalculating scores.

Prediction Operations - Create Prediction `POST` /v1/api/prediction/create/{client_id}

Resource URL	/v1/api/prediction/create/{client_id}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description
client_id	Path parameter: ID of the client
Input JSON	Prediction details JSON object (request body). See `PredictionBase` schema for details.

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/prediction/create/98765' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "opportunity_id": "12345",
    "outcome": {"success_probability": 0.75},
    "duration": {"days": 30},
    "cost": {"amount": 5000},
    "quantum": {"value": 10000}
}'

Example Response

{
    "is_error": false,
    "message": "Prediction created successfully",
    "data": {
        "opportunity_id": "12345",
        "client_id": "98765",
        "outcome": {"success_probability": 0.75},
        "duration": {"days": 30},
        "cost": {"amount": 5000},
        "quantum": {"value": 10000}
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Prediction Operations - Recalculate Score `PUT` /v1/api/prediction/recalculate_score

Resource URL	/v1/api/prediction/recalculate_score
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description
opportunity_id	Query parameter (required): ID of the opportunity
client_id	Query parameter (required): ID of the client

Example Request

curl -X 'PUT' \
'https://braegen.ai/v1/api/prediction/recalculate_score?opportunity_id=12345&client_id=98765' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Score recalculated successfully",
    "data": {
        "opportunity_id": "12345",
        "client_id": "98765",
        "new_score": 92
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Prediction Management

Prediction Operations

Prediction Operations - Create Prediction POST /v1/api/prediction/create/{client_id}

Parameters

Example Request

Example Response

HTTP Responses

Prediction Operations - Recalculate Score PUT /v1/api/prediction/recalculate_score

Parameters

Example Request

Example Response

HTTP Responses

On this page

Prediction Operations - Create Prediction `POST` /v1/api/prediction/create/{client_id}

Prediction Operations - Recalculate Score `PUT` /v1/api/prediction/recalculate_score