Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

R client v2.29 reference documentation

The table below outlines the major classes for the methods introduced in v2.29 of the R client.

Each endpoint has a corresponding function in the datarobot.apicore package. There is also a "wrapper function" in the datarobot package that is consistent with the existing package; DataRobot recommends using these wrapper functions if you have used earlier versions of the API Client.

All URIs are relative to https://app.datarobot.com/api/v2.

AiCatalogApi

Functions and Description HTTP request
  • CatalogItemsList
  • datarobot::ListCatalogItems
List all catalog items accessible by the user.
GET /catalogItems/
  • CatalogItemsPatch
  • datarobot::PatchCatalogItems
Update the name, description, or tags for the requested catalog item.
PATCH /catalogItems/{catalogId}/
  • CatalogItemsRetrieve
  • datarobot::RetrieveCatalogItems
Retrieves latest version information, by ID, for catalog items.
GET /catalogItems/{catalogId}/
  • DataEngineQueryGeneratorsCreate
  • datarobot::CreateDataEngineQueryGenerator
Create a data engine query generator
POST /dataEngineQueryGenerators/
  • DataEngineQueryGeneratorsRetrieve
  • datarobot::RetrieveDataEngineQueryGenerators
Retrieve a data engine query generator given ID.
GET /dataEngineQueryGenerators/{dataEngineQueryGeneratorId}/
  • DataEngineWorkspaceStatesCreate
  • datarobot::CreateDataEngineWorkspaceStates
Create Data Engine workspace state
POST /dataEngineWorkspaceStates/
  • DataEngineWorkspaceStatesFromDataEngineQueryGeneratorCreate
  • datarobot::CreateDatasetFromDataEngineQueryGenerator
Create Data Engine workspace state from a query generator
POST /dataEngineWorkspaceStates/fromDataEngineQueryGenerator/
  • DataEngineWorkspaceStatesRetrieve
  • datarobot::RetrieveDataEngineWorkspaceStates
Read Data Engine workspace state
GET /dataEngineWorkspaceStates/{workspaceStateId}/
  • DatasetsAccessControlList
  • datarobot::ListDatasetsAccessControl
List dataset access
GET /datasets/{datasetId}/accessControl/
  • DatasetsAccessControlPatchMany
  • datarobot::PatchManyDatasetsAccessControl
Modify dataset access
PATCH /datasets/{datasetId}/accessControl/
  • DatasetsAllFeaturesDetailsList
  • datarobot::ListDatasetsAllFeaturesDetails
Get dataset features
GET /datasets/{datasetId}/allFeaturesDetails/
  • DatasetsDelete
  • datarobot::DeleteDatasets
Delete dataset
DELETE /datasets/{datasetId}/
  • DatasetsDeletedPatchMany
  • datarobot::PatchManyDatasetsDeleted
Recover deleted dataset
PATCH /datasets/{datasetId}/deleted/
  • DatasetsFeatureHistogramsRetrieve
  • datarobot::RetrieveDatasetsFeatureHistograms
Get dataset feature histogram
GET /datasets/{datasetId}/featureHistograms/{featureName}/
  • DatasetsFeatureTransformsCreate
  • datarobot::CreateDatasetsFeatureTransforms
Create dataset feature transform
POST /datasets/{datasetId}/featureTransforms/
  • DatasetsFeatureTransformsList
  • datarobot::ListDatasetsFeatureTransforms
List dataset feature transforms
GET /datasets/{datasetId}/featureTransforms/
  • DatasetsFeatureTransformsRetrieve
  • datarobot::RetrieveDatasetsFeatureTransforms
Get dataset feature transform
GET /datasets/{datasetId}/featureTransforms/{featureName}/
  • DatasetsFeaturelistsCreate
  • datarobot::CreateDatasetsFeaturelists
Create dataset featurelist
POST /datasets/{datasetId}/featurelists/
  • DatasetsFeaturelistsDelete
  • datarobot::DeleteDatasetsFeaturelists
Delete dataset featurelist
DELETE /datasets/{datasetId}/featurelists/{featurelistId}/
  • DatasetsFeaturelistsList
  • datarobot::ListDatasetsFeaturelists
Retrieve dataset featurelists
GET /datasets/{datasetId}/featurelists/
  • DatasetsFeaturelistsPatch
  • datarobot::PatchDatasetsFeaturelists
Update dataset featurelist
PATCH /datasets/{datasetId}/featurelists/{featurelistId}/
  • DatasetsFeaturelistsRetrieve
  • datarobot::RetrieveDatasetsFeaturelists
Get dataset featurelist
GET /datasets/{datasetId}/featurelists/{featurelistId}/
  • DatasetsFileList
  • datarobot::ListDatasetsFile
Retrieve original dataset data
GET /datasets/{datasetId}/file/
  • DatasetsFromDataEngineWorkspaceStateCreate
  • datarobot::CreateDatasetsFromDataEngineWorkspaceState
Create dataset from Data Engine workspace
POST /datasets/fromDataEngineWorkspaceState/
  • DatasetsFromDataSourceCreate
  • datarobot::CreateDatasetsFromDataSource
Create dataset from data source
POST /datasets/fromDataSource/
  • DatasetsFromFileCreate
  • datarobot::CreateDatasetsFromFile
Create dataset from file
POST /datasets/fromFile/
  • DatasetsFromHDFSCreate
  • datarobot::CreateDatasetsFromHDFS
Create dataset from HDFS URL
POST /datasets/fromHDFS/
  • DatasetsFromURLCreate
  • datarobot::CreateDatasetsFromURL
Create dataset from URL
POST /datasets/fromURL/
  • DatasetsList
  • datarobot::ListDatasets
List datasets
GET /datasets/
  • DatasetsPatch
  • datarobot::PatchDatasets
Modify dataset
PATCH /datasets/{datasetId}/
  • DatasetsPatchMany
  • datarobot::PatchManyDatasets
Execute bulk dataset action
PATCH /datasets/
  • DatasetsPermissionsList
  • datarobot::ListDatasetsPermissions
Describe dataset permissions
GET /datasets/{datasetId}/permissions/
  • DatasetsProjectsList
  • datarobot::ListDatasetsProjects
Get dataset projects
GET /datasets/{datasetId}/projects/
  • DatasetsRefreshJobsCreate
  • datarobot::CreateDatasetsRefreshJobs
Schedule dataset refresh
POST /datasets/{datasetId}/refreshJobs/
  • DatasetsRefreshJobsDelete
  • datarobot::DeleteDatasetsRefreshJobs
Deletes an existing dataset refresh job
DELETE /datasets/{datasetId}/refreshJobs/{jobId}/
  • DatasetsRefreshJobsExecutionResultsList
  • datarobot::ListDatasetsRefreshJobsExecutionResults
Results of dataset refresh job.
GET /datasets/{datasetId}/refreshJobs/{jobId}/executionResults/
  • DatasetsRefreshJobsList
  • datarobot::ListDatasetsRefreshJobs
Information about scheduled jobs for given dataset.
GET /datasets/{datasetId}/refreshJobs/
  • DatasetsRefreshJobsPatch
  • datarobot::PatchDatasetsRefreshJobs
Update a dataset refresh job
PATCH /datasets/{datasetId}/refreshJobs/{jobId}/
  • DatasetsRefreshJobsRetrieve
  • datarobot::RetrieveDatasetsRefreshJobs
Gets configuration of a user scheduled dataset refresh job by job ID
GET /datasets/{datasetId}/refreshJobs/{jobId}/
  • DatasetsRelationshipsCreate
  • datarobot::CreateDatasetsRelationships
Create dataset relationship.
POST /datasets/{datasetId}/relationships/
  • DatasetsRelationshipsDelete
  • datarobot::DeleteDatasetsRelationships
Delete dataset relationship.
DELETE /datasets/{datasetId}/relationships/{datasetRelationshipId}/
  • DatasetsRelationshipsList
  • datarobot::ListDatasetsRelationships
*List related datasets *
GET /datasets/{datasetId}/relationships/
  • DatasetsRelationshipsPatch
  • datarobot::PatchDatasetsRelationships
Update dataset relationship.
PATCH /datasets/{datasetId}/relationships/{datasetRelationshipId}/
  • DatasetsRetrieve
  • datarobot::RetrieveDatasets
Get dataset details
GET /datasets/{datasetId}/
  • DatasetsSharedRolesList
  • datarobot::ListDatasetsSharedRoles
List dataset shared roles
GET /datasets/{datasetId}/sharedRoles/
  • DatasetsSharedRolesPatchMany
  • datarobot::PatchManyDatasetsSharedRoles
Modify dataset shared roles
PATCH /datasets/{datasetId}/sharedRoles/
  • DatasetsVersionsAllFeaturesDetailsList
  • datarobot::ListDatasetsVersionsAllFeaturesDetails
Get dataset features
GET /datasets/{datasetId}/versions/{datasetVersionId}/allFeaturesDetails/
  • DatasetsVersionsDelete
  • datarobot::DeleteDatasetsVersions
Delete dataset version
DELETE /datasets/{datasetId}/versions/{datasetVersionId}/
  • DatasetsVersionsDeletedPatchMany
  • datarobot::PatchManyDatasetsVersionsDeleted
Recover deleted dataset version
PATCH /datasets/{datasetId}/versions/{datasetVersionId}/deleted/
  • DatasetsVersionsFeatureHistogramsRetrieve
  • datarobot::RetrieveDatasetsVersionsFeatureHistograms
Get dataset feature histogram
GET /datasets/{datasetId}/versions/{datasetVersionId}/featureHistograms/{featureName}/
  • DatasetsVersionsFeaturelistsList
  • datarobot::ListDatasetsVersionsFeaturelists
Retrieve dataset featurelists
GET /datasets/{datasetId}/versions/{datasetVersionId}/featurelists/
  • DatasetsVersionsFeaturelistsRetrieve
  • datarobot::RetrieveDatasetsVersionsFeaturelists
Get dataset featurelist
GET /datasets/{datasetId}/versions/{datasetVersionId}/featurelists/{featurelistId}/
  • DatasetsVersionsFileList
  • datarobot::ListDatasetsVersionsFile
Retrieve original dataset data
GET /datasets/{datasetId}/versions/{datasetVersionId}/file/
  • DatasetsVersionsFromDataEngineWorkspaceStateCreate
  • datarobot::CreateDatasetsVersionsFromDataEngineWorkspaceState
Create dataset version from Data Engine workspace
POST /datasets/{datasetId}/versions/fromDataEngineWorkspaceState/
  • DatasetsVersionsFromDataSourceCreate
  • datarobot::CreateDatasetsVersionsFromDataSource
Create dataset version from Data Source
POST /datasets/{datasetId}/versions/fromDataSource/
  • DatasetsVersionsFromFileCreate
  • datarobot::CreateDatasetsVersionsFromFile
Create dataset version from file
POST /datasets/{datasetId}/versions/fromFile/
  • DatasetsVersionsFromHDFSCreate
  • datarobot::CreateDatasetsVersionsFromHDFS
Create dataset version from HDFS URL
POST /datasets/{datasetId}/versions/fromHDFS/
  • DatasetsVersionsFromLatestVersionCreate
  • datarobot::CreateDatasetsVersionsFromLatestVersion
Create dataset version from data source
POST /datasets/{datasetId}/versions/fromLatestVersion/
  • DatasetsVersionsFromURLCreate
  • datarobot::CreateDatasetsVersionsFromURL
Create dataset version from URL
POST /datasets/{datasetId}/versions/fromURL/
  • DatasetsVersionsFromVersionCreate
  • datarobot::CreateDatasetsVersionsFromVersion
Create dataset version from previous version
POST /datasets/{datasetId}/versions/{datasetVersionId}/fromVersion/
  • DatasetsVersionsList
  • datarobot::ListDatasetsVersions
List dataset versions
GET /datasets/{datasetId}/versions/
  • DatasetsVersionsProjectsList
  • datarobot::ListDatasetsVersionsProjects
Get dataset projects by version
GET /datasets/{datasetId}/versions/{datasetVersionId}/projects/
  • DatasetsVersionsRetrieve
  • datarobot::RetrieveDatasetsVersions
Get dataset details by version
GET /datasets/{datasetId}/versions/{datasetVersionId}/
  • UserBlueprintsBulkValidationsCreate
  • datarobot::CreateUserBlueprintsBulkValidations
Validate many user blueprints.
POST /userBlueprintsBulkValidations/
  • UserBlueprintsCreate
  • datarobot::CreateUserBlueprints
Create a user blueprint.
POST /userBlueprints/
  • UserBlueprintsDelete
  • datarobot::DeleteUserBlueprints
Delete a user blueprint.
DELETE /userBlueprints/{userBlueprintId}/
  • UserBlueprintsDeleteMany
  • datarobot::DeleteManyUserBlueprints
Delete user blueprints.
DELETE /userBlueprints/
  • UserBlueprintsFromBlueprintIdCreate
  • datarobot::CreateUserBlueprintsFromBlueprintId
Clone a blueprint from a project.
POST /userBlueprints/fromBlueprintId/
  • UserBlueprintsFromCustomTaskVersionIdCreate
  • datarobot::CreateUserBlueprintsFromCustomTaskVersionId
Create a user blueprint from a single custom task.
POST /userBlueprints/fromCustomTaskVersionId/
  • UserBlueprintsFromUserBlueprintIdCreate
  • datarobot::CreateUserBlueprintsFromUserBlueprintId
Clone a user blueprint.
POST /userBlueprints/fromUserBlueprintId/
  • UserBlueprintsInputTypesList
  • datarobot::ListUserBlueprintsInputTypes
Retrieve input types.
GET /userBlueprintsInputTypes/
  • UserBlueprintsList
  • datarobot::ListUserBlueprints
List user blueprints.
GET /userBlueprints/
  • UserBlueprintsPatch
  • datarobot::PatchUserBlueprints
Update a user blueprint.
PATCH /userBlueprints/{userBlueprintId}/
  • UserBlueprintsProjectBlueprintsCreate
  • datarobot::CreateUserBlueprintsProjectBlueprints
Add user blueprints to a project.
POST /userBlueprintsProjectBlueprints/
  • UserBlueprintsRetrieve
  • datarobot::RetrieveUserBlueprints
Retrieve a user blueprint.
GET /userBlueprints/{userBlueprintId}/
  • UserBlueprintsSharedRolesList
  • datarobot::ListUserBlueprintsSharedRoles
Get a list of users, groups and organizations that have an access to this user blueprint
GET /userBlueprints/{userBlueprintId}/sharedRoles/
  • UserBlueprintsSharedRolesPatchMany
  • datarobot::PatchManyUserBlueprintsSharedRoles
Share a user blueprint with a user, group, or organization
PATCH /userBlueprints/{userBlueprintId}/sharedRoles/
  • UserBlueprintsTaskParametersCreate
  • datarobot::CreateUserBlueprintsTaskParameters
Validate task parameters.
POST /userBlueprintsTaskParameters/
  • UserBlueprintsTasksList
  • datarobot::ListUserBlueprintsTasks
Retrieve tasks for blueprint construction.
GET /userBlueprintsTasks/
  • UserBlueprintsValidationsCreate
  • datarobot::CreateUserBlueprintsValidations
Validate a user blueprint.
POST /userBlueprintsValidations/

AnalyticsApi

Functions and Description HTTP request
  • EventLogsEventsList
  • datarobot::ListEventLogsEvents
Retrieve all the available events. DEPRECATED API.
GET /eventLogs/events/
  • EventLogsList
  • datarobot::ListEventLogs
Retrieve one page of audit log records.
GET /eventLogs/
  • EventLogsPredictionUsageList
  • datarobot::ListEventLogsPredictionUsage
Retrieve prediction usage data.
GET /eventLogs/predictionUsage/
  • EventLogsRetrieve
  • datarobot::RetrieveEventLogs
Get audit record by ID.
GET /eventLogs/{recordId}/
  • UsageDataExportsCreate
  • datarobot::CreateUsageDataExports
Create a customer usage data artifact request. Requires \"CAN_ACCESS_USER_ACTIVITY\" permission.
POST /usageDataExports/
  • UsageDataExportsRetrieve
  • datarobot::RetrieveUsageDataExports
Retrieve a prepared customer usage data artifact.
GET /usageDataExports/{artifactId}/
  • UsageDataExportsSupportedEventsList
  • datarobot::ListUsageDataExportsSupportedEvents
Describe supported available audit events with which to filter result data.
GET /usageDataExports/supportedEvents/
  • UsersRateLimitUsageDelete
  • datarobot::DeleteUsersRateLimitUsage
Reset resource usage for the resource
DELETE /users/{userId}/rateLimitUsage/{resourceName}/
  • UsersRateLimitUsageDeleteMany
  • datarobot::DeleteManyUsersRateLimitUsage
Reset resource usage for all resources
DELETE /users/{userId}/rateLimitUsage/
  • UsersRateLimitUsageList
  • datarobot::ListUsersRateLimitUsage
List resource usage for a user
GET /users/{userId}/rateLimitUsage/

ApplicationsApi

Functions and Description HTTP request
  • ApplicationUserRoleRetrieve
  • datarobot::RetrieveApplicationUserRole
Get application user role
GET /applications/{applicationId}/userRole/
  • ApplicationsAccessControlList
  • datarobot::ListApplicationsAccessControl
A list of users with access to this application
GET /applications/{applicationId}/accessControl/
  • ApplicationsAccessControlPatchMany
  • datarobot::PatchManyApplicationsAccessControl
Update access control for this application.
PATCH /applications/{applicationId}/accessControl/
  • ApplicationsCreate
  • datarobot::CreateApplications
Create an application
POST /applications/
  • ApplicationsDelete
  • datarobot::DeleteApplications
Delete an application
DELETE /applications/{applicationId}/
  • ApplicationsDeploymentsCreate
  • datarobot::CreateApplicationsDeployments
Links a deployment to an application
POST /applications/{applicationId}/deployments/
  • ApplicationsDeploymentsDelete
  • datarobot::DeleteApplicationsDeployments
Delete link between application and deployment.
DELETE /applications/{applicationId}/deployments/{modelDeploymentId}/
  • ApplicationsDuplicateCreate
  • datarobot::CreateApplicationsDuplicate
