POST /api/v1/algorithm-models//score
Score a single customer using a trained model. Pass customer attributes and receive a score with explanatory details.
Path Parameters
| Parameter | Type | Description |
|---|
id | string | Algorithm model ID |
Request Body
| Field | Type | Required | Description |
|---|
attributes | object | No | Customer attributes to score (e.g., { "age": 35, "tenure_months": 24 }) |
Example
Response
The score endpoint returns a result whose shape varies by model type. The common fields are:
Additional fields may be present depending on model type:
| Field | Type | Present for | Description |
|---|
score | number | All types | The computed score (0-1) |
confidence | number | bayesian | Confidence level of the score |
explanations | array | scorecard, bayesian, logistic_regression, gradient_boosted, thompson_bandit, epsilon_greedy | Per-predictor or per-offer score breakdowns |
The response does not include modelId, modelType, or predictorContributions at the top level. Those fields are only returned by the /score-offer-set endpoint.
Error Codes
| Code | Reason |
|---|
404 | Model not found |
Roles
any authenticated
POST /api/v1/algorithm-models//reset-learning
Reset a model’s learned state back to its initial configuration. Creates a version snapshot before resetting for rollback capability. The model status is set to draft after reset.
Path Parameters
| Parameter | Type | Description |
|---|
id | string | Algorithm model ID |
Behavior
- Snapshot: Creates a model-version record with the current state (config, metrics, predictors)
- Reset: Clears learned state, metrics, and training history
- Status: Sets model to
draft (requires retraining)
Error Codes
| Code | Reason |
|---|
400 | Model is a scorecard type (scorecards have no learned state) |
404 | Model not found |
Response
Returns the updated model object with cleared state.
This operation clears all learned parameters. The model must be retrained before it can be used for scoring in production flows. A version snapshot is created automatically for rollback.
Roles
admin, editor
See also: Algorithm Models | Model Governance
