Einstein Discovery REST API Examples

Use Einstein Discovery REST API examples to perform tasks.

Considerations

While using the Einstein Discovery REST API, keep this in mind:

Request parameters may be included as part of the Einstein Discovery REST API resource URL, for example, /smartdatadiscovery/models?q=status. A request body is a rich input which may be included as part of the request. When accessing a resource, you can use either a request body or request parameters. You cannot use both.
With a request body, use Content-Type: application/json or Content-Type: application/xml.
With request parameters, use Content-Type: application/x-www-form-urlencoded.
Get Predictions

The Einstein Prediction Service provides a REST API endpoint to request a prediction.
Manage Prediction Definitions

The Einstein Prediction Service provides REST API endpoints to manage prediction definitions. A prediction definition specifies what the model is trying to predict and the Salesforce entity associated with the prediction. Each prediction definition has a unique id. Only certain attributes of a prediction definition can be modified.
Manage Models

The Einstein Prediction Service provides REST API endpoints to manage models. Each model has a unique id. A model is used to evaluate predictors and return predictions and improvements. These REST endpoints allow you to make updates to model metadata, but not update the actual predictive model.
Manage Prediction Jobs

The Einstein Prediction Service provides REST API endpoints to run bulk scoring jobs for a prediction. Bulk scoring jobs enable you to score predictions on multiple records at a time. For example, after deploying an updated model, use bulk scoring to refresh all prediction scores. You can also run bulk scoring on historical data to see how well your model performs. With bulk scoring, you can score all records, a segment of the records, or records that haven’t reached the terminal state.
Manage Model Refresh Jobs

The Einstein Prediction Service provides REST API endpoints to retrieve metadata for model refresh jobs.
Query Prediction History

The Einstein Prediction Service provides a REST API endpoint to query prediction histories.