Create a duplicate of the application
POST /applications/{applicationId}/duplicate/
  • ApplicationsList
  • datarobot::ListApplications
Paginated list of applications created by the currently authenticated user.
GET /applications/
  • ApplicationsPatch
  • datarobot::PatchApplications
Update an application's name and/or description
PATCH /applications/{applicationId}/
  • ApplicationsRetrieve
  • datarobot::RetrieveApplications
Retrieve an application
GET /applications/{applicationId}/
  • ApplicationsSharedRolesList
  • datarobot::ListApplicationsSharedRoles
Get a list of users, groups and organizations that have an access to this application
GET /applications/{applicationId}/sharedRoles/
  • ApplicationsSharedRolesPatchMany
  • datarobot::PatchManyApplicationsSharedRoles
Share an application with a user, group, or organization
PATCH /applications/{applicationId}/sharedRoles/

BlueprintsApi

Functions and Description HTTP request
  • ProjectsBlueprintsBlueprintChartList
  • datarobot::GetBlueprintChart
Retrieve a blueprint chart by blueprint id.
GET /projects/{projectId}/blueprints/{blueprintId}/blueprintChart/
  • ProjectsBlueprintsBlueprintDocsList
  • datarobot::GetBlueprintDocumentation
Retrieve blueprint tasks documentation.
GET /projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/
  • ProjectsBlueprintsList
  • datarobot::ListBlueprints
List blueprints
GET /projects/{projectId}/blueprints/
  • ProjectsBlueprintsRetrieve
  • datarobot::GetBlueprint
Retrieve a blueprint by its ID.
GET /projects/{projectId}/blueprints/{blueprintId}/
  • ProjectsModelsBlueprintChartList
  • datarobot::GetModelBlueprintChart
Retrieve a reduced model blueprint chart by model id.
GET /projects/{projectId}/models/{modelId}/blueprintChart/
  • ProjectsModelsBlueprintDocsList
  • datarobot::GetModelBlueprintDocumentation
Retrieve task documentation for a reduced model blueprint.
GET /projects/{projectId}/models/{modelId}/blueprintDocs/
  • ProjectsModelsLogsList
  • datarobot::ListProjectsModelsLogs
Retrieve an archive (tar.gz) of the logs produced and persisted by a model.
GET /projects/{projectId}/models/{modelId}/logs/
  • ProjectsModelsTrainingArtifactList
  • datarobot::ListProjectsModelsTrainingArtifact
Retrieve an archive (tar.gz) of the artifacts produced and persisted by a model.
GET /projects/{projectId}/models/{modelId}/trainingArtifact/
  • UserBlueprintsBulkValidationsCreate
  • datarobot::CreateUserBlueprintsBulkValidations
Validate many user blueprints.
POST /userBlueprintsBulkValidations/
  • UserBlueprintsCreate
  • datarobot::CreateUserBlueprints
Create a user blueprint.
POST /userBlueprints/
  • UserBlueprintsDelete
  • datarobot::DeleteUserBlueprints
Delete a user blueprint.
DELETE /userBlueprints/{userBlueprintId}/
  • UserBlueprintsDeleteMany
  • datarobot::DeleteManyUserBlueprints
Delete user blueprints.
DELETE /userBlueprints/
  • UserBlueprintsFromBlueprintIdCreate
  • datarobot::CreateUserBlueprintsFromBlueprintId
Clone a blueprint from a project.
POST /userBlueprints/fromBlueprintId/
  • UserBlueprintsFromCustomTaskVersionIdCreate
  • datarobot::CreateUserBlueprintsFromCustomTaskVersionId
Create a user blueprint from a single custom task.
POST /userBlueprints/fromCustomTaskVersionId/
  • UserBlueprintsFromUserBlueprintIdCreate
  • datarobot::CreateUserBlueprintsFromUserBlueprintId
Clone a user blueprint.
POST /userBlueprints/fromUserBlueprintId/
  • UserBlueprintsInputTypesList
  • datarobot::ListUserBlueprintsInputTypes
Retrieve input types.
GET /userBlueprintsInputTypes/
  • UserBlueprintsList
  • datarobot::ListUserBlueprints
List user blueprints.
GET /userBlueprints/
  • UserBlueprintsPatch
  • datarobot::PatchUserBlueprints
Update a user blueprint.
PATCH /userBlueprints/{userBlueprintId}/
  • UserBlueprintsProjectBlueprintsCreate
  • datarobot::CreateUserBlueprintsProjectBlueprints
Add user blueprints to a project.
POST /userBlueprintsProjectBlueprints/
  • UserBlueprintsRetrieve
  • datarobot::RetrieveUserBlueprints
Retrieve a user blueprint.
GET /userBlueprints/{userBlueprintId}/
  • UserBlueprintsSharedRolesList
  • datarobot::ListUserBlueprintsSharedRoles
Get a list of users, groups and organizations that have an access to this user blueprint
GET /userBlueprints/{userBlueprintId}/sharedRoles/
  • UserBlueprintsSharedRolesPatchMany
  • datarobot::PatchManyUserBlueprintsSharedRoles
Share a user blueprint with a user, group, or organization
PATCH /userBlueprints/{userBlueprintId}/sharedRoles/
  • UserBlueprintsTaskParametersCreate
  • datarobot::CreateUserBlueprintsTaskParameters
Validate task parameters.
POST /userBlueprintsTaskParameters/
  • UserBlueprintsTasksList
  • datarobot::ListUserBlueprintsTasks
Retrieve tasks for blueprint construction.
GET /userBlueprintsTasks/
  • UserBlueprintsValidationsCreate
  • datarobot::CreateUserBlueprintsValidations
Validate a user blueprint.
POST /userBlueprintsValidations/

CommentsApi

Functions and Description HTTP request
  • CommentsCreate
  • datarobot::CreateComments
Post a comment
POST /comments/
  • CommentsDelete
  • datarobot::DeleteComments
Delete a comment
DELETE /comments/{commentId}/
  • CommentsList
  • datarobot::ListComments
List comments
GET /comments/{entityType}/{entityId}/
  • CommentsPatch
  • datarobot::PatchComments
Update a comment
PATCH /comments/{commentId}/
  • CommentsRetrieve
  • datarobot::RetrieveComments
Retrieve a comment
GET /comments/{commentId}/

CredentialsApi

Functions and Description HTTP request
  • CredentialsAssociationsListForCredential
  • datarobot::ListForCredentialCredentialsAssociations
List all objects associated with the specified credentials.
GET /credentials/{credentialId}/associations/
  • CredentialsAssociationsPatchMany
  • datarobot::PatchManyCredentialsAssociations
Add objects associated with credentials
PATCH /credentials/{credentialId}/associations/
  • CredentialsCreate
  • datarobot::CreateCredentials
Store a new set of credentials which can be used for data sources creation.
POST /credentials/
  • CredentialsDelete
  • datarobot::DeleteCredentials
Delete the credentials set.
DELETE /credentials/{credentialId}/
  • CredentialsList
  • datarobot::ListCredentials
List credentials.
GET /credentials/
  • CredentialsPatch
  • datarobot::PatchCredentials
Update specified credentials
PATCH /credentials/{credentialId}/
  • CredentialsRetrieve
  • datarobot::RetrieveCredentials
Retrieve the credentials set.
GET /credentials/{credentialId}/

CustomTasksApi

Functions and Description HTTP request
  • CustomTaskVersionCreateFromLatest
  • datarobot::CreateFromLatestCustomTaskVersion
Update custom task version files.
PATCH /customTasks/{customTaskId}/versions/
  • CustomTasksAccessControlList
  • datarobot::ListCustomTasksAccessControl
Get a list of users who have access to this custom task and their roles on it.
GET /customTasks/{customTaskId}/accessControl/
  • CustomTasksAccessControlPatchMany
  • datarobot::PatchManyCustomTasksAccessControl
Grant access or update roles for users on this custom task and appropriate learning data.
PATCH /customTasks/{customTaskId}/accessControl/
  • CustomTasksCreate
  • datarobot::CreateCustomTasks
Create a custom task
POST /customTasks/
  • CustomTasksDelete
  • datarobot::DeleteCustomTasks
Delete custom task.
DELETE /customTasks/{customTaskId}/
  • CustomTasksDownloadList
  • datarobot::ListCustomTasksDownload
Download the latest custom task version content.
GET /customTasks/{customTaskId}/download/
  • CustomTasksFromCustomTaskCreate
  • datarobot::CreateCustomTasksFromCustomTask
Clone custom task.
POST /customTasks/fromCustomTask/
  • CustomTasksList
  • datarobot::ListCustomTasks
List custom tasks.
GET /customTasks/
  • CustomTasksPatch
  • datarobot::PatchCustomTasks
Update custom task.
PATCH /customTasks/{customTaskId}/
  • CustomTasksRetrieve
  • datarobot::RetrieveCustomTasks
Get custom task.
GET /customTasks/{customTaskId}/
  • CustomTasksVersionsCreate
  • datarobot::CreateCustomTasksVersions
Create custom task version.
POST /customTasks/{customTaskId}/versions/
  • CustomTasksVersionsDependencyBuildCreate
  • datarobot::CreateCustomTasksVersionsDependencyBuild
Start a custom task version's dependency build.
POST /customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/
  • CustomTasksVersionsDependencyBuildDeleteMany
  • datarobot::DeleteManyCustomTasksVersionsDependencyBuild
Cancel dependency build.
DELETE /customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/
  • CustomTasksVersionsDependencyBuildList
  • datarobot::ListCustomTasksVersionsDependencyBuild
Retrieve the custom task version's dependency build status.
GET /customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/
  • CustomTasksVersionsDependencyBuildLogList
  • datarobot::ListCustomTasksVersionsDependencyBuildLog
Retrieve the custom task version's dependency build log.
GET /customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuildLog/
  • CustomTasksVersionsDownloadList
  • datarobot::ListCustomTasksVersionsDownload
Download custom task version content.
GET /customTasks/{customTaskId}/versions/{customTaskVersionId}/download/
  • CustomTasksVersionsFromRepositoryCreate
  • datarobot::CreateCustomTasksVersionsFromRepository
Create custom task version from remote repository.
POST /customTasks/{customTaskId}/versions/fromRepository/
  • CustomTasksVersionsFromRepositoryPatchMany
  • datarobot::PatchManyCustomTasksVersionsFromRepository
Create custom task version from remote repository with files from previous version.
PATCH /customTasks/{customTaskId}/versions/fromRepository/
  • CustomTasksVersionsList
  • datarobot::ListCustomTasksVersions
List custom task versions.
GET /customTasks/{customTaskId}/versions/
  • CustomTasksVersionsPatch
  • datarobot::PatchCustomTasksVersions
Update custom task version.
PATCH /customTasks/{customTaskId}/versions/{customTaskVersionId}/
  • CustomTasksVersionsRetrieve
  • datarobot::RetrieveCustomTasksVersions
Get custom task version.
GET /customTasks/{customTaskId}/versions/{customTaskVersionId}/

DataConnectivityApi

Functions and Description HTTP request
  • ExternalDataDriverFileCreate
  • datarobot::CreateExternalDataDriverFile
Upload JDBC driver from file.
POST /externalDataDriverFile/
  • ExternalDataDriversConfigurationList
  • datarobot::ListExternalDataDriversConfiguration
Driver configuration details.
GET /externalDataDrivers/{driverId}/configuration/
  • ExternalDataDriversCreate
  • datarobot::CreateExternalDataDrivers
Create a new JDBC driver.
POST /externalDataDrivers/
  • ExternalDataDriversDelete
  • datarobot::DeleteExternalDataDrivers
Delete the driver.
DELETE /externalDataDrivers/{driverId}/
  • ExternalDataDriversList
  • datarobot::ListDrivers
List drivers
GET /externalDataDrivers/
  • ExternalDataDriversPatch
  • datarobot::PatchExternalDataDrivers
Update properties of an existing JDBC Driver.
PATCH /externalDataDrivers/{driverId}/
  • ExternalDataDriversRetrieve
  • datarobot::GetDriver
Retrieve driver details.
GET /externalDataDrivers/{driverId}/
  • ExternalDataSourcesAccessControlList
  • datarobot::ListExternalDataSourcesAccessControl
Get data source's access control list
GET /externalDataSources/{dataSourceId}/accessControl/
  • ExternalDataSourcesAccessControlPatchMany
  • datarobot::PatchManyExternalDataSourcesAccessControl
Update data source's access controls
PATCH /externalDataSources/{dataSourceId}/accessControl/
  • ExternalDataSourcesCreate
  • datarobot::CreateDataSource
Create a data source.
POST /externalDataSources/
  • ExternalDataSourcesDelete
  • datarobot::DeleteDataSource
Delete the data source.
DELETE /externalDataSources/{dataSourceId}/
  • ExternalDataSourcesList
  • datarobot::ListDataSources
List data sources.
GET /externalDataSources/
  • ExternalDataSourcesPatch
  • datarobot::UpdateDataSource
Update the data source.
PATCH /externalDataSources/{dataSourceId}/
  • ExternalDataSourcesPermissionsList
  • datarobot::ListExternalDataSourcesPermissions
Describe data source permissions.
GET /externalDataSources/{dataSourceId}/permissions/
  • ExternalDataSourcesRetrieve
  • datarobot::GetDataSource
Data source details.
GET /externalDataSources/{dataSourceId}/
  • ExternalDataSourcesSharedRolesList
  • datarobot::ListExternalDataSourcesSharedRoles
Get data source's access control list
GET /externalDataSources/{dataSourceId}/sharedRoles/
  • ExternalDataSourcesSharedRolesPatchMany
  • datarobot::PatchManyExternalDataSourcesSharedRoles
Modify data source shared roles.
PATCH /externalDataSources/{dataSourceId}/sharedRoles/
  • ExternalDataStoresAccessControlPatchMany
  • datarobot::PatchManyExternalDataStoresAccessControl
Update data store's controls
PATCH /externalDataStores/{dataStoreId}/accessControl/
  • ExternalDataStoresColumnsCreate
  • datarobot::CreateExternalDataStoresColumns
Retrieves a data store's data columns.
POST /externalDataStores/{dataStoreId}/columns/
  • ExternalDataStoresCreate
  • datarobot::CreateDataStore
Create a data store.
POST /externalDataStores/
  • ExternalDataStoresCredentialsList
  • datarobot::ListExternalDataStoresCredentials
List credentials associated with the specified data store.
GET /externalDataStores/{dataStoreId}/credentials/
  • ExternalDataStoresDelete
  • datarobot::DeleteDataStore
Delete the data store.
DELETE /externalDataStores/{dataStoreId}/
  • ExternalDataStoresList
  • datarobot::ListDataStores
List data stores.
GET /externalDataStores/
  • ExternalDataStoresPatch
  • datarobot::UpdateDataStore
Updates a data store configuration.
PATCH /externalDataStores/{dataStoreId}/
  • ExternalDataStoresPermissionsList
  • datarobot::ListExternalDataStoresPermissions
Describe data store permissions.
GET /externalDataStores/{dataStoreId}/permissions/
  • ExternalDataStoresRetrieve
  • datarobot::GetDataStore
Data store details.
GET /externalDataStores/{dataStoreId}/
  • ExternalDataStoresSchemasCreate
  • datarobot::GetDataStoreSchemas
Retrieves a data store's data schemas.
POST /externalDataStores/{dataStoreId}/schemas/
  • ExternalDataStoresSharedRolesList
  • datarobot::ListExternalDataStoresSharedRoles
Get data store's access control list
GET /externalDataStores/{dataStoreId}/sharedRoles/
  • ExternalDataStoresSharedRolesPatchMany
  • datarobot::PatchManyExternalDataStoresSharedRoles
Modify data store shared roles.
PATCH /externalDataStores/{dataStoreId}/sharedRoles/
  • ExternalDataStoresTablesCreate
  • datarobot::GetDataStoreTables
Retrieves a data store's database tables (including views).
POST /externalDataStores/{dataStoreId}/tables/
  • ExternalDataStoresTestCreate
  • datarobot::TestDataStore
Tests data store connection.
POST /externalDataStores/{dataStoreId}/test/
  • ExternalDataStoresVerifySQLCreate
  • datarobot::CreateExternalDataStoresVerifySQL
Verifies a SQL query for a data store.
POST /externalDataStores/{dataStoreId}/verifySQL/
  • ExternalDriverConfigurationsList
  • datarobot::ListExternalDriverConfigurations
List available driver configurations.
GET /externalDriverConfigurations/
  • ExternalDriverConfigurationsRetrieve
  • datarobot::RetrieveExternalDriverConfigurations
Driver configuration details.
GET /externalDriverConfigurations/{configurationId}/

DatetimePartitioningApi

Functions and Description HTTP request
  • ProjectsDatetimePartitioningCreate
  • datarobot::CreateProjectsDatetimePartitioning
Preview the fully specified datetime partitioning generated by the requested configuration.
POST /projects/{projectId}/datetimePartitioning/
  • ProjectsDatetimePartitioningList
  • datarobot::GetDatetimePartition
Retrieve datetime partitioning configuration.
GET /projects/{projectId}/datetimePartitioning/
  • ProjectsOptimizedDatetimePartitioningsCreate
  • datarobot::CreateProjectsOptimizedDatetimePartitionings
Create an optimized datetime partitioning configuration using the target.
POST /projects/{projectId}/optimizedDatetimePartitionings/
  • ProjectsOptimizedDatetimePartitioningsList
  • datarobot::ListProjectsOptimizedDatetimePartitionings
List all created optimized datetime partitioning configurations
GET /projects/{projectId}/optimizedDatetimePartitionings/
  • ProjectsOptimizedDatetimePartitioningsRetrieve
  • datarobot::RetrieveProjectsOptimizedDatetimePartitionings
Retrieve optimized datetime partitioning configuration
GET /projects/{projectId}/optimizedDatetimePartitionings/{datetimePartitioningId}/
  • ProjectsTimeSeriesFeatureLogFileList
  • datarobot::DownloadTimeSeriesFeatureDerivationLog
Retrieve a text file containing the time series project feature log
GET /projects/{projectId}/timeSeriesFeatureLog/file/
  • ProjectsTimeSeriesFeatureLogList
  • datarobot::GetTimeSeriesFeatureDerivationLog
