DataRobot
Learn
API Reference
Community
{{user.name}}
Log In
DataRobot for Developers
Embed cutting edge AI into the applications and services you build.
Get Started
API Reference
v2.22
Home
Guides
Recipes
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Guides
API Reference
Changelog
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Introduction
Quickstart Guide
Concepts
API Authentication
Prediction Server Authentication
Guide to different DataRobot endpoints
Measuring Data Drift
Prevent inaccurate predictions with Humble AI
Tutorials
Movie ratings - sentiment
Soccer Match prediction
Finance Finder - Batch prediction
Dog Breed Categorization
Introduction
Quickstart Guide
Concepts
API Authentication
Prediction Server Authentication
Guide to different DataRobot endpoints
Measuring Data Drift
Prevent inaccurate predictions with Humble AI
Tutorials
Movie ratings - sentiment
Soccer Match prediction
Finance Finder - Batch prediction
Dog Breed Categorization
DataRobot Public API
applications
get
List of available application types to deploy.
get
Retrieve one application type
get
List application type usecases
get
Paginated list of applications created by the currently authenticated user.
post
Create an application
delete
Delete an application
get
Retrieve an application
patch
Update an application's name and/or domain prefix
get
A list of users with access to this application
patch
Update access control for this application.
patch
Redeploys application with refreshed auth token.
post
Schedules a build job
patch
Update the application's deployment state.
post
Links a deployment to an application
delete
Delete link between application and deployment.
get
Get a list of users, groups and organizations that have an access to this application
patch
Share an application with a user, group, or organization
get
Get application user role
patch
Redeploys application with specified version.
documentation
get
List all available document types and locales.
get
List all generated documents.
post
Request generation of automated document
delete
Delete automated document.
get
Download generated document.
get
Retrieve a documentation template
get
Get template's access control list
patch
Update template's access controls
predictions
get
List Batch Prediction job definitions
post
Creates a new Batch Prediction job definition
delete
Delete Batch Prediction job definition
get
Retrieve Batch Prediction job definition
patch
Update Batch Prediction job definition
get
List batch prediction jobs
post
Creates a new Batch Prediction job
post
Create a new a Batch Prediction job based on an existing Batch Prediction job.
post
Launch a Batch Prediction job for scoring
delete
Cancel a Batch Prediction job
get
Retrieve Batch Prediction job
patch
Update a Batch Prediction job
put
Creates a new_model_id Batch Prediction job
get
Download the scored data set of a batch prediction job
get
Lists imported models optionally filtering them by a string query
post
Import a previously exported DRX model to be served by SSE
delete
Delete imported by from storage along with all its metadata
get
Get imported DRX model details
patch
Allows updating some of the imported DRX model metadata fields
put
Replace an already imported DRX model with a new one
post
Create configuration for a scheduled prediction integration job
get
Retrieves configuration of a scheduled prediction integration integration job
patch
Update configuration for a scheduled prediction integration job
get
Get a list of a job runs with their details
get
Get a single job run details
get
Get a list of a specific job run's logs
delete
Delete an existing PredictionExplanationsInitialization.
get
Retrieve the current PredictionExplanationsInitialization.
post
Create a new prediction explanations initialization.
get
List all prediction jobs for a project
delete
Cancel a queued prediction job
get
Look up a particular prediction job
get
List predictions datasets uploaded to a project.
post
Upload a dataset for predictions from a ``DataSource``.
post
Create prediction dataset
post
Upload a file for predictions from an attached file.
post
Upload a file for predictions from a URL.
delete
Delete a dataset that was uploaded for prediction.
get
Get the metadata of a specific dataset. This only works for datasets uploaded to an existing project for prediction.
post
Create a new PredictionExplanations object (and its accompanying PredictionExplanationsRecord).
get
Retrieve stored Prediction Explanations.
get
List PredictionExplanationsRecord objects for a project.
delete
Delete saved Prediction Explanations.
get
Retrieve a PredictionExplanationsRecord object.
get
Get a list of prediction records.
post
Make new predictions.
get
Get a completed set of predictions.
get
Get a list of prediction metadata records.
get
Retrieve metadata for a set of predictions.
get
List training prediction jobs
post
Submits a job to compute predictions for training data
get
Retrieve training predictions
get
List scheduled deployment batch prediction jobs a user can view
delete
Delete scheduled job
get
List a single deployment batch prediction job
patch
Run or stop a previously created scheduled integration job
calendars
get
Retrieve the list of allowed country codes to request preloaded calendars generation for.
get
List all available calendars for a user.
post
Create a calendar from a file.
post
Initialize generation of preloaded calendars.
post
Create a calendar from the dataset
delete
Delete a calendar.
get
Retrieve information about a calendar.
patch
Update a calendar's name
get
Get a list of users who have access to this calendar and their roles on the calendar.
patch
Update the access control for this calendar.
catalog_items
get
List all catalog items accessible by the user.
infrastructure
get
Retrieve the information about cluster license
put
Create or replace license
post
Check if a license is valid
get
Retrieve version information.
comments
post
Post a comment
delete
Delete a comment
get
Retrieve a comment
patch
Update a comment
get
List comments
custom_models
get
Get custom model feature impact.
post
Create custom model feature impact.
get
List custom model deployments.
get
Get custom model resource limits.
get
List custom model tests.
post
Create custom model test.
delete
Cancel custom model test.
get
Get custom model test.
get
Get custom model test log.
get
Get custom model test log tail.
get
List custom models.
post
Create custom model.
post
Clone custom model.
post
Create a new prediction explanations initialization for custom model.
delete
Delete custom model.
get
Get custom model.
patch
Update custom model.
get
Download the latest custom model version content.
patch
Assign training data to custom model.
get
List custom model versions.
patch
Update custom model version files.
post
Create custom model version.
patch
Create custom model version from remote repository with files from previous version.
post
Create custom model version from remote repository.
get
Get custom model version.
patch
Update custom model version.
delete
Cancel dependency build.
get
Download custom model version content.
get
Get custom model feature impact.
post
Create custom model feature impact.
post
Create a new prediction explanations initialization for custom model version.
get
List training blueprints.
post
Create a blueprint from a single custom training estimator.
datasets
post
Create Data Engine workspace state
get
Read Data Engine workspace state
get
List datasets
patch
Execute bulk dataset action
post
Create dataset from Data Engine workspace
post
Create dataset from data source
post
Create dataset from file
post
Create dataset from HDFS URL
post
Create dataset from URL
delete
Delete dataset
get
Get dataset details
patch
Modify dataset
get
List dataset access
patch
Modify dataset access
get
Get dataset features
patch
Recover deleted dataset
get
Get dataset feature histogram
get
List dataset feature transforms
post
Create dataset feature transform
get
Get dataset feature transform
get
Retrieve dataset featurelists
post
Create dataset featurelist
delete
Delete dataset featurelist
get
Get dataset featurelist
patch
Update dataset featurelist
get
Retrieve original dataset data
get
Describe dataset permissions
get
Get dataset projects
post
Schedule dataset refresh
delete
Deletes an existing dataset refresh job
get
Gets configuration of a user scheduled dataset refresh job by job ID
patch
Update a dataset refresh job
get
List related datasets
post
Create dataset relationship.
delete
Delete dataset relationship.
patch
Update dataset relationship.
get
List dataset shared roles
patch
Modify dataset shared roles
get
List dataset versions
post
Create dataset version from Data Engine workspace
post
Create dataset version from Data Source
post
Create dataset version from file
post
Create dataset version from HDFS URL
post
Create dataset version from data source
post
Create dataset version from URL
delete
Delete dataset version
get
Get dataset details by version
get
Get dataset features
patch
Recover deleted dataset version
get
Get dataset feature histogram
get
Retrieve dataset featurelists
get
Get dataset featurelist
get
Retrieve original dataset data
post
Create dataset version from previous version
get
Get dataset projects by version
images
get
Retrieve the images data quality log content and log length as JSON
get
Retrieve a text file containing the images data quality log.
get
Get a list of duplicate images containing the number of occurrences of each image
get
List image bins and covers for every target value or range.
get
List all metadata for images in the EDA sample
get
Returns a list of image metadata elements.
get
Returns a single image metadata.
get
Returns a file for a single image
get
Retrieve the images data quality log content and log length as JSON
get
Retrieve a text file containing the images data quality log
deployments
get
List deleted deployments
patch
Erase deleted deployments
get
List deployments
post
Create deployment from DataRobot model
post
Create deployment from recommended model
delete
Delete deployment
get
Retrieve deployment
patch
Update deployment
get
Retrieve accuracy metric
get
Retrieve accuracy over time data for one single metric.
post
Submit actuals values from AI Catalog
post
Submit actuals values
post
Score challenger models
get
List challenger models
post
Create challenger model
delete
Delete challenger model
get
Get challenger model
patch
Update challenger model
get
Retrieve feature drift scores
get
Get deployment features
get
Retrieve humility stats
get
Retrieve humility stats over time
patch
Model Replacement.
get
Retrieve secondary datasets configuration for a deployment.
patch
Update the secondary datasets configuration for the deployed model.
get
List the secondary datasets configuration history for a deployment
post
Model Replacement Validation.
post
Add report to execution queue.
post
Submit external deployment prediction data.
get
Retrieve predictions results.
post
Compute predictions synchronously
get
Retrieve Scoring Code
post
Build Java package containing Scoring Code with agent integration.
get
Retrieve service statistics
get
Retrieve service statistics over time
get
Get deployment settings
patch
Update deployment settings
get
Get model deployment's access control list
patch
Update model deployment's controls
get
Retrieve target drift
get
List prediction servers.
demo
post
Create a demo application
data_sources
get
Get data source's access control list
patch
Update data source's access controls
get
Describe data source permissions.
get
Get data source's access control list
patch
Modify data source shared roles.
data_stores
patch
Update data store's controls
get
Describe data store permissions.
get
Get data store's access control list
patch
Modify data store shared roles.
image_augmentation
get
List of augmentation lists that match the specified query.
post
Creates a new augmentation list based on the posted payload data.
delete
Delete an existing augmentation lists by id
get
Returns a single augmentation list with the specified id.
patch
Update and existing augmentation list, with passed in values.
get
Augmentation list of all available transformations that are supported in the system.
post
Requests the creation of sample augmentations based on the augmentation list passed in.
get
Retrieve previously generated Augmentation Samples
models
post
Create model export job
get
Get information about all blender builder jobs associated with the project.
post
Create blenders using the blender builder system.
get
Get information about a completed blender builder job.
get
List all blenders in a project.
post
Create a blender from other models using a specified blender method.
post
Check if models can be blended.
get
Retrieve a blender.
get
List datetime partitioned project models
post
Train a new datetime model.
post
Retrain an existing datetime model with specified parameters.
get
Get datetime model
get
Retrieve the data for the Accuracy over Time plots.
get
Retrieve the metadata for the Accuracy over Time plots.
get
Retrieve the preview for the Accuracy over Time plots.
get
Retrieve the data for the Anomaly over Time plots.
get
Retrieve the metadata for the Anomaly over Time plots.
get
Retrieve the preview for the Anomaly over Time plots.
get
Retrieve a plot displaying the stability of the datetime model across different backtests.
post
Score all the available backtests of a datetime model.
post
Computes Datetime Trend plots for time series and OTV projects.
get
Retrieve a plot displaying the stability of the time series model across different forecast distances.
get
Retrieve the data for the Forecast vs Actual plots.
get
Retrieve the metadata for the Forecast vs Actual plots.
get
Retrieve the preview for the Forecast vs Actual plots.
post
Prepare a model for deployment
post
Train a frozen datetime model.
get
List all frozen models from a project.
post
Train a new frozen model with parameters from an existing model.
get
Look up a particular frozen model.
get
List modeling jobs
delete
Cancel a modeling job.
get
Look up a specific modeling job
get
List project models
post
Train a new model
post
Retrain a model
delete
Delete a model from the leaderboard.
get
Get model
patch
Updates a model's attribute(s).
post
Submit a job to make a new version of the model with different advanced tuning parameters.
get
Retrieve information about all advanced tuning parameters available for the specified model.
get
Retrieve a CSV file of the raw data displayed with the anomaly score from the model.
get
Retrieve a table of the raw data displayed with the anomaly score from the specific model.
get
Retrieve all available confusion charts for model.
get
Retrieve the confusion chart data from a single source.
get
Calculates and sends frequency of class in distributed among other classes for actual and predicted data.
get
Retrieve metadata for the confusion chart of a model.
post
Run Cross Validation on a model.
get
Get Cross Validation scores for each partition in a model.
get
Download exported model
get
List the features used in a model.
get
Retrieve all available lift charts for model.
get
Retrieve the lift chart data from a single source.
get
Retrieve a summary of how the model's subtasks handle missing values.
get
Retrieve all available lift charts for multiclass model.
get
Retrieve the multiclass lift chart data from a single source.
get
Get number of iterations trained
get
Retrieve model parameters.
get
Retrieve prediction intervals that are already calculated for this model.
post
Calculate prediction intervals for the specified percentiles for this model.
get
Retrieve all residuals charts for a model.
get
Retrieve the residuals chart data from a single source.
get
Retrieve all available ROC curves for model.
get
Retrieve the ROC curve data from a single source.
get
Retrieve Scoring Code
get
Get supported capabilities for a model.
get
Retrieve word cloud data for a model.
get
List recommended models for the project
get
Get recommended model
get
List SHAP matrix records.
post
Calculate a matrix with SHAP based prediction explanations scores.
get
Get matrix with SHAP prediction explanations scores.
model_packages
get
List model packages
get
Retrieve info about a model package.
post
Archive a model package.
get
Retrieve feature list.
get
Get model package's access control list
user_notifications
get
List notification channels
post
Create notification channel
delete
Delete notification channel
get
Retrieve notification channel
put
Update notification channel
post
Sending a 6 digit verification code to user's email
post
Retrieve the status of whether admin enter code correctly
get
List notification policies
post
Create notification policy
delete
Delete notification policy
get
Retrieve notification policy
put
Update notification policy
post
Test webhook notification channel
get
Retrieve status of notification channel test
post
Post a remote deployment event
delete
Delete all user notifications
get
List user notifications
patch
Mark all as read
delete
Delete user notification
patch
Mark as read
notifications
get
List event types and groups the user can include in notification policies.
get
List the notification logs
get
List the ignored notifications filtered by orgId if provided
post
Create a new ignored notification
delete
Delete the existing notification policy mute
post
Resends the notification
organizations
get
List organizations
get
Retrieve organization
get
List organization jobs
user_management
get
List organization users
post
Add user to an existing organization.
delete
Remove user from organization
get
Retrieve user from organization
patch
Patch organization's user
get
Get the rate limits and account limits for a user
patch
Update the rate limits and account limits for a user
projects
post
Clone a project
get
List projects
post
Create project.
delete
Delete a project
get
Get project.
patch
Update project
get
Get project's access control list
patch
Update project's access controls
patch
Start modeling
post
Pause or unpause Autopilot
post
Start autopilot
post
Validate columns for potential use as the group-by column for cross-series functionality.
get
Retrieve potential multiseries ID columns to use with a particular datetime partition column.
get
List project jobs
delete
Cancel Job
get
Get job
get
Retrieve eligible cross-series group-by columns.
post
Detect multiseries properties
get
Retrieve relationships configuration for a project
get
List all secondary dataset configurations for a project
post
Create secondary dataset configurations for a project.
delete
Soft deletes a secondary dataset configuration.
get
Retrieve secondary dataset configuration by ID.
get
Check project status
insights
get
Retrieve anomaly assessment records.
delete
Delete the anomaly assessment record.
get
Retrieve anomaly assessment record.
get
Retrieve predictions preview for the anomaly assessment record.
get
Retrieve the Accuracy Over Time (AOT) chart data for an external dataset for a project.
get
Retrieve the metadata of the Accuracy Over Time (AOT) chart for an external dataset.
get
Retrieve a preview of the Accuracy Over Time (AOT) chart for an external dataset.
get
Retrieve Feature Effects for a model backtest.
post
Add a request to the queue to calculate Feature Effects for a backtest.
get
Retrieve Feature Effects metadata for each backtest. Response contains status and available sources for each backtest of the model.
get
Retrieve Feature Fit for a model backtest.
post
Add a request to the queue to calculate Feature Fit for a backtest.
get
Retrieve Feature Fit metadata for each backtest. Response contains status and available sources for each backtest of the model.
get
List of scores on prediction datasets for a project.
post
Compute model scores for external dataset.
get
List all featurelists with feature association matrix availability flags for a project.
get
Retrieval for pairwise feature association statistics.
post
Compute feature association matrix.
get
Retrieval for feature association plotting between a pair of features.
get
Retrieve the frequent values information for a particular feature.
post
Calculate the anomaly assessment insight.
get
List of Confusion Charts objects on external datasets for a project with filtering option by dataset.
get
Retrieve Confusion Chart objects on external datasets for a project.
get
Calculate and sends frequency of class in distributed among other classes for actual and predicted data.
get
Retrieve metadata for the confusion chart of a model on external dataset for a project.
get
Retrieve List of Lift chart data on prediction datasets for a project.
get
Retrieve List of Multiclass Lift chart data on prediction datasets for a project.
get
List of residuals charts objects on prediction datasets.
get
List of ROC curve objects on prediction datasets for a project with filtering option by dataset.
get
Retrieve Feature Effects for the model.
post
Add a request to the queue to calculate Feature Effects.
get
Retrieve Feature Effects metadata. Response contains status and available sources.
get
Retrieve Feature Fit for the model.
post
Add a request to the queue to calculate Feature Fit.
get
Retrieve Feature Fit metadata. Response contains status and available sources.
get
Retrieve feature impact scores for features in a model.
post
Add a request to calculate feature impact to the queue.
get
Retrieve feature impact scores for each class in a multiclass model.
get
Retrieve Feature Impact for a model.
post
Create a Shap based Feature Impact.
get
List of all payoff matrices for a project.
post
Create a payoff matrix.
delete
Delete a payoff matrix in a project.
put
Update a payoff matrix.
features
post
Create multiple new features by changing the type of existing features.
get
Retrieve the result of a batch variable type transformation.
get
Get feature histogram
get
Retrieve Feature Discovery Lineage
get
List project features
get
List feature metrics
get
Get project feature
get
List project modeling features.
get
Retrieve project modeling feature.
post
Create a new feature by changing the type of an existing one.
bias_and_fairness
get
List Bias vs Accuracy insights.
get
List calculated Per Class Bias insights.
post
Start insight calculations.
blueprints
get
List blueprints
get
Retrieve a blueprint by its ID.
get
Retrieve a blueprint chart by blueprint id.
get
Retrieve blueprint tasks documentation.
get
Retrieve a reduced model blueprint chart by model id.
get
Retrieve task documentation for a reduced model blueprint.
series_insights
get
Retrieve the histograms for series insights.
get
List the scores per individual series for the specified multiseries model.
post
Request the computation of per-series scores for a multiseries model.
get
Retrieve the CSV file for the series accuracy.
datetime_partitioning
get
Retrieve datetime partitioning configuration.
post
Preview the fully specified datetime partitioning generated by the requested configuration.
get
List all created optimized datetime partitioning configurations
post
Create an optimized datetime partitioning configuration using the target.
get
Retrieve optimized datetime partitioning configuration
get
Retrieve the feature derivation log content and log length for a time series project as JSON.
get
Retrieve a text file containing the time series project feature log
eureqa
get
Retrieve Eureqa model details plot.
get
Retrieve Eureqa model details plot.
post
Create a new model from an existing eureqa solution.
get
Retrieve the pareto front for the specified Eureqa model.
feature_discovery
get
Download the project dataset with features added by feature discovery
get
Retrieve the feature discovery log content and log length
get
Retrieve a text file containing the feature discovery log
get
Download feature discovery SQL recipe
post
Generate feature discovery SQL recipe
post
Create a relationships configuration
delete
Delete a relationships configuration
get
Retrieve a relationships configuration
put
Replace a relationships configuration
featurelists
get
List featurelists
get
Retrieve a feature list
location_ai
post
Create a map of one location feature
get
Retrieve a map of one location feature
image_insights
get
List all Image Activation Maps for the project.
get
List all Image Embeddings for the project.
get
Retrieve Image Activation Maps for a feature of a model.
post
Request the computation of image activation maps for the specified model.
get
Retrieve ImageEmbeddings for a feature of a model.
post
Request the computation of image embeddings for the specified model.
cross_class_accuracy
get
List Cross Class Accuracy scores.
post
Start Cross Class Accuracy calculations.
data_disparity
get
Get Cross Class Data Disparity results.
post
Start insight calculations.
datarobot_prime
get
Check a Model for Prime Eligibility
get
List Rulesets
post
Create Rulesets
get
Get Prime Files
post
Create a Prime File
get
Retrieve metadata about a DataRobot Prime file
get
Download Code
get
List all Prime models in a project
post
Create a Prime Model from a Ruleset
get
Retrieve a Prime model details
rating_tables
get
List Rating Table Models
post
Create New Models From A Rating Table
get
Retrieve Rating Table Model
get
List Rating Tables For The Project
post
Upload Modified Rating Table File
get
Retrieve Rating Table Information
patch
Update an uploaded rating table
get
Retrieve Rating Table File
status
get
List tasks
delete
Delete a task
get
Get task status
use_case
get
List available use cases templates.
get
Get an individual use case value template by its name.
get
Calculate value of template with given template parameters.
get
List use cases the requesting user has access to.
post
Create a new use case.
delete
Delete a use case
get
Retrieve a use case.
patch
Update a use case.
get
Retrieve the activities of a use case.
get
Get a list of resources attached to this use case.
post
Attach a list of resources to this use case.
delete
Removes a resource from a use case.
get
Get a resource that is attached to a use case.
get
Retrieve realized value information for a given use case over a period of time
get
Get a list of users, groups and organizations that have an access to this use case
patch
Share a use case with a user, group or organization.
resource_usage
delete
Reset resource usage for all resources
get
List resource usage for a user
delete
Reset resource usage for the resource