Skip to main content

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

Request Body

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:
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

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

Behavior

  1. Snapshot: Creates a model-version record with the current state (config, metrics, predictors)
  2. Reset: Clears learned state, metrics, and training history
  3. Status: Sets model to draft (requires retraining)

Error Codes

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