Retrieve the feature derivation log content and log length for a time series project as JSON.
GET /projects/{projectId}/timeSeriesFeatureLog/

DeploymentsApi

Functions and Description HTTP request
  • DeletedDeploymentsList
  • datarobot::ListDeletedDeployments
List deleted deployments
GET /deletedDeployments/
  • DeletedDeploymentsPatchMany
  • datarobot::PatchManyDeletedDeployments
Erase deleted deployments
PATCH /deletedDeployments/
  • DeploymentsAccuracyList
  • datarobot::GetDeploymentAccuracy
Retrieve accuracy metric
GET /deployments/{deploymentId}/accuracy/
  • DeploymentsAccuracyOverTimeList
  • datarobot::ListDeploymentsAccuracyOverTime
Retrieve accuracy over time data for one single metric.
GET /deployments/{deploymentId}/accuracyOverTime/
  • DeploymentsActualsFromDatasetCreate
  • datarobot::CreateDeploymentsActualsFromDataset
Submit actuals values from AI Catalog
POST /deployments/{deploymentId}/actuals/fromDataset/
  • DeploymentsActualsFromJSONCreate
  • datarobot::SubmitActuals
Submit actuals values
POST /deployments/{deploymentId}/actuals/fromJSON/
  • DeploymentsCapabilitiesList
  • datarobot::ListDeploymentsCapabilities
Retrieve capabilities.
GET /deployments/{deploymentId}/capabilities/
  • DeploymentsChallengerPredictionsCreate
  • datarobot::CreateDeploymentsChallengerPredictions
Score challenger models
POST /deployments/{deploymentId}/challengerPredictions/
  • DeploymentsChallengersCreate
  • datarobot::CreateDeploymentsChallengers
Create challenger model
POST /deployments/{deploymentId}/challengers/
  • DeploymentsChallengersDelete
  • datarobot::DeleteDeploymentsChallengers
Delete challenger model
DELETE /deployments/{deploymentId}/challengers/{challengerId}/
  • DeploymentsChallengersList
  • datarobot::ListDeploymentsChallengers
List challenger models
GET /deployments/{deploymentId}/challengers/
  • DeploymentsChallengersPatch
  • datarobot::PatchDeploymentsChallengers
Update challenger model
PATCH /deployments/{deploymentId}/challengers/{challengerId}/
  • DeploymentsChallengersRetrieve
  • datarobot::RetrieveDeploymentsChallengers
Get challenger model
GET /deployments/{deploymentId}/challengers/{challengerId}/
  • DeploymentsDelete
  • datarobot::DeleteDeployment
Delete deployment
DELETE /deployments/{deploymentId}/
  • DeploymentsFeatureDriftList
  • datarobot::ListDeploymentsFeatureDrift
Retrieve feature drift scores
GET /deployments/{deploymentId}/featureDrift/
  • DeploymentsFeatureDriftOverTimeList
  • datarobot::ListDeploymentsFeatureDriftOverTime
Retrieve drift over time info for a feature of the deployment.
GET /deployments/{deploymentId}/featureDriftOverTime/
  • DeploymentsFeaturesList
  • datarobot::ListDeploymentsFeatures
Get deployment features
GET /deployments/{deploymentId}/features/
  • DeploymentsFromLearningModelCreate
  • datarobot::CreateDeployment
Create deployment from DataRobot model
POST /deployments/fromLearningModel/
  • DeploymentsHumilityStatsList
  • datarobot::ListDeploymentsHumilityStats
Retrieve humility stats
GET /deployments/{deploymentId}/humilityStats/
  • DeploymentsHumilityStatsOverTimeList
  • datarobot::ListDeploymentsHumilityStatsOverTime
Retrieve humility stats over time
GET /deployments/{deploymentId}/humilityStatsOverTime/
  • DeploymentsList
  • datarobot::ListDeployments
List deployments
GET /deployments/
  • DeploymentsModelPatchMany
  • datarobot::ReplaceDeployedModel
Model Replacement.
PATCH /deployments/{deploymentId}/model/
  • DeploymentsModelSecondaryDatasetConfigurationHistoryList
  • datarobot::ListDeploymentsModelSecondaryDatasetConfigurationHistory
List the secondary datasets configuration history for a deployment
GET /deployments/{deploymentId}/model/secondaryDatasetConfigurationHistory/
  • DeploymentsModelSecondaryDatasetConfigurationList
  • datarobot::ListDeploymentsModelSecondaryDatasetConfiguration
Retrieve secondary datasets configuration for a deployment.
GET /deployments/{deploymentId}/model/secondaryDatasetConfiguration/
  • DeploymentsModelSecondaryDatasetConfigurationPatchMany
  • datarobot::PatchManyDeploymentsModelSecondaryDatasetConfiguration
Update the secondary datasets configuration for the deployed model.
PATCH /deployments/{deploymentId}/model/secondaryDatasetConfiguration/
  • DeploymentsModelValidationCreate
  • datarobot::ValidateReplaceDeployedModel
Model Replacement Validation.
POST /deployments/{deploymentId}/model/validation/
  • DeploymentsMonitoringDataDeletionsCreate
  • datarobot::CreateDeploymentsMonitoringDataDeletions
Endpoint for deleting deployment monitoring data.
POST /deployments/{deploymentId}/monitoringDataDeletions/
  • DeploymentsOnDemandReportsCreate
  • datarobot::CreateDeploymentsOnDemandReports
Add report to execution queue.
POST /deployments/{deploymentId}/onDemandReports/
  • DeploymentsPatch
  • datarobot::PatchDeployments
Update deployment
PATCH /deployments/{deploymentId}/
  • DeploymentsPredictionInputsFromDatasetCreate
  • datarobot::CreateDeploymentsPredictionInputsFromDataset
Submit external deployment prediction data.
POST /deployments/{deploymentId}/predictionInputs/fromDataset/
  • DeploymentsPredictionResultsList
  • datarobot::ListDeploymentsPredictionResults
Retrieve predictions results.
GET /deployments/{deploymentId}/predictionResults/
  • DeploymentsPredictionsCreate
  • datarobot::CreateDeploymentsPredictions
Compute predictions synchronously
POST /deployments/{deploymentId}/predictions/
  • DeploymentsRetrainingPoliciesCreate
  • datarobot::CreateDeploymentsRetrainingPolicies
Endpoint for creating a deployment retraining policy.
POST /deployments/{deploymentId}/retrainingPolicies/
  • DeploymentsRetrainingPoliciesDelete
  • datarobot::DeleteDeploymentsRetrainingPolicies
Endpoint for deleting a deployment retraining policy.
DELETE /deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/
  • DeploymentsRetrainingPoliciesList
  • datarobot::ListDeploymentsRetrainingPolicies
Endpoint for fetching a list of deployment retraining policies.
GET /deployments/{deploymentId}/retrainingPolicies/
  • DeploymentsRetrainingPoliciesPatch
  • datarobot::PatchDeploymentsRetrainingPolicies
Endpoint for updating a deployment retraining policy.
PATCH /deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/
  • DeploymentsRetrainingPoliciesRetrieve
  • datarobot::RetrieveDeploymentsRetrainingPolicies
Endpoint for fetching a deployment retraining policy.
GET /deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/
  • DeploymentsRetrainingPoliciesRunsCreate
  • datarobot::CreateDeploymentsRetrainingPoliciesRuns
Endpoint for initiating a deployment retraining policy run.
POST /deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/
  • DeploymentsRetrainingPoliciesRunsList
  • datarobot::ListDeploymentsRetrainingPoliciesRuns
Endpoint for fetching a list of deployment retraining policy runs.
GET /deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/
  • DeploymentsRetrainingPoliciesRunsPatch
  • datarobot::PatchDeploymentsRetrainingPoliciesRuns
Endpoint for updating a single deployment retraining policy run.
PATCH /deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/
  • DeploymentsRetrainingPoliciesRunsRetrieve
  • datarobot::RetrieveDeploymentsRetrainingPoliciesRuns
Endpoint for fetching a single deployment retraining policy run.
GET /deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/
  • DeploymentsRetrainingSettingsList
  • datarobot::ListDeploymentsRetrainingSettings
Endpoint for fetching deployment retraining settings.
GET /deployments/{deploymentId}/retrainingSettings/
  • DeploymentsRetrainingSettingsPatchMany
  • datarobot::PatchManyDeploymentsRetrainingSettings
Endpoint for updating deployment retraining settings.
PATCH /deployments/{deploymentId}/retrainingSettings/
  • DeploymentsRetrieve
  • datarobot::GetDeployment
Retrieve deployment
GET /deployments/{deploymentId}/
  • DeploymentsScoringCodeBuildsCreate
  • datarobot::CreateDeploymentsScoringCodeBuilds
Build Java package containing Scoring Code with agent integration.
POST /deployments/{deploymentId}/scoringCodeBuilds/
  • DeploymentsScoringCodeList
  • datarobot::ListDeploymentsScoringCode
Retrieve Scoring Code
GET /deployments/{deploymentId}/scoringCode/
  • DeploymentsServiceStatsList
  • datarobot::GetDeploymentServiceStats
Retrieve service statistics
GET /deployments/{deploymentId}/serviceStats/
  • DeploymentsServiceStatsOverTimeList
  • datarobot::ListDeploymentsServiceStatsOverTime
Retrieve service statistics over time
GET /deployments/{deploymentId}/serviceStatsOverTime/
  • DeploymentsSettingsList
  • datarobot::GetDeploymentSettings
Get deployment settings
GET /deployments/{deploymentId}/settings/
  • DeploymentsSettingsPatchMany
  • datarobot::UpdateDeploymentSettings
Update deployment settings
PATCH /deployments/{deploymentId}/settings/
  • DeploymentsSharedRolesList
  • datarobot::ListDeploymentsSharedRoles
Get model deployment's access control list
GET /deployments/{deploymentId}/sharedRoles/
  • DeploymentsSharedRolesPatchMany
  • datarobot::PatchManyDeploymentsSharedRoles
Update model deployment's controls
PATCH /deployments/{deploymentId}/sharedRoles/
  • DeploymentsStatusPatchMany
  • datarobot::PatchManyDeploymentsStatus
Change deployment status
PATCH /deployments/{deploymentId}/status/
  • DeploymentsTargetDriftList
  • datarobot::ListDeploymentsTargetDrift
Retrieve target drift
GET /deployments/{deploymentId}/targetDrift/
  • PredictionServersList
  • datarobot::ListPredictionServers
List prediction servers.
GET /predictionServers/

DocumentationApi

Functions and Description HTTP request
  • AutomatedDocumentOptionsList
  • datarobot::ListAutomatedDocumentOptions
List all available document types and locales.
GET /automatedDocumentOptions/
  • AutomatedDocumentsCreate
  • datarobot::CreateAutomatedDocuments
Request generation of automated document
POST /automatedDocuments/
  • AutomatedDocumentsDelete
  • datarobot::DeleteAutomatedDocuments
Delete automated document.
DELETE /automatedDocuments/{documentId}/
  • AutomatedDocumentsList
  • datarobot::ListAutomatedDocuments
List all generated documents.
GET /automatedDocuments/
  • AutomatedDocumentsRetrieve
  • datarobot::RetrieveAutomatedDocuments
Download generated document.
GET /automatedDocuments/{documentId}/
  • ComplianceDocTemplatesCreate
  • datarobot::UploadComplianceDocTemplate
Create a new compliance documentation template
POST /complianceDocTemplates/
  • ComplianceDocTemplatesDefaultList
  • datarobot::ListComplianceDocTemplatesDefault
Retrieve the default documentation template
GET /complianceDocTemplates/default/
  • ComplianceDocTemplatesDelete
  • datarobot::DeleteComplianceDocTemplate
Delete a compliance documentation template
DELETE /complianceDocTemplates/{templateId}/
  • ComplianceDocTemplatesList
  • datarobot::ListComplianceDocTemplates
List compliance documentation templates
GET /complianceDocTemplates/
  • ComplianceDocTemplatesPatch
  • datarobot::UpdateComplianceDocTemplate
Update an existing model compliance documentation template
PATCH /complianceDocTemplates/{templateId}/
  • ComplianceDocTemplatesRetrieve
  • datarobot::GetComplianceDocTemplate
Retrieve a documentation template
GET /complianceDocTemplates/{templateId}/
  • ComplianceDocTemplatesSharedRolesList
  • datarobot::ListComplianceDocTemplatesSharedRoles
Get template's access control list
GET /complianceDocTemplates/{templateId}/sharedRoles/
  • ComplianceDocTemplatesSharedRolesPatchMany
  • datarobot::PatchManyComplianceDocTemplatesSharedRoles
Update template's access controls
PATCH /complianceDocTemplates/{templateId}/sharedRoles/
  • ModelComplianceDocsInitializationsCreateOne
  • datarobot::CreateOneModelComplianceDocsInitializations
Initialize compliance documentation pre-processing for the model
POST /modelComplianceDocsInitializations/{entityId}/
  • ModelComplianceDocsInitializationsRetrieve
  • datarobot::RetrieveModelComplianceDocsInitializations
Check if compliance documentation pre-processing is initialized for the model
GET /modelComplianceDocsInitializations/{entityId}/

GovernanceApi

Functions and Description HTTP request
  • ApprovalPoliciesCreate
  • datarobot::CreateApprovalPolicies
Create a new Approval Policy.
POST /approvalPolicies/
  • ApprovalPoliciesDelete
  • datarobot::DeleteApprovalPolicies
Delete an Approval Policy.
DELETE /approvalPolicies/{approvalPolicyId}/
  • ApprovalPoliciesList
  • datarobot::ListApprovalPolicies
List Approval Policies.
GET /approvalPolicies/
  • ApprovalPoliciesPut
  • datarobot::PutApprovalPolicies
Update an Approval Policy.
PUT /approvalPolicies/{approvalPolicyId}/
  • ApprovalPoliciesRetrieve
  • datarobot::RetrieveApprovalPolicies
Retrieve an Approval Policy.
GET /approvalPolicies/{approvalPolicyId}/
  • ApprovalPoliciesShareableChangeRequestsList
  • datarobot::ListApprovalPoliciesShareableChangeRequests
Retrieve associated Change Requests Info.
GET /approvalPolicies/{approvalPolicyId}/shareableChangeRequests/
  • ApprovalPolicyMatchList
  • datarobot::ListApprovalPolicyMatch
Get policy ID matching the query
GET /approvalPolicyMatch/
  • ApprovalPolicyTriggersList
  • datarobot::ListApprovalPolicyTriggers
Get a list of available policy triggers.
GET /approvalPolicyTriggers/
  • ChangeRequestsCreate
  • datarobot::CreateChangeRequests
Create Change Request.
POST /changeRequests/
  • ChangeRequestsList
  • datarobot::ListChangeRequests
List Change Requests.
GET /changeRequests/
  • ChangeRequestsPatch
  • datarobot::PatchChangeRequests
Update Change Request.
PATCH /changeRequests/{changeRequestId}/
  • ChangeRequestsRetrieve
  • datarobot::RetrieveChangeRequests
Retrieve Change Request.
GET /changeRequests/{changeRequestId}/
  • ChangeRequestsReviewsCreate
  • datarobot::CreateChangeRequestsReviews
Create review.
POST /changeRequests/{changeRequestId}/reviews/
  • ChangeRequestsReviewsList
  • datarobot::ListChangeRequestsReviews
List Change Request reviews.
GET /changeRequests/{changeRequestId}/reviews/
  • ChangeRequestsReviewsRetrieve
  • datarobot::RetrieveChangeRequestsReviews
Retrieve review.
GET /changeRequests/{changeRequestId}/reviews/{reviewId}/
  • ChangeRequestsStatusPatchMany
  • datarobot::PatchManyChangeRequestsStatus
Resolve or Cancel the Change Request.
PATCH /changeRequests/{changeRequestId}/status/
  • ChangeRequestsSuggestedReviewersList
  • datarobot::ListChangeRequestsSuggestedReviewers
List suggested reviewers.
GET /changeRequests/{changeRequestId}/suggestedReviewers/

ImagesApi

Functions and Description HTTP request
  • DatasetsImagesDataQualityLogFileList
  • datarobot::ListDatasetsImagesDataQualityLogFile
Retrieve a text file containing the images data quality log.
GET /datasets/{datasetId}/imagesDataQualityLog/file/
  • DatasetsImagesDataQualityLogList
  • datarobot::ListDatasetsImagesDataQualityLog
Retrieve the images data quality log content and log length as JSON
GET /datasets/{datasetId}/imagesDataQualityLog/
  • ImageAugmentationListsCreate
  • datarobot::CreateImageAugmentationLists
Creates a new augmentation list based on the posted payload data.
POST /imageAugmentationLists/
  • ImageAugmentationListsDelete
  • datarobot::DeleteImageAugmentationLists
Delete an existing augmentation lists by id
DELETE /imageAugmentationLists/{augmentationId}/
  • ImageAugmentationListsList
  • datarobot::ListImageAugmentationLists
List of augmentation lists that match the specified query.
GET /imageAugmentationLists/
  • ImageAugmentationListsPatch
  • datarobot::PatchImageAugmentationLists
Update and existing augmentation list, with passed in values.
PATCH /imageAugmentationLists/{augmentationId}/
  • ImageAugmentationListsRetrieve
  • datarobot::RetrieveImageAugmentationLists
Returns a single augmentation list with the specified id.
GET /imageAugmentationLists/{augmentationId}/
  • ImageAugmentationListsSamplesCreate
  • datarobot::CreateImageAugmentationListsSamples
Requests the creation of sample augmentations based on the augmentation list passed in.
POST /imageAugmentationLists/{augmentationId}/samples/
  • ImageAugmentationListsSamplesList
  • datarobot::ListImageAugmentationListsSamples
Retrieve latest Augmentation Samples generated for list
GET /imageAugmentationLists/{augmentationId}/samples/
  • ImageAugmentationOptionsRetrieve
  • datarobot::RetrieveImageAugmentationOptions
Augmentation list of all available transformations that are supported in the system.
GET /imageAugmentationOptions/{projectId}/
  • ImageAugmentationSamplesCreate
  • datarobot::CreateImageAugmentationSamples
