datarobot.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.
Batch Predictions
batchPredictionsCreate
batchPredictions.batchPredictionsCreate
Creates a new Batch Prediction job
Risk: write
batchPredictionsDelete
batchPredictions.batchPredictionsDelete
Cancel a Batch Prediction job by prediction job ID
Risk: destructive · Irreversible
Output: empty object
batchPredictionsFromExistingCreate
batchPredictions.batchPredictionsFromExistingCreate
Create a new a Batch Prediction job based
Risk: write
batchPredictionsFromJobDefinitionCreate
batchPredictions.batchPredictionsFromJobDefinitionCreate
Launch a Batch Prediction job
Risk: write
batchPredictionsList
batchPredictions.batchPredictionsList
List batch prediction jobs
Risk: read
Output
batchPredictionsRetrieve
batchPredictions.batchPredictionsRetrieve
Retrieve Batch Prediction job by prediction job ID
Risk: read
Output: empty object
Catalog Items
catalogItemsList
catalogItems.catalogItemsList
List all catalog items accessible by the user.
Risk: read
Output
catalogItemsRetrieve
catalogItems.catalogItemsRetrieve
Retrieves latest version information, by ID by catalog ID
Risk: read
Output: empty object
Credentials
credentialsCreate
credentials.credentialsCreate
Store a new set of credentials which can be used
Risk: write
credentialsDelete
credentials.credentialsDelete
Delete the credentials set by credential ID
Risk: destructive · Irreversible
Output: empty object
credentialsList
credentials.credentialsList
List credentials.
Risk: read
Output
credentialsRetrieve
credentials.credentialsRetrieve
Retrieve the credentials set by credential ID
Risk: read
Output: empty object
Custom Models
customModelsCreate
customModels.customModelsCreate
Create custom model.
Risk: write
customModelsDelete
customModels.customModelsDelete
Delete custom model by custom model ID
Risk: destructive · Irreversible
Output: empty object
customModelsList
customModels.customModelsList
List custom models.
Risk: read
Output
customModelsRetrieve
customModels.customModelsRetrieve
Get custom model by custom model ID
Risk: read
Output: empty object
customModelsVersionsCreate
customModels.customModelsVersionsCreate
Create custom model version by custom model ID
Risk: write
Output: empty object
customModelsVersionsList
customModels.customModelsVersionsList
List custom model versions by custom model ID
Risk: read
Output: empty object
Datasets
datasetsAllFeaturesDetailsList
datasets.datasetsAllFeaturesDetailsList
Get dataset features by dataset ID
Risk: read
Output: empty object
datasetsDelete
datasets.datasetsDelete
Delete dataset by dataset ID
Risk: destructive · Irreversible
Output: empty object
datasetsFeaturelistsList
datasets.datasetsFeaturelistsList
Retrieve dataset featurelists by dataset ID
Risk: read
Output: empty object
datasetsFileList
datasets.datasetsFileList
Retrieve original dataset data by dataset ID
Risk: read
Output: empty object
datasetsFromDataSourceCreate
datasets.datasetsFromDataSourceCreate
Create a dataset from a data source
Risk: write
datasetsFromFileCreate
datasets.datasetsFromFileCreate
Create a dataset from a file
Risk: write
datasetsFromURLCreate
datasets.datasetsFromURLCreate
Create a dataset from an URL
Risk: write
datasetsList
datasets.datasetsList
List datasets
Risk: read
Output
datasetsPatch
datasets.datasetsPatch
Modify dataset by dataset ID
Risk: write
Output: empty object
datasetsProjectsList
datasets.datasetsProjectsList
Get dataset projects by dataset ID
Risk: read
Output: empty object
datasetsRetrieve
datasets.datasetsRetrieve
Get dataset details by dataset ID
Risk: read
Output: empty object
datasetsVersionsDelete
datasets.datasetsVersionsDelete
Delete dataset version by dataset ID
Risk: destructive · Irreversible
Output: empty object
datasetsVersionsFromFileCreate
datasets.datasetsVersionsFromFileCreate
Create a version from a file
Risk: write
Output: empty object
datasetsVersionsFromURLCreate
datasets.datasetsVersionsFromURLCreate
Create a version from an URL
Risk: write
Output: empty object
datasetsVersionsList
datasets.datasetsVersionsList
List dataset versions by dataset ID
Risk: read
Output: empty object
datasetsVersionsRetrieve
datasets.datasetsVersionsRetrieve
Get dataset details by version by dataset ID
Risk: read
Output: empty object
Deployments
deploymentsAccuracyList
deployments.deploymentsAccuracyList
Retrieve accuracy metric by deployment ID
Risk: read
Output: empty object
deploymentsAccuracyOverTimeList
deployments.deploymentsAccuracyOverTimeList
Retrieve accuracy over time by deployment ID
Risk: read
Output: empty object
deploymentsCapabilitiesList
deployments.deploymentsCapabilitiesList
Retrieve capabilities by deployment ID
Risk: read
Output: empty object
deploymentsDelete
deployments.deploymentsDelete
Delete deployment by deployment ID
Risk: destructive · Irreversible
Output: empty object
deploymentsFeaturesList
deployments.deploymentsFeaturesList
Get deployment features by deployment ID
Risk: read
Output: empty object
deploymentsFromLearningModelCreate
deployments.deploymentsFromLearningModelCreate
Create deployment
Risk: write
deploymentsFromModelPackageCreate
deployments.deploymentsFromModelPackageCreate
Create a deployment from a model package
Risk: write
deploymentsList
deployments.deploymentsList
List deployments
Risk: read
Output
deploymentsModelHistoryList
deployments.deploymentsModelHistoryList
Retrieve champion model history of deployment by deployment ID
Risk: read
Output: empty object
deploymentsModelPatchMany
deployments.deploymentsModelPatchMany
Model Replacement by deployment ID
Risk: write
Output: empty object
deploymentsPatch
deployments.deploymentsPatch
Update deployment by deployment ID
Risk: write
Output: empty object
deploymentsPredictionsOverTimeList
deployments.deploymentsPredictionsOverTimeList
Retrieve metrics about predictions over time by deployment ID
Risk: read
Output: empty object
deploymentsRetrieve
deployments.deploymentsRetrieve
Retrieve deployment by deployment ID
Risk: read
Output: empty object
deploymentsServiceStatsList
deployments.deploymentsServiceStatsList
Retrieve service stats by ID
Risk: read
Output: empty object
deploymentsSettingsList
deployments.deploymentsSettingsList
Retrieve deployment settings by deployment ID
Risk: read
Output: empty object
deploymentsSettingsPatchMany
deployments.deploymentsSettingsPatchMany
Update deployment settings by deployment ID
Risk: write
Output: empty object
deploymentsSharedRolesList
deployments.deploymentsSharedRolesList
Get the model deployment access control list by deployment ID
Risk: read
Output: empty object
Model Packages
modelPackagesFeaturesList
modelPackages.modelPackagesFeaturesList
Retrieve feature list by model package ID
Risk: read
Output: empty object
modelPackagesFromLeaderboardCreate
modelPackages.modelPackagesFromLeaderboardCreate
Create model package
Risk: write
modelPackagesList
modelPackages.modelPackagesList
List model packages
Risk: read
Output
modelPackagesRetrieve
modelPackages.modelPackagesRetrieve
Retrieve info about a model package by model package ID
Risk: read
Output: empty object
Prediction Servers
predictionServersList
predictionServers.predictionServersList
List prediction servers.
Risk: read
Output
Projects
configureAndStartAutopilot
projects.configureAndStartAutopilot
Start modeling by project ID
Risk: write
Output: empty object
projectsAccessControlList
projects.projectsAccessControlList
Get the project access control list by project ID
Risk: read
Output: empty object
projectsAutopilotCreate
projects.projectsAutopilotCreate
Pause by project ID
Risk: write
Output: empty object
projectsAutopilotsCreate
projects.projectsAutopilotsCreate
Start autopilot by project ID
Risk: write
Output: empty object
projectsBlueprintsList
projects.projectsBlueprintsList
List blueprints by project ID
Risk: read
Output: empty object
projectsBlueprintsRetrieve
projects.projectsBlueprintsRetrieve
Retrieve a blueprint by its ID.
Risk: read
Output: empty object
projectsCreate
projects.projectsCreate
Create a project.
Risk: write
projectsDatetimeModelsList
projects.projectsDatetimeModelsList
List datetime partitioned project models by project ID
Risk: read
Output: empty object
projectsDelete
projects.projectsDelete
Delete a project by project ID
Risk: destructive · Irreversible
Output: empty object
projectsDeploymentReadyModelsCreate
projects.projectsDeploymentReadyModelsCreate
Prepare a model by project ID
Risk: write
Output: empty object
projectsFeaturelistsCreate
projects.projectsFeaturelistsCreate
Create a new featurelist by project ID
Risk: write
Output: empty object
projectsFeaturelistsDelete
projects.projectsFeaturelistsDelete
Delete a specified featurelist by project ID
Risk: destructive · Irreversible
Output: empty object
projectsFeaturelistsList
projects.projectsFeaturelistsList
List featurelists by project ID
Risk: read
Output: empty object
projectsFeaturelistsPatch
projects.projectsFeaturelistsPatch
Update an existing featurelist by project ID
Risk: write
Output: empty object
projectsFeaturelistsRetrieve
projects.projectsFeaturelistsRetrieve
Retrieve a feature list by project ID
Risk: read
Output: empty object
projectsFeaturesList
projects.projectsFeaturesList
List project features by project ID
Risk: read
Output: empty object
projectsFeaturesRetrieve
projects.projectsFeaturesRetrieve
Get a project feature by project ID
Risk: read
Output: empty object
projectsJobsDelete
projects.projectsJobsDelete
Cancel a job by project ID
Risk: destructive · Irreversible
Output: empty object
projectsJobsList
projects.projectsJobsList
List project jobs by project ID
Risk: read
Output: empty object
projectsJobsRetrieve
projects.projectsJobsRetrieve
Get a job by project ID
Risk: read
Output: empty object
projectsList
projects.projectsList
List projects.
Risk: read
Output
projectsModelingFeaturelistsCreate
projects.projectsModelingFeaturelistsCreate
Create a new modeling featurelist by project ID
Risk: write
Output: empty object
projectsModelingFeaturelistsList
projects.projectsModelingFeaturelistsList
List all modeling featurelists by project ID
Risk: read
Output: empty object
projectsModelsCreate
projects.projectsModelsCreate
Train a new model by project ID
Risk: write
Output: empty object
projectsModelsDelete
projects.projectsModelsDelete
Delete a model by project ID
Risk: destructive · Irreversible
Output: empty object
projectsModelsFromModelCreate
projects.projectsModelsFromModelCreate
Retrain a model by project ID
Risk: write
Output: empty object
projectsModelsList
projects.projectsModelsList
List project models by project ID
Risk: read
Output: empty object
projectsModelsRetrieve
projects.projectsModelsRetrieve
Get model by project ID
Risk: read
Output: empty object
projectsPatch
projects.projectsPatch
Update a project by project ID
Risk: write
Output: empty object
projectsPredictionDatasetsDelete
projects.projectsPredictionDatasetsDelete
Delete a dataset that was uploaded by project ID
Risk: destructive · Irreversible
Output: empty object
projectsPredictionDatasetsList
projects.projectsPredictionDatasetsList
List prediction datasets uploaded by project ID
Risk: read
Output: empty object
projectsPredictionDatasetsRetrieve
projects.projectsPredictionDatasetsRetrieve
Get the metadata of a specific dataset by project ID
Risk: read
Output: empty object
projectsPredictionsCreate
projects.projectsPredictionsCreate
Make new predictions by project ID
Risk: write
Output: empty object
projectsPredictionsList
projects.projectsPredictionsList
Get the list of prediction records by project ID
Risk: read
Output: empty object
projectsPredictionsRetrieve
projects.projectsPredictionsRetrieve
Get a completed set of predictions by project ID
Risk: read
Output: empty object
projectsRecommendedModelsList
projects.projectsRecommendedModelsList
List recommended models by project ID
Risk: read
Output: empty object
projectsRetrieve
projects.projectsRetrieve
Get project by project ID
Risk: read
Output: empty object
projectsStatusList
projects.projectsStatusList
Check project status by project ID
Risk: read
Output: empty object
projectsTrainingPredictionsCreate
projects.projectsTrainingPredictionsCreate
Submits a job by project ID
Risk: write
Output: empty object
trainingPredictionsList
projects.trainingPredictionsList
List training prediction jobs by project ID
Risk: read
Output: empty object
Status
statusList
status.statusList
List tasks
Risk: read
Output
statusRetrieve
status.statusRetrieve
Get task status by status ID
Risk: read
Output: empty object
Use Cases
useCasesCreate
useCases.useCasesCreate
Get a use case.
Risk: write
useCasesDatasetsList
useCases.useCasesDatasetsList
Get the list of the datasets associated by use case ID
Risk: read
Output: empty object
useCasesDelete
useCases.useCasesDelete
Delete a Use Case by use case ID
Risk: destructive · Irreversible
Output: empty object
useCasesDeploymentsList
useCases.useCasesDeploymentsList
Get the deployments associated by use case ID
Risk: read
Output: empty object
useCasesList
useCases.useCasesList
Retrieve the list of use cases.
Risk: read
Output
useCasesPatch
useCases.useCasesPatch
Update a Use Case by use case ID
Risk: write
Output: empty object
useCasesProjectsList
useCases.useCasesProjectsList
Get the list of the projects associated by use case ID
Risk: read
Output: empty object
useCasesRetrieve
useCases.useCasesRetrieve
Get a use case by use case ID
Risk: read
Output: empty object
Version
versionList
version.versionList
Retrieve version information.
Risk: read