(Deprecated in v2.28) Requests the creation of sample augmentations based on the augmentation list parameters passed in. This route is being deprecated please use POST /imageAugmentationLists/<augmentationId>/samples route instead.
POST /imageAugmentationSamples/
  • ImageAugmentationSamplesList
  • datarobot::ListImageAugmentationSamples
(Deprecated in v2.28) Retrieve previously generated Augmentation Samples. This route is being deprecated please use GET /imageAugmentationLists/<augmentationId>/samples route instead.
GET /imageAugmentationSamples/{samplesId}/
  • ProjectsDuplicateImagesList
  • datarobot::ListProjectsDuplicateImages
Get a list of duplicate images containing the number of occurrences of each image
GET /projects/{projectId}/duplicateImages/{column}/
  • ProjectsImageActivationMapsList
  • datarobot::ListProjectsImageActivationMaps
List all Image Activation Maps for the project.
GET /projects/{projectId}/imageActivationMaps/
  • ProjectsImageBinsList
  • datarobot::ListProjectsImageBins
List image bins and covers for every target value or range.
GET /projects/{projectId}/imageBins/
  • ProjectsImageEmbeddingsList
  • datarobot::ListProjectsImageEmbeddings
List all Image Embeddings for the project.
GET /projects/{projectId}/imageEmbeddings/
  • ProjectsImageSamplesList
  • datarobot::ListProjectsImageSamples
List all metadata for images in the EDA sample
GET /projects/{projectId}/imageSamples/
  • ProjectsImagesDataQualityLogFileList
  • datarobot::ListProjectsImagesDataQualityLogFile
Retrieve a text file containing the images data quality log
GET /projects/{projectId}/imagesDataQualityLog/file/
  • ProjectsImagesDataQualityLogList
  • datarobot::ListProjectsImagesDataQualityLog
Retrieve the images data quality log content and log length as JSON
GET /projects/{projectId}/imagesDataQualityLog/
  • ProjectsImagesFileList
  • datarobot::ListProjectsImagesFile
Returns a file for a single image
GET /projects/{projectId}/images/{imageId}/file/
  • ProjectsImagesList
  • datarobot::ListProjectsImages
Returns a list of image metadata elements.
GET /projects/{projectId}/images/
  • ProjectsImagesRetrieve
  • datarobot::RetrieveProjectsImages
Returns a single image metadata.
GET /projects/{projectId}/images/{imageId}/
  • ProjectsModelsImageActivationMapsCreate
  • datarobot::CreateProjectsModelsImageActivationMaps
Request the computation of image activation maps for the specified model.
POST /projects/{projectId}/models/{modelId}/imageActivationMaps/
  • ProjectsModelsImageActivationMapsList
  • datarobot::ListProjectsModelsImageActivationMaps
Retrieve Image Activation Maps for a feature of a model.
GET /projects/{projectId}/models/{modelId}/imageActivationMaps/
  • ProjectsModelsImageEmbeddingsCreate
  • datarobot::CreateProjectsModelsImageEmbeddings
Request the computation of image embeddings for the specified model.
POST /projects/{projectId}/models/{modelId}/imageEmbeddings/
  • ProjectsModelsImageEmbeddingsList
  • datarobot::ListProjectsModelsImageEmbeddings
Retrieve ImageEmbeddings for a feature of a model.
GET /projects/{projectId}/models/{modelId}/imageEmbeddings/

InfrastructureApi

Functions and Description HTTP request
  • ClusterLicenseList
  • datarobot::ListClusterLicense
Retrieve the information about cluster license
GET /clusterLicense/
  • ClusterLicensePutMany
  • datarobot::PutManyClusterLicense
Create or replace license
PUT /clusterLicense/
  • ClusterLicenseValidationCreate
  • datarobot::CreateClusterLicenseValidation
Check if a license is valid
POST /clusterLicenseValidation/
  • VersionList
  • datarobot::GetServerVersion
Retrieve version information.
GET /version/

InsightsApi

Functions and Description HTTP request
  • MultilabelInsightsHistogramList
  • datarobot::ListMultilabelInsightsHistogram
Retrieve multicategorical feature histogram.
GET /multilabelInsights/{multilabelInsightsKey}/histogram/
  • MultilabelInsightsPairwiseManualSelectionsCreate
  • datarobot::CreateMultilabelInsightsPairwiseManualSelections
Save a list of manually selected labels for Feature Statistics matrix.
POST /multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/
  • MultilabelInsightsPairwiseManualSelectionsDelete
  • datarobot::DeleteMultilabelInsightsPairwiseManualSelections
Delete label list.
DELETE /multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/
  • MultilabelInsightsPairwiseManualSelectionsList
  • datarobot::ListMultilabelInsightsPairwiseManualSelections
Get all label lists.
GET /multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/
  • MultilabelInsightsPairwiseManualSelectionsPatch
  • datarobot::PatchMultilabelInsightsPairwiseManualSelections
Update label list's name.
PATCH /multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/
  • MultilabelInsightsPairwiseStatisticsList
  • datarobot::ListMultilabelInsightsPairwiseStatistics
Retrieve pairwise statistics for the given multilabel insights key.
GET /multilabelInsights/{multilabelInsightsKey}/pairwiseStatistics/
  • ProjectsAnomalyAssessmentRecordsDelete
  • datarobot::DeleteAnomalyAssessmentRecord
Delete the anomaly assessment record.
DELETE /projects/{projectId}/anomalyAssessmentRecords/{recordId}/
  • ProjectsAnomalyAssessmentRecordsExplanationsList
  • datarobot::GetAnomalyAssessmentExplanations
Retrieve anomaly assessment record.
GET /projects/{projectId}/anomalyAssessmentRecords/{recordId}/explanations/
  • ProjectsAnomalyAssessmentRecordsList
  • datarobot::ListAnomalyAssessmentRecords
Retrieve anomaly assessment records.
GET /projects/{projectId}/anomalyAssessmentRecords/
  • ProjectsAnomalyAssessmentRecordsPredictionsPreviewList
  • datarobot::GetAnomalyAssessmentPredictionsPreview
Retrieve predictions preview for the anomaly assessment record.
GET /projects/{projectId}/anomalyAssessmentRecords/{recordId}/predictionsPreview/
  • ProjectsBiasVsAccuracyInsightsList
  • datarobot::ListProjectsBiasVsAccuracyInsights
List Bias vs Accuracy insights.
GET /projects/{projectId}/biasVsAccuracyInsights/
  • ProjectsDatetimeModelsAccuracyOverTimePlotsList
  • datarobot::GetAccuracyOverTimePlot
Retrieve the data for the Accuracy over Time plots.
GET /projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/
  • ProjectsDatetimeModelsAccuracyOverTimePlotsMetadataList
  • datarobot::GetAccuracyOverTimePlotsMetadata
Retrieve the metadata for the Accuracy over Time plots.
GET /projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/metadata/
  • ProjectsDatetimeModelsAccuracyOverTimePlotsPreviewList
  • datarobot::GetAccuracyOverTimePlotPreview
Retrieve the preview for the Accuracy over Time plots.
GET /projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/preview/
  • ProjectsDatetimeModelsAnomalyOverTimePlotsList
  • datarobot::GetAnomalyOverTimePlot
Retrieve the data for the Anomaly over Time plots.
GET /projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/
  • ProjectsDatetimeModelsAnomalyOverTimePlotsMetadataList
  • datarobot::GetAnomalyOverTimePlotsMetadata
Retrieve the metadata for the Anomaly over Time plots.
GET /projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/metadata/
  • ProjectsDatetimeModelsAnomalyOverTimePlotsPreviewList
  • datarobot::GetAnomalyOverTimePlotPreview
Retrieve the preview for the Anomaly over Time plots.
GET /projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/preview/
  • ProjectsDatetimeModelsBacktestStabilityPlotList
  • datarobot::ListProjectsDatetimeModelsBacktestStabilityPlot
Retrieve a plot displaying the stability of the datetime model across different backtests.
GET /projects/{projectId}/datetimeModels/{modelId}/backtestStabilityPlot/
  • ProjectsDatetimeModelsDatasetAccuracyOverTimePlotsMetadataList
  • datarobot::ListProjectsDatetimeModelsDatasetAccuracyOverTimePlotsMetadata
Retrieve the metadata of the Accuracy Over Time (AOT) chart for an external dataset.
GET /projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/metadata/
  • ProjectsDatetimeModelsDatasetAccuracyOverTimePlotsPreviewList
  • datarobot::ListProjectsDatetimeModelsDatasetAccuracyOverTimePlotsPreview
Retrieve a preview of the Accuracy Over Time (AOT) chart for an external dataset.
GET /projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/preview/
  • ProjectsDatetimeModelsDatasetAccuracyOverTimePlotsRetrieve
  • datarobot::RetrieveProjectsDatetimeModelsDatasetAccuracyOverTimePlots
Retrieve the Accuracy Over Time (AOT) chart data for an external dataset for a project.
GET /projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/
  • ProjectsDatetimeModelsDatetimeTrendPlotsCreate
  • datarobot::ComputeDatetimeTrendPlots
Computes Datetime Trend plots for time series and OTV projects.
POST /projects/{projectId}/datetimeModels/{modelId}/datetimeTrendPlots/
  • ProjectsDatetimeModelsFeatureEffectsCreate
  • datarobot::CreateProjectsDatetimeModelsFeatureEffects
Add a request to the queue to calculate Feature Effects for a backtest.
POST /projects/{projectId}/datetimeModels/{modelId}/featureEffects/
  • ProjectsDatetimeModelsFeatureEffectsList
  • datarobot::ListProjectsDatetimeModelsFeatureEffects
Retrieve Feature Effects for a model backtest.
GET /projects/{projectId}/datetimeModels/{modelId}/featureEffects/
  • ProjectsDatetimeModelsFeatureEffectsMetadataList
  • datarobot::ListProjectsDatetimeModelsFeatureEffectsMetadata
Retrieve Feature Effects metadata for each backtest. Response contains status and available sources for each backtest of the model.
GET /projects/{projectId}/datetimeModels/{modelId}/featureEffectsMetadata/
  • ProjectsDatetimeModelsFeatureFitCreate
  • datarobot::CreateProjectsDatetimeModelsFeatureFit
Add a request to the queue to calculate Feature Fit for a backtest.
POST /projects/{projectId}/datetimeModels/{modelId}/featureFit/
  • ProjectsDatetimeModelsFeatureFitList
  • datarobot::ListProjectsDatetimeModelsFeatureFit
Retrieve Feature Fit for a model backtest.
GET /projects/{projectId}/datetimeModels/{modelId}/featureFit/
  • ProjectsDatetimeModelsFeatureFitMetadataList
  • datarobot::ListProjectsDatetimeModelsFeatureFitMetadata
Retrieve Feature Fit metadata for each backtest. Response contains status and available sources for each backtest of the model.
GET /projects/{projectId}/datetimeModels/{modelId}/featureFitMetadata/
  • ProjectsDatetimeModelsForecastDistanceStabilityPlotList
  • datarobot::ListProjectsDatetimeModelsForecastDistanceStabilityPlot
Retrieve a plot displaying the stability of the time series model across different forecast distances.
GET /projects/{projectId}/datetimeModels/{modelId}/forecastDistanceStabilityPlot/
  • ProjectsDatetimeModelsForecastVsActualPlotsList
  • datarobot::GetForecastVsActualPlot
Retrieve the data for the Forecast vs Actual plots.
GET /projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/
  • ProjectsDatetimeModelsForecastVsActualPlotsMetadataList
  • datarobot::GetForecastVsActualPlotsMetadata
Retrieve the metadata for the Forecast vs Actual plots.
GET /projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/metadata/
  • ProjectsDatetimeModelsForecastVsActualPlotsPreviewList
  • datarobot::GetForecastVsActualPlotPreview
Retrieve the preview for the Forecast vs Actual plots.
GET /projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/preview/
  • ProjectsDatetimeModelsMulticlassFeatureEffectsCreate
  • datarobot::CreateProjectsDatetimeModelsMulticlassFeatureEffects
Compute feature effects for a multiclass datetime model.
POST /projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/
  • ProjectsDatetimeModelsMulticlassFeatureEffectsList
  • datarobot::ListProjectsDatetimeModelsMulticlassFeatureEffects
Retrieve feature effects for each class in a multiclass datetime model.
GET /projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/
  • ProjectsDatetimeModelsMultiseriesHistogramsList
  • datarobot::ListProjectsDatetimeModelsMultiseriesHistograms
Retrieve the histograms for series insights.
GET /projects/{projectId}/datetimeModels/{modelId}/multiseriesHistograms/
  • ProjectsDatetimeModelsMultiseriesScoresCreate
  • datarobot::RequestSeriesAccuracy
Request the computation of per-series scores for a multiseries model.
POST /projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/
  • ProjectsDatetimeModelsMultiseriesScoresFileList
  • datarobot::ListProjectsDatetimeModelsMultiseriesScoresFile
Retrieve the CSV file for the series accuracy.
GET /projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/file/
  • ProjectsDatetimeModelsMultiseriesScoresList
  • datarobot::GetSeriesAccuracyForModel
List the scores per individual series for the specified multiseries model.
GET /projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/
  • ProjectsExternalScoresCreate
  • datarobot::CreateProjectsExternalScores
Compute model scores for external dataset.
POST /projects/{projectId}/externalScores/
  • ProjectsExternalScoresList
  • datarobot::ListProjectsExternalScores
List of scores on prediction datasets for a project.
GET /projects/{projectId}/externalScores/
  • ProjectsFeatureAssociationFeaturelistsList
  • datarobot::ListProjectsFeatureAssociationFeaturelists
List all featurelists with feature association matrix availability flags for a project.
GET /projects/{projectId}/featureAssociationFeaturelists/
  • ProjectsFeatureAssociationMatrixCreate
  • datarobot::CreateProjectsFeatureAssociationMatrix
Compute feature association matrix.
POST /projects/{projectId}/featureAssociationMatrix/
  • ProjectsFeatureAssociationMatrixDetailsList
  • datarobot::GetFeatureAssociationMatrixDetails
Retrieval for feature association plotting between a pair of features.
GET /projects/{projectId}/featureAssociationMatrixDetails/
  • ProjectsFeatureAssociationMatrixList
  • datarobot::GetFeatureAssociationMatrix
Retrieval for pairwise feature association statistics.
GET /projects/{projectId}/featureAssociationMatrix/
  • ProjectsFeaturesFrequentValuesList
  • datarobot::ListProjectsFeaturesFrequentValues
Retrieve the frequent values information for a particular feature.
GET /projects/{projectId}/features/{featureName}/frequentValues/
  • ProjectsGeometryFeaturePlotsCreate
  • datarobot::CreateProjectsGeometryFeaturePlots
Create a map of one location feature
POST /projects/{projectId}/geometryFeaturePlots/
  • ProjectsGeometryFeaturePlotsRetrieve
  • datarobot::RetrieveProjectsGeometryFeaturePlots
Retrieve a map of one location feature
GET /projects/{projectId}/geometryFeaturePlots/{featureName}/
  • ProjectsImageActivationMapsList
  • datarobot::ListProjectsImageActivationMaps
List all Image Activation Maps for the project.
GET /projects/{projectId}/imageActivationMaps/
  • ProjectsImageEmbeddingsList
  • datarobot::ListProjectsImageEmbeddings
List all Image Embeddings for the project.
GET /projects/{projectId}/imageEmbeddings/
  • ProjectsModelsAnomalyAssessmentInitializationCreate
  • datarobot::InitializeAnomalyAssessment
Calculate the anomaly assessment insight.
POST /projects/{projectId}/models/{modelId}/anomalyAssessmentInitialization/
  • ProjectsModelsAnomalyInsightsFileList
  • datarobot::ListProjectsModelsAnomalyInsightsFile
Retrieve a CSV file of the raw data displayed with the anomaly score from the model.
GET /projects/{projectId}/models/{modelId}/anomalyInsightsFile/
  • ProjectsModelsAnomalyInsightsTableList
  • datarobot::ListProjectsModelsAnomalyInsightsTable
Retrieve a table of the raw data displayed with the anomaly score from the specific model.
GET /projects/{projectId}/models/{modelId}/anomalyInsightsTable/
  • ProjectsModelsClusterInsightsCreate
  • datarobot::CreateProjectsModelsClusterInsights
Compute Cluster Insights.
POST /projects/{projectId}/models/{modelId}/clusterInsights/
  • ProjectsModelsClusterInsightsDownloadList
  • datarobot::ListProjectsModelsClusterInsightsDownload
Download Cluster Insights result.
GET /projects/{projectId}/models/{modelId}/clusterInsights/download/
  • ProjectsModelsClusterInsightsList
  • datarobot::ListProjectsModelsClusterInsights
Retrieve Cluster Insights for all features.
GET /projects/{projectId}/models/{modelId}/clusterInsights/
  • ProjectsModelsConfusionChartsClassDetailsList
  • datarobot::ListProjectsModelsConfusionChartsClassDetails
Calculates and sends frequency of class in distributed among other classes for actual and predicted data.
GET /projects/{projectId}/models/{modelId}/confusionCharts/{source}/classDetails/
  • ProjectsModelsConfusionChartsList
  • datarobot::ListProjectsModelsConfusionCharts
Retrieve all available confusion charts for model.
GET /projects/{projectId}/models/{modelId}/confusionCharts/
  • ProjectsModelsConfusionChartsMetadataList
  • datarobot::ListProjectsModelsConfusionChartsMetadata
Retrieve metadata for the confusion chart of a model.
GET /projects/{projectId}/models/{modelId}/confusionCharts/{source}/metadata/
  • ProjectsModelsConfusionChartsRetrieve
  • datarobot::GetConfusionChart
Retrieve the confusion chart data from a single source.
GET /projects/{projectId}/models/{modelId}/confusionCharts/{source}/
  • ProjectsModelsCrossClassAccuracyScoresCreate
  • datarobot::CreateProjectsModelsCrossClassAccuracyScores
Start Cross Class Accuracy calculations.
POST /projects/{projectId}/models/{modelId}/crossClassAccuracyScores/
  • ProjectsModelsCrossClassAccuracyScoresList
  • datarobot::ListProjectsModelsCrossClassAccuracyScores
List Cross Class Accuracy scores.
GET /projects/{projectId}/models/{modelId}/crossClassAccuracyScores/
  • ProjectsModelsDataDisparityInsightsCreate
  • datarobot::CreateProjectsModelsDataDisparityInsights
Start insight calculations.
POST /projects/{projectId}/models/{modelId}/dataDisparityInsights/
  • ProjectsModelsDataDisparityInsightsList
  • datarobot::ListProjectsModelsDataDisparityInsights
Get Cross Class Data Disparity results.
GET /projects/{projectId}/models/{modelId}/dataDisparityInsights/
  • ProjectsModelsDatasetConfusionChartsClassDetailsList
  • datarobot::ListProjectsModelsDatasetConfusionChartsClassDetails
Calculate and sends frequency of class in distributed among other classes for actual and predicted data.
GET /projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/classDetails/
  • ProjectsModelsDatasetConfusionChartsList
  • datarobot::ListProjectsModelsDatasetConfusionCharts
List of Confusion Charts objects on external datasets for a project with filtering option by dataset.
GET /projects/{projectId}/models/{modelId}/datasetConfusionCharts/
  • ProjectsModelsDatasetConfusionChartsMetadataList
  • datarobot::ListProjectsModelsDatasetConfusionChartsMetadata
Retrieve metadata for the confusion chart of a model on external dataset for a project.
GET /projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/metadata/
  • ProjectsModelsDatasetConfusionChartsRetrieve
  • datarobot::RetrieveProjectsModelsDatasetConfusionCharts
Retrieve Confusion Chart objects on external datasets for a project.
GET /projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/
  • ProjectsModelsDatasetLiftChartsList
  • datarobot::ListProjectsModelsDatasetLiftCharts
Retrieve List of Lift chart data on prediction datasets for a project.
GET /projects/{projectId}/models/{modelId}/datasetLiftCharts/
  • ProjectsModelsDatasetMulticlassLiftChartsList
  • datarobot::ListProjectsModelsDatasetMulticlassLiftCharts
Retrieve List of Multiclass Lift chart data on prediction datasets for a project.
GET /projects/{projectId}/models/{modelId}/datasetMulticlassLiftCharts/
  • ProjectsModelsDatasetResidualsChartsList
  • datarobot::ListProjectsModelsDatasetResidualsCharts
List of residuals charts objects on prediction datasets.
GET /projects/{projectId}/models/{modelId}/datasetResidualsCharts/
  • ProjectsModelsDatasetRocCurvesList
  • datarobot::ListProjectsModelsDatasetRocCurves
List of ROC curve objects on prediction datasets for a project with filtering option by dataset.
GET /projects/{projectId}/models/{modelId}/datasetRocCurves/
  • ProjectsModelsFairnessInsightsCreate
  • datarobot::CreateProjectsModelsFairnessInsights
Start insight calculations.
POST /projects/{projectId}/models/{modelId}/fairnessInsights/
  • ProjectsModelsFairnessInsightsList
  • datarobot::ListProjectsModelsFairnessInsights
List calculated Per Class Bias insights.
GET /projects/{projectId}/models/{modelId}/fairnessInsights/
  • ProjectsModelsFeatureEffectsCreate
  • datarobot::CreateProjectsModelsFeatureEffects
Add a request to the queue to calculate Feature Effects.
POST /projects/{projectId}/models/{modelId}/featureEffects/
  • ProjectsModelsFeatureEffectsList
  • datarobot::ListProjectsModelsFeatureEffects
Retrieve Feature Effects for the model.
GET /projects/{projectId}/models/{modelId}/featureEffects/
  • ProjectsModelsFeatureEffectsMetadataList
  • datarobot::ListProjectsModelsFeatureEffectsMetadata
Retrieve Feature Effects metadata. Response contains status and available sources.
GET /projects/{projectId}/models/{modelId}/featureEffectsMetadata/
  • ProjectsModelsFeatureFitCreate
  • datarobot::CreateProjectsModelsFeatureFit
Add a request to the queue to calculate Feature Fit.
POST /projects/{projectId}/models/{modelId}/featureFit/
  • ProjectsModelsFeatureFitList
  • datarobot::ListProjectsModelsFeatureFit
Retrieve Feature Fit for the model.
GET /projects/{projectId}/models/{modelId}/featureFit/
  • ProjectsModelsFeatureFitMetadataList
  • datarobot::ListProjectsModelsFeatureFitMetadata
Retrieve Feature Fit metadata. Response contains status and available sources.
GET /projects/{projectId}/models/{modelId}/featureFitMetadata/
  • ProjectsModelsFeatureImpactCreate
  • datarobot::RequestFeatureImpact
Add a request to calculate feature impact to the queue.
POST /projects/{projectId}/models/{modelId}/featureImpact/
  • ProjectsModelsFeatureImpactList
  • datarobot::GetFeatureImpactForModel
Retrieve feature impact scores for features in a model.
GET /projects/{projectId}/models/{modelId}/featureImpact/
  • ProjectsModelsFeatureListsClusterInsightsList
  • datarobot::ListProjectsModelsFeatureListsClusterInsights
Retrieve Cluster Insights for a single featurelist
GET /projects/{projectId}/models/{modelId}/featureLists/{datasetId}/clusterInsights/
  • ProjectsModelsImageActivationMapsCreate
  • datarobot::CreateProjectsModelsImageActivationMaps
Request the computation of image activation maps for the specified model.
POST /projects/{projectId}/models/{modelId}/imageActivationMaps/
  • ProjectsModelsImageActivationMapsList
  • datarobot::ListProjectsModelsImageActivationMaps
Retrieve Image Activation Maps for a feature of a model.
GET /projects/{projectId}/models/{modelId}/imageActivationMaps/
  • ProjectsModelsImageEmbeddingsCreate
  • datarobot::CreateProjectsModelsImageEmbeddings
Request the computation of image embeddings for the specified model.
POST /projects/{projectId}/models/{modelId}/imageEmbeddings/
  • ProjectsModelsImageEmbeddingsList
  • datarobot::ListProjectsModelsImageEmbeddings
Retrieve ImageEmbeddings for a feature of a model.
GET /projects/{projectId}/models/{modelId}/imageEmbeddings/
  • ProjectsModelsLabelwiseRocCurvesList
  • datarobot::ListProjectsModelsLabelwiseRocCurves
Retrieve labelwise ROC curves for model and given source.
GET /projects/{projectId}/models/{modelId}/labelwiseRocCurves/{source}/
  • ProjectsModelsLiftChartList
  • datarobot::ListProjectsModelsLiftChart
Retrieve all available lift charts for model.
GET /projects/{projectId}/models/{modelId}/liftChart/
  • ProjectsModelsLiftChartRetrieve
  • datarobot::RetrieveProjectsModelsLiftChart
Retrieve the lift chart data from a single source.
GET /projects/{projectId}/models/{modelId}/liftChart/{source}/
  • ProjectsModelsMulticlassFeatureEffectsCreate
  • datarobot::CreateProjectsModelsMulticlassFeatureEffects
Compute feature effects for a multiclass model.
POST /projects/{projectId}/models/{modelId}/multiclassFeatureEffects/
  • ProjectsModelsMulticlassFeatureEffectsList
  • datarobot::ListProjectsModelsMulticlassFeatureEffects
Retrieve feature effects for each class in a multiclass model.
GET /projects/{projectId}/models/{modelId}/multiclassFeatureEffects/
  • ProjectsModelsMulticlassFeatureImpactList
  • datarobot::ListProjectsModelsMulticlassFeatureImpact
Retrieve feature impact scores for each class in a multiclass model.
GET /projects/{projectId}/models/{modelId}/multiclassFeatureImpact/
  • ProjectsModelsMulticlassLiftChartList
  • datarobot::ListProjectsModelsMulticlassLiftChart
Retrieve all available lift charts for multiclass model.
GET /projects/{projectId}/models/{modelId}/multiclassLiftChart/
  • ProjectsModelsMulticlassLiftChartRetrieve
  • datarobot::RetrieveProjectsModelsMulticlassLiftChart
Retrieve the multiclass lift chart data from a single source.
GET /projects/{projectId}/models/{modelId}/multiclassLiftChart/{source}/
  • ProjectsModelsMultilabelLiftChartsRetrieve
  • datarobot::RetrieveProjectsModelsMultilabelLiftCharts
Retrieve labelwise lift charts for model and given source.
GET /projects/{projectId}/models/{modelId}/multilabelLiftCharts/{source}/
  • ProjectsModelsPredictionExplanationsInitializationCreate
  • datarobot::RequestPredictionExplanationsInitialization
Create a new prediction explanations initialization.
POST /projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
  • ProjectsModelsPredictionExplanationsInitializationDeleteMany
  • datarobot::DeletePredictionExplanationsInitialization
Delete an existing PredictionExplanationsInitialization.
DELETE /projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
  • ProjectsModelsPredictionExplanationsInitializationList
  • datarobot::GetPredictionExplanationsInitialization
Retrieve the current PredictionExplanationsInitialization.
GET /projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
  • ProjectsModelsResidualsList
  • datarobot::ListProjectsModelsResiduals
Retrieve all residuals charts for a model.
GET /projects/{projectId}/models/{modelId}/residuals/
  • ProjectsModelsResidualsRetrieve
  • datarobot::RetrieveProjectsModelsResiduals
Retrieve the residuals chart data from a single source.
GET /projects/{projectId}/models/{modelId}/residuals/{source}/
  • ProjectsModelsRocCurveList
  • datarobot::ListProjectsModelsRocCurve
Retrieve all available ROC curves for model.
GET /projects/{projectId}/models/{modelId}/rocCurve/
  • ProjectsModelsRocCurveRetrieve
  • datarobot::RetrieveProjectsModelsRocCurve
Retrieve the ROC curve data from a single source.
GET /projects/{projectId}/models/{modelId}/rocCurve/{source}/
  • ProjectsModelsShapImpactCreate
  • datarobot::CreateProjectsModelsShapImpact
Create a Shap based Feature Impact.
POST /projects/{projectId}/models/{modelId}/shapImpact/
  • ProjectsModelsShapImpactList
  • datarobot::ListProjectsModelsShapImpact
Retrieve Feature Impact for a model.
GET /projects/{projectId}/models/{modelId}/shapImpact/
  • ProjectsModelsWordCloudList
  • datarobot::GetWordCloud
Retrieve word cloud data for a model.
GET /projects/{projectId}/models/{modelId}/wordCloud/
  • ProjectsMulticategoricalInvalidFormatFileList
  • datarobot::ListProjectsMulticategoricalInvalidFormatFile
Get file with format errors of potential multicategorical features.
GET /projects/{projectId}/multicategoricalInvalidFormat/file/
  • ProjectsMulticategoricalInvalidFormatList
  • datarobot::ListProjectsMulticategoricalInvalidFormat
Retrieve multicategorical data quality log.
GET /projects/{projectId}/multicategoricalInvalidFormat/
  • ProjectsPayoffMatricesCreate
  • datarobot::CreateProjectsPayoffMatrices
Create a payoff matrix.
POST /projects/{projectId}/payoffMatrices/
  • ProjectsPayoffMatricesDelete
  • datarobot::DeleteProjectsPayoffMatrices
Delete a payoff matrix in a project.
DELETE /projects/{projectId}/payoffMatrices/{payoffMatrixId}/
  • ProjectsPayoffMatricesList
  • datarobot::ListProjectsPayoffMatrices
List of all payoff matrices for a project.
GET /projects/{projectId}/payoffMatrices/
  • ProjectsPayoffMatricesPut
  • datarobot::PutProjectsPayoffMatrices
Update a payoff matrix.
PUT /projects/{projectId}/payoffMatrices/{payoffMatrixId}/
  • ProjectsPredictionExplanationsCreate
  • datarobot::RequestPredictionExplanations
Create a new PredictionExplanations object (and its accompanying PredictionExplanationsRecord).
POST /projects/{projectId}/predictionExplanations/
  • ProjectsPredictionExplanationsList
  • datarobot::GetPredictionExplanationsPage
Retrieve stored Prediction Explanations.
GET /projects/{projectId}/predictionExplanations/{predictionExplanationsId}/
  • ProjectsPredictionExplanationsRecordsDelete
  • datarobot::DeletePredictionExplanations
Delete saved Prediction Explanations.
DELETE /projects/{projectId}/predictionExplanationsRecords/{predictionExplanationsId}/
  • ProjectsPredictionExplanationsRecordsList
  • datarobot::ListPredictionExplanationsMetadata
List PredictionExplanationsRecord objects for a project.
GET /projects/{projectId}/predictionExplanationsRecords/
  • ProjectsPredictionExplanationsRecordsRetrieve
  • datarobot::GetPredictionExplanationsMetadata
Retrieve a PredictionExplanationsRecord object.
GET /projects/{projectId}/predictionExplanationsRecords/{predictionExplanationsId}/
  • ProjectsShapMatricesCreate
  • datarobot::CreateProjectsShapMatrices
Calculate a matrix with SHAP based prediction explanations scores.
POST /projects/{projectId}/shapMatrices/
  • ProjectsShapMatricesList
  • datarobot::ListProjectsShapMatrices
List SHAP matrix records.
GET /projects/{projectId}/shapMatrices/
  • ProjectsShapMatricesRetrieve
  • datarobot::RetrieveProjectsShapMatrices
Get matrix with SHAP prediction explanations scores.
GET /projects/{projectId}/shapMatrices/{shapMatrixId}/

JobsApi

Functions and Description HTTP request
  • StatusDelete
  • datarobot::DeleteStatus
Delete a task
DELETE /status/{statusId}/
  • StatusList
  • datarobot::ListStatus
List tasks
GET /status/
  • StatusRetrieve
  • datarobot::RetrieveStatus
Get task status
GET /status/{statusId}/

MlopsApi

Functions and Description HTTP request
  • MlopsPortablePredictionServerImageList
  • datarobot::ListMlopsPortablePredictionServerImage
Downloads the latest Portable Prediction Server (PPS) Docker image
GET /mlops/portablePredictionServerImage/
  • MlopsPortablePredictionServerImageMetadataList
  • datarobot::ListMlopsPortablePredictionServerImageMetadata
Fetches currently active PPS Docker image metadata
GET /mlops/portablePredictionServerImage/metadata/

ModelsApi

Functions and Description HTTP request
  • CustomInferenceImagesFeatureImpactCreate
  • datarobot::CreateCustomInferenceImagesFeatureImpact
Create custom model feature impact.
POST /customInferenceImages/{imageId}/featureImpact/
  • CustomInferenceImagesFeatureImpactList
  • datarobot::ListCustomInferenceImagesFeatureImpact
Get custom model feature impact.
GET /customInferenceImages/{imageId}/featureImpact/
  • CustomModelDeploymentsList
  • datarobot::ListCustomModelDeployments
List custom model deployments.
GET /customModelDeployments/
  • CustomModelLimitsList
  • datarobot::ListCustomModelLimits
Get custom model resource limits.
GET /customModelLimits/
  • CustomModelTestsCreate
  • datarobot::CreateCustomModelTests
Create custom model test.
POST /customModelTests/
  • CustomModelTestsDelete
  • datarobot::DeleteCustomModelTests
Cancel custom model test.
DELETE /customModelTests/{customModelTestId}/
  • CustomModelTestsList
  • datarobot::ListCustomModelTests
List custom model tests.
GET /customModelTests/
  • CustomModelTestsLogList
  • datarobot::ListCustomModelTestsLog
Get custom model test log.
GET /customModelTests/{customModelTestId}/log/
  • CustomModelTestsRetrieve
  • datarobot::RetrieveCustomModelTests
Get custom model test.
GET /customModelTests/{customModelTestId}/
  • CustomModelTestsTailList
  • datarobot::ListCustomModelTestsTail
Get custom model test log tail.
GET /customModelTests/{customModelTestId}/tail/
  • CustomModelsAccessControlList
  • datarobot::ListCustomModelsAccessControl
Get a list of users who have access to this custom model and their roles on it.
GET /customModels/{customModelId}/accessControl/
  • CustomModelsAccessControlPatchMany
  • datarobot::PatchManyCustomModelsAccessControl
Grant access or update roles for users on this custom model and appropriate learning data.
PATCH /customModels/{customModelId}/accessControl/
  • CustomModelsCreate
  • datarobot::CreateCustomModels
Create custom model.
POST /customModels/
  • CustomModelsDelete
  • datarobot::DeleteCustomModels
Delete custom model.
DELETE /customModels/{customModelId}/
  • CustomModelsDownloadList
  • datarobot::ListCustomModelsDownload
Download the latest custom model version content.
GET /customModels/{customModelId}/download/
  • CustomModelsFromCustomModelCreate
  • datarobot::CreateCustomModelsFromCustomModel
Clone custom model.
POST /customModels/fromCustomModel/
  • CustomModelsList
  • datarobot::ListCustomModels
List custom models.
GET /customModels/
  • CustomModelsPatch
  • datarobot::PatchCustomModels
Update custom model.
PATCH /customModels/{customModelId}/
  • CustomModelsPredictionExplanationsInitializationCreate
  • datarobot::CreateCustomModelsPredictionExplanationsInitialization
Create a new prediction explanations initialization for custom model.
POST /customModels/predictionExplanationsInitialization/
  • CustomModelsRetrieve
  • datarobot::RetrieveCustomModels
Get custom model.
GET /customModels/{customModelId}/
  • CustomModelsTrainingDataPatchMany
  • datarobot::PatchManyCustomModelsTrainingData
Assign training data to custom model.
PATCH /customModels/{customModelId}/trainingData/
  • CustomModelsVersionCreateFromLatest
  • datarobot::CreateFromLatestCustomModelsVersion
Update custom model version files.
PATCH /customModels/{customModelId}/versions/
  • CustomModelsVersionsConversionsCreate
  • datarobot::CreateCustomModelsVersionsConversions
Generates JAR file from particular files.
POST /customModels/{customModelId}/versions/{customModelVersionId}/conversions/
  • CustomModelsVersionsConversionsDelete
  • datarobot::DeleteCustomModelsVersionsConversions
Stop a given custom model conversion.
DELETE /customModels/{customModelId}/versions/{customModelVersionId}/conversions/{conversionId}/
  • CustomModelsVersionsConversionsList
  • datarobot::ListCustomModelsVersionsConversions
Get a list or latest custom model conversion(s).
GET /customModels/{customModelId}/versions/{customModelVersionId}/conversions/
  • CustomModelsVersionsConversionsRetrieve
  • datarobot::RetrieveCustomModelsVersionsConversions
Get a given custom model conversion.
GET /customModels/{customModelId}/versions/{customModelVersionId}/conversions/{conversionId}/
  • CustomModelsVersionsCreate
  • datarobot::CreateCustomModelsVersions
Create custom model version.
POST /customModels/{customModelId}/versions/
  • CustomModelsVersionsDependencyBuildCreate
  • datarobot::CreateCustomModelsVersionsDependencyBuild
Start a custom model version's dependency build.
POST /customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/
  • CustomModelsVersionsDependencyBuildDeleteMany
  • datarobot::DeleteManyCustomModelsVersionsDependencyBuild
Cancel dependency build.
DELETE /customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/
  • CustomModelsVersionsDependencyBuildList
  • datarobot::ListCustomModelsVersionsDependencyBuild
Retrieve the custom model version's dependency build status.
GET /customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/
  • CustomModelsVersionsDependencyBuildLogList
  • datarobot::ListCustomModelsVersionsDependencyBuildLog
Retrieve the custom model version's dependency build log.
GET /customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuildLog/
  • CustomModelsVersionsDownloadList
  • datarobot::ListCustomModelsVersionsDownload
Download custom model version content.
GET /customModels/{customModelId}/versions/{customModelVersionId}/download/
  • CustomModelsVersionsFeatureImpactCreate
  • datarobot::CreateCustomModelsVersionsFeatureImpact
Create custom model feature impact.
POST /customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/
  • CustomModelsVersionsFeatureImpactList
  • datarobot::ListCustomModelsVersionsFeatureImpact
Get custom model feature impact.
GET /customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/
  • CustomModelsVersionsFromRepositoryCreate
  • datarobot::CreateCustomModelsVersionsFromRepository
Create custom model version from remote repository.
POST /customModels/{customModelId}/versions/fromRepository/
  • CustomModelsVersionsFromRepositoryPatchMany
  • datarobot::PatchManyCustomModelsVersionsFromRepository
Create custom model version from remote repository with files from previous version.
PATCH /customModels/{customModelId}/versions/fromRepository/
  • CustomModelsVersionsList
  • datarobot::ListCustomModelsVersions
List custom model versions.
GET /customModels/{customModelId}/versions/
  • CustomModelsVersionsPatch
  • datarobot::PatchCustomModelsVersions
Update custom model version.
PATCH /customModels/{customModelId}/versions/{customModelVersionId}/
  • CustomModelsVersionsPredictionExplanationsInitializationCreate
  • datarobot::CreateCustomModelsVersionsPredictionExplanationsInitialization
Create a new prediction explanations initialization for custom model version.
POST /customModels/{customModelId}/versions/{customModelVersionId}/predictionExplanationsInitialization/
  • CustomModelsVersionsRetrieve
  • datarobot::RetrieveCustomModelsVersions
Get custom model version.
GET /customModels/{customModelId}/versions/{customModelVersionId}/
  • CustomTrainingBlueprintsCreate
  • datarobot::CreateCustomTrainingBlueprints
Create a blueprint from a single custom training estimator.
POST /customTrainingBlueprints/
  • CustomTrainingBlueprintsList
  • datarobot::ListCustomTrainingBlueprints
List training blueprints.
GET /customTrainingBlueprints/
  • ModelPackagesArchiveCreate
  • datarobot::CreateModelPackagesArchive
Archive a model package.
POST /modelPackages/{modelPackageId}/archive/
  • ModelPackagesCapabilitiesList
  • datarobot::ListModelPackagesCapabilities
Retrieve capabilities.
GET /modelPackages/{modelPackageId}/capabilities/
  • ModelPackagesFeaturesList
  • datarobot::ListModelPackagesFeatures
Retrieve feature list.
GET /modelPackages/{modelPackageId}/features/
  • ModelPackagesFromLearningModelCreate
  • datarobot::CreateModelPackagesFromLearningModel
Create model package from DataRobot model.
POST /modelPackages/fromLearningModel/
  • ModelPackagesList
  • datarobot::ListModelPackages
List model packages
GET /modelPackages/
  • ModelPackagesRetrieve
  • datarobot::RetrieveModelPackages
Retrieve info about a model package.
GET /modelPackages/{modelPackageId}/
  • ModelPackagesSharedRolesList
  • datarobot::ListModelPackagesSharedRoles
Get model package's access control list
GET /modelPackages/{modelPackageId}/sharedRoles/
  • ProjectsBiasMitigatedModelsCreate
  • datarobot::CreateProjectsBiasMitigatedModels
Add a request to the queue to train a model with bias mitigation applied.
POST /projects/{projectId}/biasMitigatedModels/
  • ProjectsBiasMitigatedModelsList
  • datarobot::ListProjectsBiasMitigatedModels
List of bias mitigated models for the selected project.
GET /projects/{projectId}/biasMitigatedModels/
  • ProjectsBiasMitigationFeatureInfoCreateOne
  • datarobot::CreateOneProjectsBiasMitigationFeatureInfo
Submit a job to create bias mitigation data quality information for a given projectId and featureName.
POST /projects/{projectId}/biasMitigationFeatureInfo/{featureName}/
  • ProjectsBiasMitigationFeatureInfoList
  • datarobot::ListProjectsBiasMitigationFeatureInfo
Get bias mitigation data quality information for a given projectId and featureName.
GET /projects/{projectId}/biasMitigationFeatureInfo/
  • ProjectsBlenderModelsBlendCheckCreate
  • datarobot::IsBlenderEligible
Check if models can be blended.
POST /projects/{projectId}/blenderModels/blendCheck/
  • ProjectsBlenderModelsCreate
  • datarobot::RequestBlender
Create a blender from other models using a specified blender method.
POST /projects/{projectId}/blenderModels/
  • ProjectsBlenderModelsList
  • datarobot::ListProjectsBlenderModels
List all blenders in a project.
GET /projects/{projectId}/blenderModels/
  • ProjectsBlenderModelsRetrieve
  • datarobot::GetBlenderModel
Retrieve a blender.
GET /projects/{projectId}/blenderModels/{modelId}/
  • ProjectsCombinedModelsList
  • datarobot::ListProjectsCombinedModels
Retrieve all existing combined models for this project.
GET /projects/{projectId}/combinedModels/
  • ProjectsCombinedModelsRetrieve
  • datarobot::RetrieveProjectsCombinedModels
Retrieve an existing combined model.
GET /projects/{projectId}/combinedModels/{combinedModelId}/
  • ProjectsCombinedModelsSegmentsDownloadList
  • datarobot::ListProjectsCombinedModelsSegmentsDownload
Download Combined Model segments info.
GET /projects/{projectId}/combinedModels/{combinedModelId}/segments/download/
  • ProjectsCombinedModelsSegmentsList
  • datarobot::ListProjectsCombinedModelsSegments
Retrieve Combined Model segments info.
GET /projects/{projectId}/combinedModels/{combinedModelId}/segments/
  • ProjectsDatetimeModelsBacktestsCreate
  • datarobot::ScoreBacktests
Score all the available backtests of a datetime model.
POST /projects/{projectId}/datetimeModels/{modelId}/backtests/
  • ProjectsDatetimeModelsCreate
  • datarobot::RequestNewDatetimeModel
Train a new datetime model.
POST /projects/{projectId}/datetimeModels/
  • ProjectsDatetimeModelsFromModelCreate
  • datarobot::CreateProjectsDatetimeModelsFromModel
Retrain an existing datetime model with specified parameters.
POST /projects/{projectId}/datetimeModels/fromModel/
  • ProjectsDatetimeModelsList
  • datarobot::ListProjectsDatetimeModels
List datetime partitioned project models
GET /projects/{projectId}/datetimeModels/
  • ProjectsDatetimeModelsRetrieve
  • datarobot::GetDatetimeModel
Get datetime model
GET /projects/{projectId}/datetimeModels/{modelId}/
  • ProjectsDeploymentReadyModelsCreate
  • datarobot::CreateProjectsDeploymentReadyModels
Prepare a model for deployment
POST /projects/{projectId}/deploymentReadyModels/
  • ProjectsEureqaDistributionPlotRetrieve
  • datarobot::RetrieveProjectsEureqaDistributionPlot
Retrieve Eureqa model details plot.
GET /projects/{projectId}/eureqaDistributionPlot/{solutionId}/
  • ProjectsEureqaModelDetailRetrieve
  • datarobot::RetrieveProjectsEureqaModelDetail
Retrieve Eureqa model details plot.
GET /projects/{projectId}/eureqaModelDetail/{solutionId}/
  • ProjectsEureqaModelsCreate
  • datarobot::AddEureqaSolution
Create a new model from an existing eureqa solution.
POST /projects/{projectId}/eureqaModels/
  • ProjectsEureqaModelsRetrieve
  • datarobot::GetParetoFront
Retrieve the pareto front for the specified Eureqa model.
GET /projects/{projectId}/eureqaModels/{modelId}/
  • ProjectsFrozenDatetimeModelsCreate
  • datarobot::RequestFrozenDatetimeModel
Train a frozen datetime model.
POST /projects/{projectId}/frozenDatetimeModels/
  • ProjectsFrozenModelsCreate
  • datarobot::RequestFrozenModel
Train a new frozen model with parameters from an existing model.
POST /projects/{projectId}/frozenModels/
  • ProjectsFrozenModelsList
  • datarobot::ListProjectsFrozenModels
List all frozen models from a project.
GET /projects/{projectId}/frozenModels/
  • ProjectsFrozenModelsRetrieve
  • datarobot::GetFrozenModel
Look up a particular frozen model.
GET /projects/{projectId}/frozenModels/{modelId}/
  • ProjectsModelJobsDelete
  • datarobot::DeleteModelJob
Cancel a modeling job.
DELETE /projects/{projectId}/modelJobs/{jobId}/
  • ProjectsModelJobsList
  • datarobot::ListModelJobs
List modeling jobs
GET /projects/{projectId}/modelJobs/
  • ProjectsModelJobsRetrieve
  • datarobot::GetModelJob
Look up a specific modeling job
GET /projects/{projectId}/modelJobs/{jobId}/
  • ProjectsModelsAdvancedTuningCreate
  • datarobot::RunInteractiveTuning
Submit a job to make a new version of the model with different advanced tuning parameters.
POST /projects/{projectId}/models/{modelId}/advancedTuning/
  • ProjectsModelsAdvancedTuningParametersList
  • datarobot::GetTuningParameters
Retrieve information about all advanced tuning parameters available for the specified model.
GET /projects/{projectId}/models/{modelId}/advancedTuning/parameters/
  • ProjectsModelsClusterNamesList
  • datarobot::ListProjectsModelsClusterNames
Retrieve cluster names assigned to an unsupervised cluster model
GET /projects/{projectId}/models/{modelId}/clusterNames/
  • ProjectsModelsClusterNamesPatchMany
  • datarobot::PatchManyProjectsModelsClusterNames
Update cluster names assigned to an unsupervised cluster model
PATCH /projects/{projectId}/models/{modelId}/clusterNames/
  • ProjectsModelsCreate
  • datarobot::RequestNewModel
Train a new model
POST /projects/{projectId}/models/
  • ProjectsModelsCrossValidationCreate
  • datarobot::CrossValidateModel
Run Cross Validation on a model.
POST /projects/{projectId}/models/{modelId}/crossValidation/
  • ProjectsModelsCrossValidationScoresList
  • datarobot::GetCrossValidationScores
Get Cross Validation scores for each partition in a model.
GET /projects/{projectId}/models/{modelId}/crossValidationScores/
  • ProjectsModelsDelete
  • datarobot::DeleteModel
Delete a model from the leaderboard.
DELETE /projects/{projectId}/models/{modelId}/
  • ProjectsModelsFeaturesList
  • datarobot::ListModelFeatures
List the features used in a model.
GET /projects/{projectId}/models/{modelId}/features/
  • ProjectsModelsFromModelCreate
  • datarobot::CreateProjectsModelsFromModel
Retrain a model
POST /projects/{projectId}/models/fromModel/
  • ProjectsModelsList
  • datarobot::ListModels
List project models
GET /projects/{projectId}/models/
  • ProjectsModelsMissingReportList
  • datarobot::GetMissingValuesReport
Retrieve a summary of how the model's subtasks handle missing values.
GET /projects/{projectId}/models/{modelId}/missingReport/
  • ProjectsModelsNumIterationsTrainedList
  • datarobot::ListProjectsModelsNumIterationsTrained
Get number of iterations trained
GET /projects/{projectId}/models/{modelId}/numIterationsTrained/
  • ProjectsModelsParametersList
  • datarobot::GetModelParameters
Retrieve model parameters.
GET /projects/{projectId}/models/{modelId}/parameters/
  • ProjectsModelsPatch
  • datarobot::StarModel
Updates a model's attribute(s).
PATCH /projects/{projectId}/models/{modelId}/
  • ProjectsModelsPredictionIntervalsCreate
  • datarobot::CreateProjectsModelsPredictionIntervals
Calculate prediction intervals for the specified percentiles for this model.
POST /projects/{projectId}/models/{modelId}/predictionIntervals/
  • ProjectsModelsPredictionIntervalsList
  • datarobot::ListProjectsModelsPredictionIntervals
Retrieve prediction intervals that are already calculated for this model.
GET /projects/{projectId}/models/{modelId}/predictionIntervals/
  • ProjectsModelsPrimeInfoList
  • datarobot::GetPrimeEligibility
Check a Model for Prime Eligibility
GET /projects/{projectId}/models/{modelId}/primeInfo/
  • ProjectsModelsPrimeRulesetsCreate
  • datarobot::RequestApproximation
Create Rulesets
POST /projects/{projectId}/models/{modelId}/primeRulesets/
  • ProjectsModelsPrimeRulesetsList
  • datarobot::GetRulesets
List Rulesets
GET /projects/{projectId}/models/{modelId}/primeRulesets/
  • ProjectsModelsRetrieve
  • datarobot::GetModel
Get model
GET /projects/{projectId}/models/{modelId}/
  • ProjectsModelsScoringCodeList
  • datarobot::DownloadScoringCode
Retrieve Scoring Code
GET /projects/{projectId}/models/{modelId}/scoringCode/
  • ProjectsModelsSupportedCapabilitiesList
  • datarobot::GetModelCapabilities
Get supported capabilities for a model.
GET /projects/{projectId}/models/{modelId}/supportedCapabilities/
  • ProjectsPrimeFilesCreate
  • datarobot::CreatePrimeCode
Create a Prime File
POST /projects/{projectId}/primeFiles/
  • ProjectsPrimeFilesDownloadList
  • datarobot::DownloadPrimeCode
Download Code
GET /projects/{projectId}/primeFiles/{primeFileId}/download/
  • ProjectsPrimeFilesList
  • datarobot::ListPrimeFiles
Get Prime Files
GET /projects/{projectId}/primeFiles/
  • ProjectsPrimeFilesRetrieve
  • datarobot::GetPrimeFile
Retrieve metadata about a DataRobot Prime file
GET /projects/{projectId}/primeFiles/{primeFileId}/
  • ProjectsPrimeModelsCreate
  • datarobot::RequestPrimeModel
Create a Prime Model from a Ruleset
POST /projects/{projectId}/primeModels/
  • ProjectsPrimeModelsList
  • datarobot::ListPrimeModels
List all Prime models in a project
GET /projects/{projectId}/primeModels/
  • ProjectsPrimeModelsRetrieve
  • datarobot::GetPrimeModel
Retrieve a Prime model details
GET /projects/{projectId}/primeModels/{modelId}/
  • ProjectsRatingTableModelsCreate
  • datarobot::RequestNewRatingTableModel
Create New Models From A Rating Table
POST /projects/{projectId}/ratingTableModels/
  • ProjectsRatingTableModelsList
  • datarobot::ListRatingTableModels
List Rating Table Models
GET /projects/{projectId}/ratingTableModels/
  • ProjectsRatingTableModelsRetrieve
  • datarobot::GetRatingTableModel
Retrieve Rating Table Model
GET /projects/{projectId}/ratingTableModels/{modelId}/
  • ProjectsRatingTablesCreate
  • datarobot::CreateRatingTable
Upload Modified Rating Table File
POST /projects/{projectId}/ratingTables/
  • ProjectsRatingTablesFileList
  • datarobot::DownloadRatingTable
Retrieve Rating Table File
GET /projects/{projectId}/ratingTables/{ratingTableId}/file/
  • ProjectsRatingTablesList
  • datarobot::ListRatingTables
List Rating Tables For The Project
GET /projects/{projectId}/ratingTables/
  • ProjectsRatingTablesPatch
  • datarobot::RenameRatingTable
Update an uploaded rating table
PATCH /projects/{projectId}/ratingTables/{ratingTableId}/
  • ProjectsRatingTablesRetrieve
  • datarobot::GetRatingTable
Retrieve Rating Table Information
GET /projects/{projectId}/ratingTables/{ratingTableId}/
  • ProjectsRecommendedModelsList
  • datarobot::ListModelRecommendations
List recommended models for the project
GET /projects/{projectId}/recommendedModels/
  • ProjectsRecommendedModelsRecommendedModelList
  • datarobot::ListProjectsRecommendedModelsRecommendedModel
Get recommended model
GET /projects/{projectId}/recommendedModels/recommendedModel/
  • ProjectsSegmentChampionPutMany
  • datarobot::PutManyProjectsSegmentChampion
Update champion model for a segment project.
PUT /projects/{projectId}/segmentChampion/

NotificationsApi

Functions and Description HTTP request
  • NotificationChannelsCreate
  • datarobot::CreateNotificationChannels
Create notification channel
POST /notificationChannels/
  • NotificationChannelsDelete
  • datarobot::DeleteNotificationChannels
Delete notification channel
DELETE /notificationChannels/{channelId}/
  • NotificationChannelsList
  • datarobot::ListNotificationChannels
List notification channels
GET /notificationChannels/
  • NotificationChannelsPut
  • datarobot::PutNotificationChannels
Update notification channel
PUT /notificationChannels/{channelId}/
  • NotificationChannelsRetrieve
  • datarobot::RetrieveNotificationChannels
Retrieve notification channel
GET /notificationChannels/{channelId}/
  • NotificationEmailChannelVerificationCreate
  • datarobot::CreateNotificationEmailChannelVerification
Sending a 6 digit verification code to user's email
POST /notificationEmailChannelVerification/
  • NotificationEmailChannelVerificationStatusCreate
  • datarobot::CreateNotificationEmailChannelVerificationStatus
Retrieve the status of whether admin enter code correctly
POST /notificationEmailChannelVerificationStatus/
  • NotificationEventsList
  • datarobot::ListNotificationEvents
List event types and groups the user can include in notification policies.
GET /notificationEvents/
  • NotificationLogsList
  • datarobot::ListNotificationLogs
List the notification logs
GET /notificationLogs/
  • NotificationPoliciesCreate
  • datarobot::CreateNotificationPolicies
Create notification policy
POST /notificationPolicies/
  • NotificationPoliciesDelete
  • datarobot::DeleteNotificationPolicies
Delete notification policy
DELETE /notificationPolicies/{policyId}/
  • NotificationPoliciesList
  • datarobot::ListNotificationPolicies
List notification policies
GET /notificationPolicies/
  • NotificationPoliciesPut
  • datarobot::PutNotificationPolicies
Update notification policy
PUT /notificationPolicies/{policyId}/
  • NotificationPoliciesRetrieve
  • datarobot::RetrieveNotificationPolicies
Retrieve notification policy
GET /notificationPolicies/{policyId}/
  • NotificationPolicyMutesCreate
  • datarobot::CreateNotificationPolicyMutes
Create a new ignored notification
POST /notificationPolicyMutes/
  • NotificationPolicyMutesDelete
  • datarobot::DeleteNotificationPolicyMutes
Delete the existing notification policy mute
DELETE /notificationPolicyMutes/{muteId}/
  • NotificationPolicyMutesList
  • datarobot::ListNotificationPolicyMutes
List the ignored notifications filtered by orgId if provided
GET /notificationPolicyMutes/
  • NotificationWebhookChannelTestsCreate
  • datarobot::CreateNotificationWebhookChannelTests
Test webhook notification channel
POST /notificationWebhookChannelTests/
  • NotificationWebhookChannelTestsRetrieve
  • datarobot::RetrieveNotificationWebhookChannelTests
Retrieve status of notification channel test
GET /notificationWebhookChannelTests/{notificationId}/
  • NotificationsCreate
  • datarobot::CreateNotifications
Resends the notification
POST /notifications/
  • RemoteEventsCreate
  • datarobot::CreateRemoteEvents
Post a remote deployment event
POST /remoteEvents/
  • UserNotificationsDelete
  • datarobot::DeleteUserNotifications
Delete user notification
DELETE /userNotifications/{userNotificationId}/
  • UserNotificationsDeleteMany
  • datarobot::DeleteManyUserNotifications
Delete all user notifications
DELETE /userNotifications/
  • UserNotificationsList
  • datarobot::ListUserNotifications
List user notifications
GET /userNotifications/
  • UserNotificationsPatch
  • datarobot::PatchUserNotifications
Mark as read
PATCH /userNotifications/{userNotificationId}/
  • UserNotificationsPatchMany
  • datarobot::PatchManyUserNotifications
Mark all as read
PATCH /userNotifications/

PredictionsApi

Functions and Description HTTP request
  • BatchPredictionJobDefinitionsCreate
  • datarobot::CreateBatchPredictionJobDefinitions
Creates a new Batch Prediction job definition
POST /batchPredictionJobDefinitions/
  • BatchPredictionJobDefinitionsDelete
  • datarobot::DeleteBatchPredictionJobDefinitions
Delete Batch Prediction job definition
DELETE /batchPredictionJobDefinitions/{jobDefinitionId}/
  • BatchPredictionJobDefinitionsList
  • datarobot::ListBatchPredictionJobDefinitions
List Batch Prediction job definitions
GET /batchPredictionJobDefinitions/
  • BatchPredictionJobDefinitionsPatch
  • datarobot::PatchBatchPredictionJobDefinitions
Update Batch Prediction job definition
PATCH /batchPredictionJobDefinitions/{jobDefinitionId}/
  • BatchPredictionJobDefinitionsPortableList
  • datarobot::ListBatchPredictionJobDefinitionsPortable
Retrieve job definition snippet for PBP
GET /batchPredictionJobDefinitions/{jobDefinitionId}/portable/
  • BatchPredictionJobDefinitionsRetrieve
  • datarobot::RetrieveBatchPredictionJobDefinitions
Retrieve Batch Prediction job definition
GET /batchPredictionJobDefinitions/{jobDefinitionId}/
  • BatchPredictionsCreate
  • datarobot::CreateBatchPredictions
Creates a new Batch Prediction job
POST /batchPredictions/
  • BatchPredictionsCsvUploadFinalizeMultipartCreate
  • datarobot::CreateBatchPredictionsCsvUploadFinalizeMultipart
Finalize a multipart upload
POST /batchPredictions/{predictionJobId}/csvUpload/finalizeMultipart/
  • BatchPredictionsCsvUploadPartPut
  • datarobot::PutBatchPredictionsCsvUploadPart
Upload CSV data in multiple parts
PUT /batchPredictions/{predictionJobId}/csvUpload/part/{partNumber}/
  • BatchPredictionsCsvUploadPutMany
  • datarobot::PutManyBatchPredictionsCsvUpload
Creates a new_model_id Batch Prediction job
PUT /batchPredictions/{predictionJobId}/csvUpload/
  • BatchPredictionsDelete
  • datarobot::DeleteBatchPredictions
Cancel a Batch Prediction job
DELETE /batchPredictions/{predictionJobId}/
  • BatchPredictionsDownloadList
  • datarobot::ListBatchPredictionsDownload
Download the scored data set of a batch prediction job
GET /batchPredictions/{predictionJobId}/download/
  • BatchPredictionsFromExistingCreate
  • datarobot::CreateBatchPredictionsFromExisting
Create a new a Batch Prediction job based on an existing Batch Prediction job.
POST /batchPredictions/fromExisting/
  • BatchPredictionsFromJobDefinitionCreate
  • datarobot::CreateBatchPredictionsFromJobDefinition
Launch a Batch Prediction job for scoring
POST /batchPredictions/fromJobDefinition/
  • BatchPredictionsList
  • datarobot::ListBatchPredictions
List batch prediction jobs
GET /batchPredictions/
  • BatchPredictionsPatch
  • datarobot::PatchBatchPredictions
Update a Batch Prediction job
PATCH /batchPredictions/{predictionJobId}/
  • BatchPredictionsRetrieve
  • datarobot::RetrieveBatchPredictions
Retrieve Batch Prediction job
GET /batchPredictions/{predictionJobId}/
  • ComputedTrainingPredictionsList
  • datarobot::GetTrainingPredictions
Retrieve training predictions
GET /projects/{projectId}/trainingPredictions/{predictionId}/
  • ProjectsModelsPredictionExplanationsInitializationCreate
  • datarobot::RequestPredictionExplanationsInitialization
Create a new prediction explanations initialization.
POST /projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
  • ProjectsModelsPredictionExplanationsInitializationDeleteMany
  • datarobot::DeletePredictionExplanationsInitialization
Delete an existing PredictionExplanationsInitialization.
DELETE /projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
  • ProjectsModelsPredictionExplanationsInitializationList
  • datarobot::GetPredictionExplanationsInitialization
Retrieve the current PredictionExplanationsInitialization.
GET /projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
  • ProjectsPredictJobsDelete
  • datarobot::DeletePredictJob
Cancel a queued prediction job
DELETE /projects/{projectId}/predictJobs/{jobId}/
  • ProjectsPredictJobsList
  • datarobot::GetPredictJobs
List all prediction jobs for a project
GET /projects/{projectId}/predictJobs/
  • ProjectsPredictJobsRetrieve
  • datarobot::GetPredictJob
Look up a particular prediction job
GET /projects/{projectId}/predictJobs/{jobId}/
  • ProjectsPredictionDatasetsDataSourceUploadsCreate
  • datarobot::UploadPredictionDatasetFromDataSource
Upload a dataset for predictions from a DataSource.
POST /projects/{projectId}/predictionDatasets/dataSourceUploads/
  • ProjectsPredictionDatasetsDatasetUploadsCreate
  • datarobot::UploadPredictionDatasetFromCatalog
Create prediction dataset
POST /projects/{projectId}/predictionDatasets/datasetUploads/
  • ProjectsPredictionDatasetsDelete
  • datarobot::DeletePredictionDataset
Delete a dataset that was uploaded for prediction.
DELETE /projects/{projectId}/predictionDatasets/{datasetId}/
  • ProjectsPredictionDatasetsFileUploadsCreate
  • datarobot::CreateProjectsPredictionDatasetsFileUploads
Upload a file for predictions from an attached file.
POST /projects/{projectId}/predictionDatasets/fileUploads/
  • ProjectsPredictionDatasetsList
  • datarobot::ListPredictionDatasets
List predictions datasets uploaded to a project.
GET /projects/{projectId}/predictionDatasets/
  • ProjectsPredictionDatasetsRetrieve
  • datarobot::GetPredictionDataset
Get the metadata of a specific dataset. This only works for datasets uploaded to an existing project for prediction.
GET /projects/{projectId}/predictionDatasets/{datasetId}/
  • ProjectsPredictionDatasetsUrlUploadsCreate
  • datarobot::UploadPredictionDataset
Upload a file for predictions from a URL.
POST /projects/{projectId}/predictionDatasets/urlUploads/
  • ProjectsPredictionExplanationsCreate
  • datarobot::RequestPredictionExplanations
Create a new PredictionExplanations object (and its accompanying PredictionExplanationsRecord).
POST /projects/{projectId}/predictionExplanations/
  • ProjectsPredictionExplanationsList
  • datarobot::GetPredictionExplanationsPage
Retrieve stored Prediction Explanations.
GET /projects/{projectId}/predictionExplanations/{predictionExplanationsId}/
  • ProjectsPredictionExplanationsRecordsDelete
  • datarobot::DeletePredictionExplanations
Delete saved Prediction Explanations.
DELETE /projects/{projectId}/predictionExplanationsRecords/{predictionExplanationsId}/
  • ProjectsPredictionExplanationsRecordsList
  • datarobot::ListPredictionExplanationsMetadata
List PredictionExplanationsRecord objects for a project.
GET /projects/{projectId}/predictionExplanationsRecords/
  • ProjectsPredictionExplanationsRecordsRetrieve
  • datarobot::GetPredictionExplanationsMetadata
Retrieve a PredictionExplanationsRecord object.
GET /projects/{projectId}/predictionExplanationsRecords/{predictionExplanationsId}/
  • ProjectsPredictionsCreate
  • datarobot::RequestPredictions
Make new predictions.
POST /projects/{projectId}/predictions/
  • ProjectsPredictionsList
  • datarobot::ListPredictions
Get a list of prediction records.
GET /projects/{projectId}/predictions/
  • ProjectsPredictionsMetadataList
  • datarobot::ListProjectsPredictionsMetadata
Get a list of prediction metadata records.
GET /projects/{projectId}/predictionsMetadata/
  • ProjectsPredictionsMetadataRetrieve
  • datarobot::RetrieveProjectsPredictionsMetadata
Retrieve metadata for a set of predictions.
GET /projects/{projectId}/predictionsMetadata/{predictionId}/
  • ProjectsPredictionsRetrieve
  • datarobot::RetrieveProjectsPredictions
Get a completed set of predictions.
GET /projects/{projectId}/predictions/{predictionId}/
  • ProjectsTrainingPredictionsCreate
  • datarobot::RequestTrainingPredictions
Submits a job to compute predictions for training data
POST /projects/{projectId}/trainingPredictions/
  • ScheduledJobsDelete
  • datarobot::DeleteScheduledJobs
Delete scheduled job
DELETE /scheduledJobs/{jobId}/
  • ScheduledJobsList
  • datarobot::ListScheduledJobs
List scheduled deployment batch prediction jobs a user can view
GET /scheduledJobs/
  • ScheduledJobsPatch
  • datarobot::PatchScheduledJobs
Run or stop a previously created scheduled integration job
PATCH /scheduledJobs/{jobId}/
  • ScheduledJobsRetrieve
  • datarobot::RetrieveScheduledJobs
List a single deployment batch prediction job
GET /scheduledJobs/{jobId}/
  • TrainingPredictionsList
  • datarobot::ListTrainingPredictions
List training prediction jobs
GET /projects/{projectId}/trainingPredictions/

ProjectsApi

Functions and Description HTTP request
  • AccessControlList
  • datarobot::ListProjectsAccessControl
Get project's access control list
GET /projects/{projectId}/accessControl/
  • AccessControlPatchMany
  • datarobot::PatchManyProjectsAccessControl
Update project's access controls
PATCH /projects/{projectId}/accessControl/
  • AutopilotCreate
  • datarobot::PauseQueue
Pause or unpause Autopilot
POST /projects/{projectId}/autopilot/
  • AutopilotsCreate
  • datarobot::StartNewAutoPilot
Start autopilot
POST /projects/{projectId}/autopilots/
  • BatchTypeTransformFeaturesCreate
  • datarobot::BatchFeaturesTypeTransform
Create multiple new features by changing the type of existing features.
POST /projects/{projectId}/batchTypeTransformFeatures/
  • BatchTypeTransformFeaturesResultRetrieve
  • datarobot::RetrieveProjectsBatchTypeTransformFeaturesResult
Retrieve the result of a batch variable type transformation.
GET /projects/{projectId}/batchTypeTransformFeaturesResult/{jobId}/
  • CalendarCountryCodesList
  • datarobot::ListCalendarCountryCodes
Retrieve the list of allowed country codes to request preloaded calendars generation for.
GET /calendarCountryCodes/
  • CalendarEventsList
  • datarobot::ListProjectsCalendarEvents
List available calendar events for the project.
GET /projects/{projectId}/calendarEvents/
  • CalendarsAccessControlList
  • datarobot::ListCalendarsAccessControl
Get a list of users who have access to this calendar and their roles on the calendar.
GET /calendars/{calendarId}/accessControl/
  • CalendarsAccessControlPatchMany
  • datarobot::PatchManyCalendarsAccessControl
Update the access control for this calendar.
PATCH /calendars/{calendarId}/accessControl/
  • CalendarsDelete
  • datarobot::DeleteCalendar
Delete a calendar.
DELETE /calendars/{calendarId}/
  • CalendarsFileUploadCreate
  • datarobot::CreateCalendar
Create a calendar from a file.
POST /calendars/fileUpload/
  • CalendarsFromCountryCodeCreate
  • datarobot::CreateCalendarsFromCountryCode
Initialize generation of preloaded calendars.
POST /calendars/fromCountryCode/
  • CalendarsFromDatasetCreate
  • datarobot::CreateCalendarsFromDataset
Create a calendar from the dataset
POST /calendars/fromDataset/
  • CalendarsList
  • datarobot::ListCalendars
List all available calendars for a user.
GET /calendars/
  • CalendarsPatch
  • datarobot::UpdateCalendar
Update a calendar's name
PATCH /calendars/{calendarId}/
  • CalendarsRetrieve
  • datarobot::GetCalendar
Retrieve information about a calendar.
GET /calendars/{calendarId}/
  • CleanupJobsCreate
  • datarobot::CreateProjectCleanupJobs
Schedule Project Permadelete Job
POST /projectCleanupJobs/
  • CleanupJobsDelete
  • datarobot::DeleteProjectCleanupJobs
Cancel Scheduled Project Permadelete Job
DELETE /projectCleanupJobs/{statusId}/
  • CleanupJobsDownloadList
  • datarobot::ListProjectCleanupJobsDownload
Download a projects permadeletion report.
GET /projectCleanupJobs/{statusId}/download/
  • CleanupJobsList
  • datarobot::ListProjectCleanupJobs
Retrieve Project Permadelete job status
GET /projectCleanupJobs/
  • CleanupJobsRetrieve
  • datarobot::RetrieveProjectCleanupJobs
Retrieve Project Permadelete job status
GET /projectCleanupJobs/{statusId}/
  • CleanupJobsSummaryList
  • datarobot::ListProjectCleanupJobsSummary
Get a projects cleanup jobs summary.
GET /projectCleanupJobs/{statusId}/summary/
  • ClonesCreate
  • datarobot::CloneProject
Clone a project
POST /projectClones/
  • ConfigureAndStartAutopilot
  • datarobot::SetTarget
Start modeling
PATCH /projects/{projectId}/aim/
  • Create
  • datarobot::SetupProject
Create project.
POST /projects/
  • CrossSeriesPropertiesCreate
  • datarobot::RequestCrossSeriesDetection
Validate columns for potential use as the group-by column for cross-series functionality.
POST /projects/{projectId}/crossSeriesProperties/
  • Delete
  • datarobot::DeleteProject
Delete a project
DELETE /projects/{projectId}/
  • DeletedProjectsCountList
  • datarobot::ListDeletedProjectsCount
Count soft-deleted projects.
GET /deletedProjectsCount/
  • DeletedProjectsList
  • datarobot::ListDeletedProjects
Retrieve a list of soft-deleted projects
GET /deletedProjects/
  • DeletedProjectsPatch
  • datarobot::PatchDeletedProjects
Recover soft-deleted project
PATCH /deletedProjects/{projectId}/
  • DiscardedFeaturesList
  • datarobot::RetrieveDiscardedFeaturesInformation
Get discarded features.
GET /projects/{projectId}/discardedFeatures/
  • ExternalTimeSeriesBaselineDataValidationJobsCreate
  • datarobot::CreateProjectsExternalTimeSeriesBaselineDataValidationJobs
Validate baseline data
POST /projects/{projectId}/externalTimeSeriesBaselineDataValidationJobs/
  • ExternalTimeSeriesBaselineDataValidationJobsRetrieve
  • datarobot::RetrieveProjectsExternalTimeSeriesBaselineDataValidationJobs
Retrieve Baseline Validation Job
GET /projects/{projectId}/externalTimeSeriesBaselineDataValidationJobs/{baselineValidationJobId}/
  • FeatureDiscoveryDatasetDownloadList
  • datarobot::ListProjectsFeatureDiscoveryDatasetDownload
Download the project dataset with features added by feature discovery
GET /projects/{projectId}/featureDiscoveryDatasetDownload/
  • FeatureDiscoveryLogsDownloadList
  • datarobot::ListProjectsFeatureDiscoveryLogsDownload
Retrieve a text file containing the feature discovery log
GET /projects/{projectId}/featureDiscoveryLogs/download/
  • FeatureDiscoveryLogsList
  • datarobot::ListProjectsFeatureDiscoveryLogs
Retrieve the feature discovery log content and log length
GET /projects/{projectId}/featureDiscoveryLogs/
  • FeatureDiscoveryRecipeSQLsDownloadList
  • datarobot::ListProjectsFeatureDiscoveryRecipeSQLsDownload
Download feature discovery SQL recipe
GET /projects/{projectId}/featureDiscoveryRecipeSQLs/download/
  • FeatureDiscoveryRecipeSqlExportsCreate
  • datarobot::CreateProjectsFeatureDiscoveryRecipeSqlExports
Generate feature discovery SQL recipe
POST /projects/{projectId}/featureDiscoveryRecipeSqlExports/
  • FeatureHistogramsRetrieve
  • datarobot::GetFeatureHistogram
Get feature histogram
GET /projects/{projectId}/featureHistograms/{featureName}/
  • FeatureLineagesRetrieve
  • datarobot::RetrieveProjectsFeatureLineages
Retrieve Feature Discovery Lineage
GET /projects/{projectId}/featureLineages/{featureLineageId}/
  • FeaturelistsCreate
  • datarobot::CreateFeaturelist
Create a new featurelist.
POST /projects/{projectId}/featurelists/
  • FeaturelistsDelete
  • datarobot::DeleteFeaturelist
Delete a specified featurelist.
DELETE /projects/{projectId}/featurelists/{featurelistId}/
  • FeaturelistsList
  • datarobot::ListFeaturelists
List featurelists
GET /projects/{projectId}/featurelists/
  • FeaturelistsPatch
  • datarobot::UpdateFeaturelist
Update an existing featurelist
PATCH /projects/{projectId}/featurelists/{featurelistId}/
  • FeaturelistsRetrieve
  • datarobot::GetFeaturelist
Retrieve a feature list
GET /projects/{projectId}/featurelists/{featurelistId}/
  • FeaturesList
  • datarobot::ListFeatureInfo
List project features
GET /projects/{projectId}/features/
  • FeaturesMetricsList
  • datarobot::GetValidMetrics
List feature metrics
GET /projects/{projectId}/features/metrics/
  • FeaturesMultiseriesPropertiesList
  • datarobot::GetMultiSeriesProperties
Retrieve potential multiseries ID columns to use with a particular datetime partition column.
GET /projects/{projectId}/features/{featureName}/multiseriesProperties/
  • FeaturesRetrieve
  • datarobot::GetFeatureInfo
Get project feature
GET /projects/{projectId}/features/{featureName}/
  • HdfsProjectsCreate
  • datarobot::CreateHdfsProjects
Create a project from an HDFS file source.
POST /hdfsProjects/
  • JobsDelete
  • datarobot::DeleteProjectsJobs
Cancel Job
DELETE /projects/{projectId}/jobs/{jobId}/
  • JobsList
  • datarobot::ListJobs
List project jobs
GET /projects/{projectId}/jobs/
  • JobsRetrieve
  • datarobot::GetJob
Get job
GET /projects/{projectId}/jobs/{jobId}/
  • List
  • datarobot::ListProjects
List projects
GET /projects/
  • ModelingFeaturelistsCreate
  • datarobot::CreateModelingFeaturelist
Create a new modeling featurelist.
POST /projects/{projectId}/modelingFeaturelists/
  • ModelingFeaturelistsDelete
  • datarobot::DeleteModelingFeaturelist
Delete a specified modeling featurelist.
DELETE /projects/{projectId}/modelingFeaturelists/{featurelistId}/
  • ModelingFeaturelistsList
  • datarobot::ListModelingFeaturelists
List all modeling featurelists from a project
GET /projects/{projectId}/modelingFeaturelists/
  • ModelingFeaturelistsPatch
  • datarobot::UpdateModelingFeaturelist
Update an existing modeling featurelist
PATCH /projects/{projectId}/modelingFeaturelists/{featurelistId}/
  • ModelingFeaturelistsRetrieve
  • datarobot::GetModelingFeaturelist
Retrieve a single modeling featurelist by ID
GET /projects/{projectId}/modelingFeaturelists/{featurelistId}/
  • ModelingFeaturesFromDiscardedFeaturesCreate
  • datarobot::RestoreDiscardedFeatures
Restore discarded time series features.
POST /projects/{projectId}/modelingFeatures/fromDiscardedFeatures/
  • ModelingFeaturesList
  • datarobot::ListProjectsModelingFeatures
List project modeling features.
GET /projects/{projectId}/modelingFeatures/
  • ModelingFeaturesRetrieve
  • datarobot::RetrieveProjectsModelingFeatures
Retrieve project modeling feature.
GET /projects/{projectId}/modelingFeatures/{featureName}/
  • MultiseriesIdsCrossSeriesPropertiesList
  • datarobot::ListProjectsMultiseriesIdsCrossSeriesProperties
Retrieve eligible cross-series group-by columns.
GET /projects/{projectId}/multiseriesIds/{multiseriesId}/crossSeriesProperties/
  • MultiseriesNamesList
  • datarobot::ListProjectsMultiseriesNames
List the names of a multiseries project.
GET /projects/{projectId}/multiseriesNames/
  • MultiseriesPropertiesCreate
  • datarobot::RequestMultiSeriesDetection
Detect multiseries properties
POST /projects/{projectId}/multiseriesProperties/
  • Patch
  • datarobot::UpdateProject
Update project
PATCH /projects/{projectId}/
  • RelationshipsConfigurationList
  • datarobot::GetFeatureDiscoveryRelationships
Retrieve relationships configuration for a project
GET /projects/{projectId}/relationshipsConfiguration/
  • RelationshipsConfigurationsCreate
  • datarobot::CreateRelationshipsConfigurations
Create a relationships configuration
POST /relationshipsConfigurations/
  • RelationshipsConfigurationsDelete
  • datarobot::DeleteRelationshipsConfigurations
Delete a relationships configuration
DELETE /relationshipsConfigurations/{relationshipsConfigurationId}/
  • RelationshipsConfigurationsPut
  • datarobot::PutRelationshipsConfigurations
Replace a relationships configuration
PUT /relationshipsConfigurations/{relationshipsConfigurationId}/
  • RelationshipsConfigurationsRetrieve
  • datarobot::RetrieveRelationshipsConfigurations
Retrieve a relationships configuration
GET /relationshipsConfigurations/{relationshipsConfigurationId}/
  • Retrieve
  • datarobot::GetProject
Get project.
GET /projects/{projectId}/
  • SecondaryDatasetsConfigurationsCreate
  • datarobot::CreateProjectsSecondaryDatasetsConfigurations
Create secondary dataset configurations for a project.
POST /projects/{projectId}/secondaryDatasetsConfigurations/
  • SecondaryDatasetsConfigurationsDelete
  • datarobot::DeleteProjectsSecondaryDatasetsConfigurations
Soft deletes a secondary dataset configuration.
DELETE /projects/{projectId}/secondaryDatasetsConfigurations/{secondaryDatasetConfigId}/
  • SecondaryDatasetsConfigurationsList
  • datarobot::ListProjectsSecondaryDatasetsConfigurations
List all secondary dataset configurations for a project
GET /projects/{projectId}/secondaryDatasetsConfigurations/
  • SecondaryDatasetsConfigurationsRetrieve
  • datarobot::RetrieveProjectsSecondaryDatasetsConfigurations
Retrieve secondary dataset configuration by ID.
GET /projects/{projectId}/secondaryDatasetsConfigurations/{secondaryDatasetConfigId}/
  • SegmentationTaskJobResultsRetrieve
  • datarobot::RetrieveProjectsSegmentationTaskJobResults
Retrieve segmentation task statuses.
GET /projects/{projectId}/segmentationTaskJobResults/{segmentationTaskId}/
  • SegmentationTasksCreate
  • datarobot::CreateProjectsSegmentationTasks
Create segmentation tasks.
POST /projects/{projectId}/segmentationTasks/
  • SegmentationTasksList
  • datarobot::ListProjectsSegmentationTasks
List segmentation tasks.
GET /projects/{projectId}/segmentationTasks/
  • SegmentationTasksMappingsList
  • datarobot::ListProjectsSegmentationTasksMappings
Retrieve seriesId to segmentId mappings.
GET /projects/{projectId}/segmentationTasks/{segmentationTaskId}/mappings/
  • SegmentationTasksRetrieve
  • datarobot::RetrieveProjectsSegmentationTasks
Retrieve segmentation task.
GET /projects/{projectId}/segmentationTasks/{segmentationTaskId}/
  • SegmentsPatch
  • datarobot::PatchProjectsSegments
Update child segment project.
PATCH /projects/{projectId}/segments/{segmentId}/
  • StatusList
  • datarobot::GetProjectStatus
Check project status
GET /projects/{projectId}/status/
  • TypeTransformFeaturesCreate
  • datarobot::CreateDerivedFeatureFunctionMaker
Create a new feature by changing the type of an existing one.
POST /projects/{projectId}/typeTransformFeatures/

SsoConfigurationApi

Functions and Description HTTP request
  • SsoConfigurationsCreate
  • datarobot::CreateSsoConfigurations
Create an SSO configuration for a specific organization
POST /ssoConfigurations/
  • SsoConfigurationsList
  • datarobot::ListSsoConfigurations
List sso configurations.
GET /ssoConfigurations/
  • SsoConfigurationsPatch
  • datarobot::PatchSsoConfigurations
Update an SSO configuration for a specific organization.
PATCH /ssoConfigurations/{configurationId}/
  • SsoConfigurationsRetrieve
  • datarobot::RetrieveSsoConfigurations
Retrieve SSO configuration of a specific organization.
GET /ssoConfigurations/{configurationId}/

UseCaseApi

Functions and Description HTTP request
  • UseCaseValueTemplatesCalculationList
  • datarobot::ListUseCaseValueTemplatesCalculation
Calculate value of template with given template parameters.
GET /useCaseValueTemplates/{templateType}/calculation/
  • UseCaseValueTemplatesList
  • datarobot::ListUseCaseValueTemplates
List available use cases templates.
GET /useCaseValueTemplates/
  • UseCaseValueTemplatesRetrieve
  • datarobot::RetrieveUseCaseValueTemplates
Get an individual use case value template by its name.
GET /useCaseValueTemplates/{templateType}/
  • UseCasesActivitiesList
  • datarobot::ListUseCasesActivities
Retrieve the activities of a use case.
GET /useCases/{useCaseId}/activities/
  • UseCasesAttachmentsCreate
  • datarobot::CreateUseCasesAttachments
Attach a list of resources to this use case.
POST /useCases/{useCaseId}/attachments/
  • UseCasesAttachmentsDelete
  • datarobot::DeleteUseCasesAttachments
Removes a resource from a use case.
DELETE /useCases/{useCaseId}/attachments/{attachmentId}/
  • UseCasesAttachmentsList
  • datarobot::ListUseCasesAttachments
Get a list of resources attached to this use case.
GET /useCases/{useCaseId}/attachments/
  • UseCasesAttachmentsRetrieve
  • datarobot::RetrieveUseCasesAttachments
Get a resource that is attached to a use case.
GET /useCases/{useCaseId}/attachments/{attachmentId}/
  • UseCasesCreate
  • datarobot::CreateUseCases
Create a new use case.
POST /useCases/
  • UseCasesDelete
  • datarobot::DeleteUseCases
Delete a use case
DELETE /useCases/{useCaseId}/
  • UseCasesList
  • datarobot::ListUseCases
List use cases the requesting user has access to.
GET /useCases/
  • UseCasesPatch
  • datarobot::PatchUseCases
Update a use case.
PATCH /useCases/{useCaseId}/
  • UseCasesRealizedValueOverTimeList
  • datarobot::ListUseCasesRealizedValueOverTime
Retrieve realized value information for a given use case over a period of time
GET /useCases/{useCaseId}/realizedValueOverTime/
  • UseCasesRetrieve
  • datarobot::RetrieveUseCases
Retrieve a use case.
GET /useCases/{useCaseId}/
  • UseCasesSharedRolesList
  • datarobot::ListUseCasesSharedRoles
Get a list of users, groups and organizations that have an access to this use case
GET /useCases/{useCaseId}/sharedRoles/
  • UseCasesSharedRolesPatchMany
  • datarobot::PatchManyUseCasesSharedRoles
Share a use case with a user, group or organization.
PATCH /useCases/{useCaseId}/sharedRoles/

UserManagementApi

Functions and Description HTTP request
  • GroupsCreate
  • datarobot::CreateGroups
Create user group
POST /groups/
  • GroupsDelete
  • datarobot::DeleteGroups
Delete user group
DELETE /groups/{groupId}/
  • GroupsDeleteMany
  • datarobot::DeleteManyGroups
Delete multiple user groups
DELETE /groups/
  • GroupsPatch
  • datarobot::PatchGroups
Update user group
PATCH /groups/{groupId}/
  • GroupsRetrieve
  • datarobot::RetrieveGroups
Retrieve user group
GET /groups/{groupId}/
  • GroupsUsersCreate
  • datarobot::CreateGroupsUsers
Add users to group
POST /groups/{groupId}/users/
  • GroupsUsersDeleteMany
  • datarobot::DeleteManyGroupsUsers
Remove users from group
DELETE /groups/{groupId}/users/
  • GroupsUsersList
  • datarobot::ListGroupsUsers
List users in group
GET /groups/{groupId}/users/
  • OrganizationsJobsList
  • datarobot::ListOrganizationsJobs
List organization jobs
GET /organizations/{organizationId}/jobs/
  • OrganizationsList
  • datarobot::ListOrganizations
List organizations
GET /organizations/
  • OrganizationsRetrieve
  • datarobot::RetrieveOrganizations
Retrieve organization
GET /organizations/{organizationId}/
  • OrganizationsUsersCreate
  • datarobot::CreateOrganizationsUsers
Add user to an existing organization.
POST /organizations/{organizationId}/users/
  • OrganizationsUsersDelete
  • datarobot::DeleteOrganizationsUsers
Remove user from organization
DELETE /organizations/{organizationId}/users/{userId}/
  • OrganizationsUsersList
  • datarobot::ListOrganizationsUsers
List organization users
GET /organizations/{organizationId}/users/
  • OrganizationsUsersPatch
  • datarobot::PatchOrganizationsUsers
Patch organization's user
PATCH /organizations/{organizationId}/users/{userId}/
  • OrganizationsUsersRetrieve
  • datarobot::RetrieveOrganizationsUsers
Retrieve user from organization
GET /organizations/{organizationId}/users/{userId}/
  • UserCleanupJobsCreate
  • datarobot::CreateUserCleanupJobs
Users permanent delete.
POST /userCleanupJobs/
  • UserCleanupJobsDelete
  • datarobot::DeleteUserCleanupJobs
Cancel users perma-deletion.
DELETE /userCleanupJobs/{statusId}/
  • UserCleanupJobsRetrieve
  • datarobot::RetrieveUserCleanupJobs
Retrieve users perma-delete job status.
GET /userCleanupJobs/{statusId}/
  • UserCleanupPreviewJobsCreate
  • datarobot::CreateUserCleanupPreviewJobs
Users permanent delete preview.
POST /userCleanupPreviewJobs/
  • UserCleanupPreviewJobsDelete
  • datarobot::DeleteUserCleanupPreviewJobs
Cancel users perma-delete preview building.
DELETE /userCleanupPreviewJobs/{statusId}/
  • UserCleanupPreviewJobsRetrieve
  • datarobot::RetrieveUserCleanupPreviewJobs
Retrieve users perma-delete preview job status.
GET /userCleanupPreviewJobs/{statusId}/
  • UserCleanupPreviewsContentList
  • datarobot::ListUserCleanupPreviewsContent
Users permanent delete extended preview.
GET /userCleanupPreviews/{reportId}/content/
  • UserCleanupPreviewsDelete
  • datarobot::DeleteUserCleanupPreviews
Delete users permanent delete report.
DELETE /userCleanupPreviews/{reportId}/
  • UserCleanupPreviewsDeleteParamsList
  • datarobot::ListUserCleanupPreviewsDeleteParams
Users permanent delete report parameters.
GET /userCleanupPreviews/{reportId}/deleteParams/
  • UserCleanupPreviewsStatisticsList
  • datarobot::ListUserCleanupPreviewsStatistics
Users permanent delete preview statistics.
GET /userCleanupPreviews/{reportId}/statistics/
  • UserCleanupSummariesContentList
  • datarobot::ListUserCleanupSummariesContent
Users permanent delete extended summary.
GET /userCleanupSummaries/{reportId}/content/
  • UserCleanupSummariesDelete
  • datarobot::DeleteUserCleanupSummaries
Delete users permanent delete report.
DELETE /userCleanupSummaries/{reportId}/
  • UserCleanupSummariesDeleteParamsList
  • datarobot::ListUserCleanupSummariesDeleteParams
Users permanent delete report parameters.
GET /userCleanupSummaries/{reportId}/deleteParams/
  • UserCleanupSummariesStatisticsList
  • datarobot::ListUserCleanupSummariesStatistics
Users permanent delete summary statistics.
GET /userCleanupSummaries/{reportId}/statistics/
  • UsersCreate
  • datarobot::CreateUsers
Create a User and add them to an organisation.
POST /users/
  • UsersLimitsList
  • datarobot::ListUsersLimits
Get the rate limits and account limits for a user
GET /users/{userId}/limits/
  • UsersLimitsPatchMany
  • datarobot::PatchManyUsersLimits
Update the rate limits and account limits for a user
PATCH /users/{userId}/limits/

UtilitiesApi

Functions and Description HTTP request
  • StringEncryptionsCreate
  • datarobot::CreateStringEncryptions
Encrypt a string which DataRobot can decrypt.
POST /stringEncryptions/

Updated October 11, 2023