DataRobot integration: operations for AI agents
DataRobot connects to Type.com as an integration. This page lists the 1718 operations documented for Claude and Codex in Type.com: 911 read, 594 write, 213 destructive.
About DataRobot
DataRobot is a machine learning platform that automates model building, deployment, and monitoring, enabling organizations to derive predictive insights from large datasets
Categories: Analytics & Data
How to connect DataRobot to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
1718 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
1718 operations listed.
Agentic memory
- Read
List Memory Spaces
List all Memory Spaces accessible by the authenticated user Covers spaces the user created and spaces shared with them, each carrying the permissions the caller holds on it. Returns offset/limit pagination with a total count.
- Read
Get Memory Space by memoryspace ID
Get a Memory Space by ID Covers spaces the caller created and spaces shared with them, carrying the permissions the caller holds on it. Returns 404 if the space does not exist, is soft-deleted, belongs to another tenant, or is not shared with the caller.
- Read
List Sessions by memoryspace ID
List Sessions by memoryspace ID
- Read
Get Session by memoryspace ID
Get a single session by ID
- Read
List Events by memoryspace ID
List Events by memoryspace ID
- Read
Get All Memories V1 by memoryspace ID
Retrieve all memories matching the given identity filters (v1 query-param interface).
- Read
Search Memories V1 by memoryspace ID
Search memories by semantic similarity to a query string.
- Read
Get Memory by memoryspace ID
Retrieve a single memory by its ID. Returns null if the memory does not exist.
- Read
Get Memory History by memoryspace ID
Retrieve the mutation history (audit trail) for a single memory.
- Read
Ping by memoryspace ID
Health check endpoint returning fake user context for mem0.MemoryClient compatibility.
- Read
Get All Memories V2 by memoryspace ID
Retrieve all memories matching the given filters. At least one of userid, agentid, or runid is required (as enforced by mem0's AsyncMemory)
- Read
Search Memories V2 by memoryspace ID
Search memories by semantic similarity to a query string. At least one of userid, agentid, or runid is required to scope the search.
- Write
Create Memory Space
Create a new Memory Space tenantid is bound from the authenticated user's context; clients cannot set or override it.
- Write
Update Memory Space by memoryspace ID
Partially update a Memory Space
- Write
Create Session by memoryspace ID
Create Session by memoryspace ID
- Write
Update Session by memoryspace ID
Patch a session with new description, metadata and/or lifecycle strategies. Only fields explicitly included in the request body are modified others remain untouched. lifecycleStrategies, when present, replaces the whole list.
- Write
Create Event by memoryspace ID
Create Event by memoryspace ID
- Write
Create Events Batch by memoryspace ID
Append up to MAXBATCHSIZE events to a session atomically.
- Write
Update Events Batch by memoryspace ID
Update up to MAXBATCHSIZE events atomically; any failure rolls back the batch.
- Write
Update Event by memoryspace ID
Update Event by memoryspace ID
- Write
Post Memories by memoryspace ID
Extract facts from a conversation and persist them as memories.
- Write
Reset Memories by memoryspace ID
Delete all memories in the current memory space.
- Write
Create memories by ID
Retrieve all memories matching the given filters. At least one of userid, agentid, or runid is required (as enforced by mem0's AsyncMemory)
- Write
Create add by ID
Extract facts from a conversation and persist them as memories.
- Write
Create search by ID
Search memories by semantic similarity to a query string. At least one of userid, agentid, or runid is required to scope the search.
- Destructive
Delete Memory Space by memoryspace ID
Delete a Memory Space Returns 404 if already deleted or not accessible by the caller, and 403 if the space is shared with them under a role that cannot delete it. Sharing grants are revoked asynchronously by the RBAC reconciliation worker.
- Destructive
Delete Session by memoryspace ID
Delete a session. Performs a soft-delete by setting the deletedat timestamp.
- Destructive
Delete Event by memoryspace ID
Soft-delete one session event by sequence id.
- Destructive
Delete All Memories by memoryspace ID
Delete all memories matching the given filter. At least one filter param is required to prevent accidental deletion of all memories across all identities.
- Destructive
Put Memory by memoryspace ID
Replace the text of an existing memory. Returns 404 if the memory does not exist. Returns 409 if the memory is immutable.
- Destructive
Delete Memory by memoryspace ID
Delete a single memory by its ID.
User management
- Read
Retrieve a list of access roles.
Retrieve all access roles that the user has access to, optionally filtering by global access roles.
- Read
Retrieve an access role by role ID
Retrieve details about an access role.
- Read
Retrieve a list of the users using this access role by role ID
Retrieve all users that have this access role assigned to them, any of their groups, or their organization.
- Read
Retrieve rate limit resource usage.
Return the rate limit usage for the user making this request. There is one entry per rate limit applied to the user.
- Read
Search the directory.
Search directory entities by name within the caller's organization. Currently supports groups only, with exact (case-sensitive) name matching. The name parameter is optional - omitting it returns all groups in the organization, paginated.
- Read
List user groups.
List the user groups that satisfy the query condition.
- Read
Retrieve a user group by group ID
Retrieve the user group.
- Read
List users by group ID
List users in the group.
- Read
Retrieve inactive account policy configuration by organization ID
Retrieve inactive account policy configuration for a specific organization.
- Read
List organizations.
List organizations available in the system.
- Read
Retrieve an organization by organization ID
Retrieve the organization details.
- Read
List organization jobs by organization ID
List currently running jobs belonging to this organization.
- Read
List organization users by organization ID
List memberships in this organization.
- Read
Retrieve a user by organization ID
Retrieve the user from this organization.
- Read
List groups managed by an identity provider by org ID
List SCIM-managed groups in an organization, with pagination and filtering.
- Read
Fetch a group managed by an identity provider by org ID
Retrieve a SCIM-managed group from an organization by its ID.
- Read
List supported SCIM resource types by org ID
List the SCIM resource types (User and Group) supported by this service provider.
- Read
Retrieve a SCIM resource type by name by org ID
Retrieve the schema and endpoint details for a single SCIM resource type.
- Read
List supported SCIM schemas by org ID
List the SCIM schema definitions (User and Group) supported by this service provider.
- Read
Retrieve SCIM service provider capabilities by org ID
Retrieve the features and configuration options supported by the SCIM service provider, per RFC 7643.
- Read
List users managed by an identity provider by org ID
List SCIM-managed users in an organization, with pagination and filtering.
- Read
Fetch a user managed by an identity provider by org ID
Retrieve a SCIM-managed user from an organization by its ID.
- Read
Retrieve SCIM configuration by org ID
Retrieve the current SCIM provisioning configuration for an organization.
- Read
Get usage resources
A unified route to retrieve aggregated resource usage over some period of time. For OrgAdmins, tenantid is required. For SystemAdmins, tenantid is optional. If tenantid is omitted for SystemAdmins, returns usage for all tenants.
- Read
Get active tenants
A route to retrieve active tenants over a specified time period. Only admins can perform this operation.
- Read
Get active users
A unified route to retrieve active users over a specified time period. For OrgAdmins, tenantid is required. For SystemAdmins, tenantid is optional. If tenantid is omitted for SystemAdmins with feature flag, returns all users in the cluster.
- Read
Get the available resource categories.
A route to retrieve available resource categories for tenant usage.
- Read
Get usage resources grouped by deployment ID.
Returns CPU and GPU usage grouped by deploymentid. For OrgAdmins, tenantid is required. For SystemAdmins, tenantid is optional. Returns HTTP 400 if deploymentid tracking is not enabled for the tenant.
- Read
Export usage
A unified route to export resource usage over a specified time period. For OrgAdmins, tenantid is required. For SystemAdmins, tenantid is optional. If tenantid is omitted for SystemAdmins, returns usage for all tenants. If tenantid is provided, returns usage only for that tenant.
- Read
Get daily usage over time
Returns daily peak usage values for gauge-based metrics (Agentic Spans, Storage). Each data point includes the date, peak usage for that day, estimated cost, and whether the day is the monthly high watermark.
- Read
Get CPU/GPU resource utilization.
A route to retrieve aggregated CPU/GPU resources utilization for certain resource type.
- Read
Export CPU/GPU resource utilization.
A route to retrieve aggregated CPU and GPU resources utilization.
- Read
Get CPU/GPU resource utilization by resourcetype
A route to retrieve aggregated CPU/GPU resources utilization for certain resource type.
- Read
Get tenant active users by tenant ID
DEPRECATED: This endpoint is deprecated. Use /activeUsers/ instead. A route to retrieve active tenant users over a specified time period. Only system or organization admins can perform this operation.
- Read
Get the available resource categories by tenant ID
A route to retrieve available resource categories for tenant usage.
- Read
Get tenant usage by tenant ID
DEPRECATED: This endpoint is deprecated. Use /tenantUsageResources/ instead. A route to retrieve aggregated or per-user tenant resource usage over some period of time. Only system or organization admins can perform this operation.
- Read
Export tenant usage by tenant ID
DEPRECATED: This endpoint is deprecated. Use /usageExport/ instead. A route to retrieve tenant resource usage over a specified time period. Only system or organization admins can perform this operation.
- Read
Retrieve users perma-delete job status by status ID
Get async status of the users perma-delete job.
- Read
Retrieve users perma-delete preview job status by status ID
Get async status of the users perma-delete preview building job.
- Read
Users permanent delete extended preview by report ID
Retrieve users permanent delete extended preview.
- Read
Users permanent delete report parameters by report ID
Retrieve users permanent delete report parameters.
- Read
Users permanent delete preview statistics by report ID
Retrieve users permanent delete preview statistics.
- Read
Users permanent delete extended summary by report ID
Retrieve users permanent delete extended summary.
- Read
Retrieve delete params by ID
Retrieve users permanent delete report parameters.
- Read
Users permanent delete summary statistics by report ID
Retrieve users permanent delete summary statistics.
- Read
Retrieve a list of existing users.
Retrieve a list of existing users.
- Read
Retrieve a single user by id by user ID
Retrieve a single user by id.
- Write
Create a new custom access role.
Create a new access role with custom permissions and associate it with a particular organization.
- Write
Update a custom access role by role ID
Update the name or permissions of a custom access role.
- Write
Make multiple User creation requests in bulk
Make multiple User creation requests in bulk from a list.
- Write
Create a user group.
Create a new user group.
- Write
Update a user group by group ID
Update the user group.
- Write
Add users by group ID
Add users to the group.
- Write
Create inactive account policy configuration by organization ID
Create inactive account policy configuration for a specific organization.
- Write
Update inactive account policy configuration by organization ID
Partially update inactive account policy configuration for a specific organization.
- Write
Add user by organization ID
Add user to an existing organization. A user can only be part of one organization.
- Write
Patch an organization user by organization ID
Patch organization's user. Only system or the organization admin can perform this operation.
- Write
Provision a new group by org ID
Create a new SCIM-managed group in an organization, optionally with initial members.
- Write
Incremental group update by org ID
Apply incremental membership and displayName updates to a SCIM-managed group.
- Write
Provision a new user by org ID
Create a new SCIM-managed user in an organization.
- Write
Apply incremental updates by org ID
Apply incremental attribute updates to a SCIM-managed user from an identity provider.
- Write
Users permanent delete.
Schedules a job which permanently delete the users represented by the provided users ids or organization id. Number of users to be deleted in one go is restricted by DELETEDUSERSBATCHLIMIT system setting.
- Write
Users permanent delete preview.
Schedules a job for building preview for users selected for permanent deletion. Number of users to be deleted in one go is restricted by DELETEDUSERSBATCHLIMIT system setting.
- Write
Create a User and add them
Create a User and add them to an organization.
- Write
Invite multiple users by email
Invite multiple users by email to join the platform. Users can have non-builder or regular roles.Resources can be specified to be shared with the invited users upon acceptance of the invite.
- Destructive
Delete a custom access role by role ID
Delete a custom access role and remove it from any users, groups, or organizations it was assigned to.
- Destructive
Delete multiple user groups.
Delete the user groups.
- Destructive
Delete a user group by group ID
Delete the user group.
- Destructive
Remove users by group ID
Remove users from the group.
- Destructive
Delete inactive account policy configuration by organization ID
Delete inactive account policy configuration for a specific organization.
- Destructive
Full group replacement by org ID
Replace a SCIM-managed group's displayName and, optionally, its full membership.
- Destructive
Deprovision a group managed by an identity provider by org ID
Delete a SCIM-managed group from an organization.
- Destructive
Replace all SCIM-managed attributes of a user by org ID
Replace all SCIM-managed attributes of a user in a single request.
- Destructive
Deprovision a user managed by an identity provider by org ID
Deactivate a SCIM-managed user from an organization (soft delete).
- Destructive
Replace SCIM configuration by org ID
Enable, disable, or reconfigure SCIM provisioning for an organization.
- Destructive
Cancel users perma-deletion by status ID
Cancel permanent deletion of the selected users.
- Destructive
Cancel users perma-delete preview building by status ID
Cancel scheduled users permanent delete preview building.
- Destructive
Delete users permanent delete report by report ID
Delete users permanent delete report.
- Destructive
Delete user cleanup summaries by ID
Delete users permanent delete report.
Data connectivity
- Read
List all ACL management connections.
A list of all ACL management connections for the user organization.
- Read
List drivers
Fetch all drivers a user has access to.
- Read
Retrieve driver details by driver ID
Retrieve driver details by ID.
- Read
Driver configuration details by driver ID
Retrieve the driver configuration with the specified ID.
- Read
List data sources.
Return the detailed list of available data sources.
- Read
Data source details by data source ID
Return the details of the existing data source with the given ID, including SQL query or selected table and schema data, which fully describe which data to extract and from which location.
- Read
Get the data source's access control list by data source ID
Get a list of users, groups and organizations who have access to this data source and their roles.
- Read
Describe data source permissions by data source ID
Describe what permissions current user has for given data source.
- Read
List data stores.
Return the list with details of the existing data stores available for the user.
- Read
Data store details by data store ID
A configured connection to a database; it has a name and a specified driver. The driver may be specified by a JDBC URL or connection parameters if the driver was created with the parameter configuration.
- Read
List credentials associated by data store ID
Returns a list of credentials associated with the specified data store.
- Read
Describe data store permissions by data store ID
Describe what permissions current user has for given data store.
- Read
Retrieve detected standard user-defined functions by data store ID
Retrieve detected standard user-defined functions. Raise a 404 error if detection needs to be run first. Results might not be up-to-date; run detection with the force=True option to refresh them.
- Read
List available driver configurations.
Retrieve matching driver configurations based on query.
- Read
Driver configuration details by configuration ID
Retrieve the driver configuration with the specified ID.
- Read
Preview data
Execute SQL against the selected JDBC URL and return a row-limited preview. Specify credentials and connection parameters in the JDBC URL and/or in the parameters field.
- Write
Create a data stage
Create a data stage.
- Write
Finalize a data stage by data stage ID
Finalize a data stage.
- Write
Upload JDBC driver
Upload JDBC driver from file. Only Java archive (.jar) files are supported.
- Write
Create a new JDBC driver.
Create a new JDBC driver. To create connections from fields, rather than supplying a JDBC URL, use 'configurationId'. When using 'configurationId', do not include 'canonicalName' or 'className' as they are part of the driver configuration.
- Write
Update properties of an existing JDBC Driver by driver ID
Update properties of an existing JDBC driver. To change the canonicalName and className, you must first remove the driver configuration, if it exists, as its properties will otherwise override name changes.
- Write
Create a data source.
Create a fully configured source of data which could be used for datasets and projects creation.
- Write
Update the data source by data source ID
Update the data source with given ID. To test the SQL query before updating the data source,use :http:post:/api/v2/externalDataStores/(dataStoreId)/verifySQL/.
- Write
Update the data source's access controls by data source ID
Set roles for users on this data source. Note that when granting access to a data source, access to the corresponding data store as a "CONSUMER" will also be granted.
- Write
Create a data store.
Create a data store which includes a name and a driver ID or a connector ID. The driver would be configured by a JDBC URL or by jdbc fields; the connector would be configured by connection fields.
- Write
Update a data store configuration by data store ID
Update a data store configuration.
- Write
Update the data store's access controls by data store ID
Set roles for users on this data store.
- Write
Retrieves a data store's data columns by data store ID
Retrieves a data store's data columns.
- Write
Retrieves a data store's column metadata by data store ID
Retrieves a data store's column metadata.
- Write
Retrieves a data store's data schemas by data store ID
Retrieves a data store's data schemas.
- Write
Start a job to create a standard user-defined function of the given type by data store ID
Start the creation of the standard user-defined function. Since this is an asynchronous process, this endpoint returns a status ID to use with the status endpoint as well as a location header that includes URL that can be polled for status.
- Write
Start the job that detects standard user-defined functions for the given data store, credentials by data store ID
Start the detection process for the standard user-defined functions. Since this is an asynchronous process this endpoint returns a status ID to use with the status endpoint as well as a location header that includes the URL that can be polled for status.
- Write
Retrieves a data store's database tables (including views) by data store ID
Retrieves a data store's database tables (including views).
- Write
Test data store connection by data store ID
Test the ability to connect to a data store with specified authentication.
- Write
Verify a SQL query by data store ID
Execute the SQL query on the data store, returning a small number of rows (max 999). Use this for quick query execution validation and exploring results, not for capturing an entire result set.
- Write
Execute SQL against a JDBC URL (DDL/DML, procedures).
Run a SQL statement that updates data or schema against the given JDBC URL. Specify credentials and connection parameters in the JDBC URL and/or in the parameters field. This does not return a data preview; use the JDBC data preview endpoint to fetch row-limited SELECT results.
- Destructive
Define the connection as ACL management.
Create or update the ACL management connection. Default credentials must be defined for the data store in advance.
- Destructive
Deactivate ACL management by data store ID
DELETE /api/v2/aclConnections/{dataStoreId}/
- Destructive
Upload a part by data stage ID
Upload a part to the data stage.
- Destructive
Delete the driver by driver ID
Delete the driver with given ID if it is not used by any data store or data source.
- Destructive
Delete the data source by data source ID
Delete the data source with given ID if it is not used by any dataset.
- Destructive
Delete the data store by data store ID
Delete the data store with given ID if it is not used by any data source.
Analytics
- Read
Retrieve user-friendly descriptions
Retrieve user-friendly descriptions for user activity events (application and admin). The CANACCESSUSERACTIVITY permission (or org admin access to Event Logs) is required.
- Read
Retrieve one page of audit log records.
Retrieve one page of audit log records.
- Read
Retrieve all the available events
Retrieve all the available events. DEPRECATED API.
- Read
Retrieve prediction usage data.
Retrieve prediction usage data. The CANACCESSUSERACTIVITY permission is required.
- Read
Get the audit record by ID by record ID
Get the audit record by ID.
- Read
Describe supported available audit events with
Describe supported available audit events with which to filter result data.
- Read
Retrieve a prepared customer usage data artifact by artifact ID
Retrieve a prepared customer usage data artifact. Requires "CANACCESSUSERACTIVITY" permission.
- Read
List resource usage by user ID
List the rate limit resource usage for a user. The usage array returned will have one object corresponding to each rate limit applied to the user.
- Write
Create a customer usage data artifact request
Create a customer usage data artifact request. Requires "CANACCESSUSERACTIVITY" permission. Returns async task status URL as a "Location" header. The async task status should be polled in order to retrieve the artifact ID.
- Destructive
Reset resource usage by user ID
Reset specified user's rate limit resource usage to zero for all resources. When windows roll over, all limits are automatically reset. Use this route to reset usage sooner.
- Destructive
Delete rate limit usage by ID
Reset rate limit resource usage for a user of a specified resource to zero. This will happen automatically when windows roll over. This route can be used to reset a user's rate limits sooner.
Agent cards
- Read
List registered agent cards.
Retrieve the list of agent cards within tenant.
Application templates
- Read
List the application templates the user has access to.
List the application templates the user has access to.
- Read
Retrieve an application template image by application template ID
Retrieve an application template image.
- Read
Get the resolved clone URL by application template ID
Get the resolved clone URL for an application template repository.
- Write
Create an application template.
Create an application template.
- Write
Update an application template by application template ID
Update an application template.
- Write
Clone an application template into a codespace by application template ID
Clone an application template into a codespace.
- Write
Upload an application template image/gif. by application template ID
Upload an application template image/gif.
- Destructive
Delete an application template by application template ID
Delete an application template.
- Destructive
Delete an application template image/gif. by application template ID
Delete an application template image/gif.
No code applications
- Read
Paginated list of applications created by the currently authenticated user.
Paginated list of applications created by the currently authenticated user.
- Read
Retrieve an application by application ID
Retrieve an application
- Read
A list of users with access by application ID
A list of users who have access to this application and their roles
- Read
Get application user role by application ID
Get application user role
- Read
Retrieve available code snippets.
Retrieve a list of available code snippets for the given parameters.
- Read
Retrieve a code snippet.
Retrieve a code snippet to be displayed in the UI.
- Write
Create an application
Create an application. Note that the number of active applications users can have at the same time is limited.
- Write
Verify ability
Verifies a user can create an app
- Write
Update an application's name and/ by application ID
Update an application's name and/or description
- Write
Update access control by application ID
Update access control for this application. Request is processed only if updates can be performed on all entries.
- Write
Links a deployment by application ID
If application creates deployment during its lifetime, we want to have an API to link deployment with application.
- Write
Create a duplicate of the application by application ID
Create a copy of App Builder application. Note that the number of active applications users can have at the same time is limited.
- Write
Create download (nocodeapplications)
Retrieve a code snippet to be displayed in the UI.
- Destructive
Delete an application by application ID
Delete an application
- Destructive
Delete link between application by application ID
Delete link between application and deployment.
Approval workflows
- Read
List Approval Policies.
List Approval Policies.
- Read
Retrieve an Approval Policy by approval policy ID
Retrieve the policy with the given ID.
- Read
Get policy ID matching the query
Get policy ID matching the query
- Read
Get a list of available policy triggers.
Get a list of available policy triggers.
- Read
List Change Requests.
List all Change Requests accessible by the user for the given product entity type.
- Read
Retrieve Change Request by change request ID
Retrieve Change Request by ID.
- Read
List Change Request reviews by change request ID
List Change Request reviews.
- Read
Retrieve review by change request ID
Retrieve a review by ID.
- Read
List suggested reviewers by change request ID
List users, suggested to review the Change Request.
- Read
Retrieve configured recommended settings by entitytype
Retrieve configured recommended settings for an entity.
- Read
Retrieve the list of available setting choices by entitytype
Retrieve the list of available setting choices for an entity.
- Write
Create a new Approval Policy.
Create a new Approval Policy.
- Write
Create Change Request.
Request changes for a supported product entity. For now, you can request changes for deployments only.
- Write
Update Change Request by change request ID
Update Change Request with the given ID.
- Write
Request Change Request Review by change request ID
Request review for Change Request with the given ID.
- Write
Create review by change request ID
Review the Change Request.
- Write
Resolve by change request ID
Resolve or Cancel the Change Request.
- Destructive
Update an Approval Policy by approval policy ID
Update the policy with the given ID.
- Destructive
Delete an Approval Policy by approval policy ID
Delete the policy with the given ID.
- Destructive
Update recommended settings by entitytype
Update recommended settings for an entity.
Artifacts
- Read
Get Artifact Repositories
Returns the list of artifact repositories.
- Read
Get Artifact Repository by artifactrepository ID
Get a specific artifact repository by ID.
- Read
Get Artifacts
List all artifacts accessible to the authenticated user.
- Read
Get Artifact by artifact ID
Get a specific artifact by ID.
- Read
Get Artifact Build List by artifact ID
Get Artifact Build List by artifact ID
- Read
Get Artifact Build by artifact ID
Get Artifact Build by artifact ID
- Write
Create Artifact
Create a new artifact from the provided container specification. Artifacts are always created as drafts.
- Write
Patch Artifact by artifact ID
Partially update an artifact. Only the provided fields will be updated.
- Write
Trigger Artifact Build by artifact ID
Start image build(s) for a draft service artifact (codeRef). Locked artifacts are rejected.
- Write
Clone Artifact by artifact ID
Clone an existing artifact. Creates a new artifact with the same fields as the original.
- Destructive
Delete Artifact Repository by artifactrepository ID
Delete an artifact repository. Artifacts within the repository are cascade-deleted unless they are locked or still in use by workloads.
- Destructive
Update Artifact by artifact ID
Update an existing artifact. Replaces all artifact fields with the provided values. For partial updates, use the PATCH endpoint instead.
- Destructive
Delete Artifact by artifact ID
Delete an artifact. Locked artifacts and artifacts with associated protons cannot be deleted.
- Destructive
Delete Artifact Build by artifact ID
Request cancellation/deletion of an image build for a draft artifact (immutable when locked).
Compliance documentation
- Read
List all available document types
Check which document types and locales are available for generation with your account.
- Read
List all generated documents.
Get information about all previously generated documents available for your account. The information includes document ID and type, ID of the entity it was generated for, time of creation, and other information. Example request to get a list of all documents: ..
- Read
Download generated document by document ID
Download a generated Automated Documentation file. .. code-block:: text GET https://app.datarobot.com/api/v2/automatedDocuments/5ec4ea7e41054c158c5b002f/ HTTP/1.1 Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4 In response, you will get a file containing the generated doc…
- Read
List compliance documentation templates
List user's custom-built compliance documentation templates.
- Read
Retrieve the default documentation template
Retrieve the default documentation template.
- Read
Retrieve a documentation template by template ID
Retrieve a JSON representation of a custom Compliance Documentation template.
- Read
Check if compliance documentation pre-processing is initialized by entity ID
Check if compliance documentation pre-processing is initialized for the current model. This is only required for custom models.
- Write
Request generation of automated document
Request generation of an automated document that's available for your account. Below is an example request body to generate Model Compliance documentation: ..
- Write
Create a new compliance documentation template
Create a new compliance documentation template. One can retrieve the default DataRobot template via GET /api/v2/complianceDocTemplates/default/ endpoint.
- Write
Update an existing model compliance documentation template by template ID
Update an existing model compliance documentation template with the given templateId. The template must be accessible by the user. If the templateId is not found for the user, the update cannot be performed.
- Write
Initialize compliance documentation pre-processing by entity ID
Initialize compliance documentation pre-processing for the current model. This route must be called before generating documentation for a custom model.
- Destructive
Delete automated document by document ID
Delete a document using its ID. Example request: .. code-block:: text DELETE https://app.datarobot.com/api/v2/automatedDocuments/5ec4ea7e41054c158c5b002f/ HTTP/1.1 Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4
- Destructive
Delete a compliance documentation template by template ID
Delete a compliance documentation template. Documentation previously generated using this template will remain unchanged.
Batch predictions
- Read
List batch jobs
Get a collection of batch jobs by statuses
- Read
Retrieve Batch job by batch job ID
Retrieve a Batch job.
- Read
Download the scored data set of a batch job by batch job ID
This is only valid for jobs scored using the "localFile" output option
- Read
List Batch Prediction job definitions
List all Batch Prediction jobs definitions available
- Read
Retrieve Batch Prediction job definition by job definition ID
Retrieve a Batch Prediction job definition
- Read
Retrieve job definition snippet by job definition ID
Retrieve a Batch Prediction job definition for Portable Batch Predictions
- Read
List batch prediction jobs
Get a collection of batch prediction jobs by statuses
- Read
Retrieve Batch Prediction job by prediction job ID
Retrieve a Batch Prediction job.
- Read
Download the scored data set of a batch prediction job by prediction job ID
This is only valid for jobs scored using the "localFile" output option
- Read
Retrieve the current PredictionExplanationsInitialization by project ID
Retrieve the current PredictionExplanationsInitialization. A PredictionExplanationsInitialization is a pre-requisite for successfully computing prediction explanations using a particular model, and can be used to preview the prediction explanations that would be generated for a…
- Read
List all prediction jobs by project ID
List all prediction jobs for a project.
- Read
Look up a particular prediction job by project ID
Look up a particular prediction job.
- Read
List prediction datasets uploaded by project ID
List prediction datasets uploaded to a project.
- Read
Get the metadata of a specific dataset by project ID
Get the metadata of a specific dataset. This only works for datasets uploaded to an existing project for prediction.
- Read
Retrieve stored Prediction Explanations by project ID
Retrieve stored Prediction Explanations. Each PredictionExplanationsRow retrieved corresponds to a row of the prediction dataset, although some rows may not have had prediction explanations computed depending on the thresholds selected.
- Read
List PredictionExplanationsRecord objects by project ID
List PredictionExplanationsRecord objects for a project. These contain metadata about the computed prediction explanations and the location at which the PredictionExplanations can be retrieved.
- Read
Retrieve a PredictionExplanationsRecord object by project ID
Retrieve a PredictionExplanationsRecord object. A PredictionExplanationsRecord contains metadata about the computed prediction explanations and the location at which the PredictionExplanations can be retrieved.
- Read
Get the list of prediction records by project ID
Get a list of prediction records. .. deprecated:: v2.21 Use :http:get:/api/v2/projects/(projectId)/predictionsMetadata/ instead. The only difference is that parameter datasetId is renamed to predictionDatasetId both in request and response.
- Read
Get a completed set of predictions by project ID
Retrieve predictions that have previously been computed. Training predictions encoded either as JSON or CSV. If CSV output was requested, the returned CSV data will contain the following columns: For regression projects: rowid and prediction.
- Read
Get the list of prediction metadata records by project ID
Use the ID of a metadata object to get the complete set of predictions.
- Read
Retrieve metadata by project ID
Use the ID of a metadata object to get the complete set of predictions.
- Read
List training prediction jobs by project ID
Get a list of training prediction records
- Read
Retrieve training predictions by project ID
Retrieve training predictions that have previously been computed
- Read
List scheduled deployment batch prediction jobs a user can view
Get a list of scheduled batch prediction jobs a user can view
- Write
Launch a Batch job
Launches a one-time batch job based off of the previously supplied definition referring to the job definition ID and puts it on the queue.
- Write
Creates a new Batch Prediction job definition
Create a Batch Prediction Job definition. A configuration for a Batch Prediction job which can either be executed manually upon request or on scheduled intervals, if enabled. The API payload is the same as for /batchPredictions along with optional enabled and schedule items.
- Write
Update Batch Prediction job definition by job definition ID
Update a Batch Prediction job definition
- Write
Creates a new Batch Prediction job
Submit the configuration for the job and it will be submitted to the queue
- Write
Create a new a Batch Prediction job based
Copies an existing job and submits it to the queue.
- Write
Launch a Batch Prediction job
Launches a one-time batch prediction job based off of the previously supplied definition referring to the job definition ID and puts it on the queue.
- Write
Update a Batch Prediction job by prediction job ID
If a job has finished execution regardless of the result, it can have parameters changed to ensure better filtering in the job list upon retrieval. Another case: updating job scoring status externally.
- Write
Finalize a multipart upload by prediction job ID
Finalize a multipart upload, indicating that no further chunks will be sent
- Write
Create a new prediction explanations initialization by project ID
Create a new prediction explanations initialization. This is a necessary prerequisite for generating prediction explanations.
- Write
Upload a dataset by project ID
Upload a dataset for predictions from a DataSource.
- Write
Create prediction dataset by project ID
Create a prediction dataset from a Dataset Asset referenced by AI Catalog item/version ID.
- Write
Upload a file by project ID
Upload a file for predictions from an attached file.
- Write
Create URL uploads by ID
Upload a file for predictions from a URL.
- Write
Create a new PredictionExplanations object ( by project ID
Create a new PredictionExplanations object (and its accompanying PredictionExplanationsRecord).
- Write
Make new predictions by project ID
There are two ways of making predictions. The recommended way is to first upload your dataset to the project, and then using the corresponding datasetId, predict against that dataset. To follow that pattern, send the json request body.
- Write
Submits a job by project ID
Create training data predictions
- Destructive
Cancel a Batch job by batch job ID
If the job is running, it will be aborted. Then it will be removed, meaning all underlying data will be deleted and the job is removed from the list of jobs.
- Destructive
Stream CSV data by batch job ID
Stream CSV data to the job. Only available for jobs thatuses the localFile intake option.
- Destructive
Delete Batch Prediction job definition by job definition ID
Delete a Batch Prediction job definition
- Destructive
Cancel a Batch Prediction job by prediction job ID
If the job is running, it will be aborted. Then it will be removed, meaning all underlying data will be deleted and the job is removed from the list of jobs.
- Destructive
Creates a newmodelid Batch Prediction job by prediction job ID
Stream CSV data to the prediction job. Only available for jobs thatuses the localFile intake option.
- Destructive
Upload CSV data by prediction job ID
Stream CSV data to the prediction job in many parts.Only available for jobs that uses the localFile intake option.
- Destructive
Delete an existing PredictionExplanationsInitialization by project ID
Delete an existing PredictionExplanationsInitialization.
- Destructive
Cancel a queued prediction job by project ID
Cancel a queued prediction job.
- Destructive
Delete a dataset that was uploaded by project ID
Delete a dataset that was uploaded for prediction.
- Destructive
Delete saved Prediction Explanations by project ID
Delete saved Prediction Explanations. Deletes both the actual prediction explanations and the corresponding PredictionExplanationsRecord.
Monitoring jobs
- Read
List Batch Monitoring job definitions
List all Batch Monitoring jobs definitions available
- Read
Retrieve Batch Monitoring job definition by job definition ID
Retrieve a Batch Monitoring job definition
- Write
Creates a new Batch Monitoring job
Submit the configuration for the job and it will be submitted to the queue
- Write
Creates a new Batch Monitoring job definition
Create a Batch Monitoring Job definition. A configuration for a Batch Monitoring job which can either be executed manually upon request or on scheduled intervals, if enabled. The API payload is the same as for /batchJobs along with optional enabled and schedule items.
- Write
Update Batch Monitoring job definition by job definition ID
Update a Batch Monitoring job definition
- Destructive
Delete Batch Prediction job definition by job definition ID
Delete a Batch Prediction job definition
Features
- Read
Retrieve the list of allowed country codes
Retrieves the list of allowed country codes to request preloaded calendar generation for.
- Read
List all available calendars
List all the calendars which the user has access to.
- Read
Retrieve information about a calendar by calendar ID
List all the information about a calendar such as the total number of event dates, the earliest calendar event date, the IDs of projects currently using this calendar and the others.
- Read
Get a list of users who have access by calendar ID
Get a list of users who have access to this calendar and their roles on the calendar.
- Read
Retrieve the documents data quality log content by dataset ID
Retrieve the documents data quality log content and log length as JSON.
- Read
Retrieve a text file containing the documents data quality log by dataset ID
Retrieve a text file containing the documents data quality log.
- Read
Retrieve the images data quality log content by dataset ID
Retrieve the images data quality log content and log length as JSON
- Read
Retrieve a text file containing the images data quality log by dataset ID
Retrieve a text file containing the images data quality log.
- Read
Retrieve documents data quality log by ID
Retrieve the documents data quality log content and log length as JSON.
- Read
Retrieve file by ID
Retrieve a text file containing the documents data quality log.
- Read
Retrieve documents by model ID
Retrieve documents with computed document text extraction samples.
- Read
Retrieve document pages by model ID
Retrieve document pages with recognized text lines and bounding boxes enclosing the text lines.
- Read
Retrieve user's OCR job resources.
Retrieve user's OCR job resources.
- Read
Retrieve an OCR job resource by job resource ID
Retrieve an OCR job resource.
- Read
Retrieve the OCR job error report by job resource ID
Download the OCR job error report.
- Read
Retrieve per-file OCR job progress by job resource ID
Retrieve the per-file OCR progress of a job, batch by batch, as reported by the OCR worker.
- Read
Retrieve OCR job status by job resource ID
Get the status of a running OCR job from the OCR service.
- Read
Retrieve the result of a batch variable type transformation by project ID
Retrieve the result of a batch variable type transformation.
- Read
List available calendar events by project ID
List available calendar events for the project.
- Read
Validate columns by project ID
Validate columns for potential use as the group-by column for cross-series functionality. The group-by column is an optional setting that indicates how to further splitseries into related groups.
- Read
Get discarded features by project ID
Get features which were discarded during feature reduction process.
- Read
Returns a file by project ID
Returns a file for a single document page.
- Read
Lists metadata on all computed document text extraction samples by project ID
Lists metadata on all computed document text extraction samples in the project across all models.
- Read
Lists document thumbnail bins for every target value or range including the metadata for one by project ID
Lists document thumbnail bins for every target value or range including the metadata for one example thumbnail of the bin.
- Read
List all metadata by project ID
List all metadata for document thumbnails in the EDA sample.
- Read
Returns a list of document thumbnail metadata elements by project ID
Returns a list of document thumbnail metadata elements.
- Read
Retrieve the documents data quality log content by project ID
Retrieve the documents data quality log content and log length as JSON.
- Read
Retrieve a text file containing the documents data quality log by project ID
Retrieve a text file containing the documents data quality log.
- Read
Get a list of duplicate images containing the number of occurrences of each by project ID
Get a list of duplicate images containing the number of occurrences of each image
- Read
Download the project dataset by project ID
Download the project dataset with features added by feature discovery
- Read
Retrieve the feature discovery log content by project ID
Retrieve the feature discovery log content and log length for a feature discovery project. This route is only supported for feature discovery projects that have finished partitioning
- Read
Retrieve a text file containing the feature discovery log by project ID
Retrieve a text file containing the feature discovery log. This route is only supported for feature discovery projects that have finished partitioning.
- Read
Download the feature discovery SQL recipe by project ID
Download the feature discovery SQL recipe for a project.
- Read
Get the feature histogram by project ID
Get histogram chart data for a specific feature. Information that can be used to build histogram charts. Plot data returned is based on raw data that is calculated during initial project creation and updated after the project's target variable has been selected.
- Read
Retrieve the Feature Discovery lineage by project ID
Retrieve the Feature Discovery lineage for a single feature.
- Read
List featurelists by project ID
List all featurelists for a project.
- Read
Retrieve a feature list by project ID
Retrieve a single known feature list.
- Read
List project features by project ID
List the features from a project with descriptive information.
- Read
List feature metrics by project ID
List the appropriate metrics if a feature were chosen as the target. The metrics listed will include both weighted and unweighted metrics - which are appropriate will depend on whether a weights column is used.
- Read
Get a project feature by project ID
Retrieve the specified feature with descriptive information. Descriptive information for features also includes summary statistics as of v2.8. These are returned via the fields max, min, mean, median, and stdDev.
- Read
Retrieve potential multiseries ID columns by project ID
Time series projects require that each timestamp have at most one row corresponding to it. However, multiple series of data can be handled within a single project by designating a multiseries ID column that assigns each row to a particular series.
- Read
List image bins and covers by project ID
List image bins and covers for every target value or range.
- Read
List all Image Embeddings by project ID
List all Image Embeddings for the project.
- Read
Retrieve image samples by ID
List all metadata for images in the EDA sample
- Read
Returns a list of image metadata elements by project ID
Returns a list of image metadata elements.
- Read
Returns a single image metadata by project ID
Returns a single image metadata.
- Read
Retrieve file by ID
Returns a file for a single image
- Read
Retrieve the images data quality log content by project ID
Retrieve the images data quality log content and log length as JSON
- Read
Retrieve a text file containing the images data quality log by project ID
Retrieve a text file containing the images data quality log
- Read
List all modeling featurelists by project ID
List all modeling featurelists from the project requested by ID. This route will only become available after the target and partitioning options have been set for a project.
- Read
Retrieve a single modeling featurelist by ID by project ID
Retrieve a single modeling featurelist by ID. When reporting the number of models that "use" a featurelist, a model is considered to use a featurelist if it is used as to train the model or as a monotonic constraint featurelist, or if the model is a blender with component models…
- Read
List project modeling features by project ID
List the features from a project that are used for modeling with descriptive information.
- Read
Retrieve project modeling feature by project ID
Retrieve the specified modeling feature with descriptive information.
- Read
Retrieve ImageEmbeddings by project ID
Retrieve ImageEmbeddings for a feature of a model.
- Read
Retrieve relationships configuration by project ID
Retrieve relationships configuration for a project.
- Read
List all secondary dataset configurations by project ID
List all secondary dataset configurations for a project, optionally filtered by feature list ID.
- Read
Retrieve secondary dataset configuration by ID by project ID
Retrieve secondary dataset configuration by ID.
- Read
Retrieve the feature derivation log content and log length by project ID
Retrieve the feature derivation log content and log length for a time series project as JSON. The Time Series Feature Log provides details about the feature generation process for a time series project.
- Read
Retrieve a text file containing the time series project feature log by project ID
Retrieve a text file containing the time series project feature log. The Time Series Feature Log provides details about the feature generation process for a time series project.
- Read
Retrieve a relationships configuration by relationships configuration ID
Retrieve a relationships configuration
- Read
Retrieve the relationships configuration by relationships configuration ID
Retrieve the relationships configuration with extended information
- Read
List MCP prompts under one MCP server deployment by mcp server deployment ID
List MCP prompts under one MCP server deployment.
- Read
List MCP resources under one MCP server deployment by mcp server deployment ID
List MCP resources under one MCP server deployment.
- Read
List MCP tools under one MCP server deployment by mcp server deployment ID
List MCP tools under one MCP server deployment.
- Read
List the MCP prompts under one MCP server version by mcp server version ID
Lists the MCP prompts under one MCP server version.
- Read
List the MCP resources under one MCP server version by mcp server version ID
Lists the MCP resources under one MCP server version.
- Read
List the MCP tools under one MCP server version by mcp server version ID
Lists the MCP tools under one MCP server version.
- Write
Create a calendar
Create a calendar from a file in a CSV or XLSX format. The calendar file specifies the dates or events in a dataset such that DataRobot automatically derives and creates special features based on the calendar events (e.g., time until the next event, labeling the most recent even…
- Write
Initialize generation of preloaded calendars.
Initialize generation of preloaded calendars. Preloaded calendars are available only for time series projects. Preloaded calendars do not support multiseries calendars.
- Write
Create a calendar from a dataset
Create a calendar from the dataset.
- Write
Update a calendar's name by calendar ID
Update a calendar's name.
- Write
Update the access control by calendar ID
Update the access control for this calendar. See the entity sharing documentation for more information.
- Write
Requests the computation of document text extraction samples by model ID
Requests the computation of document text extraction samples for the specified model.
- Write
Create an OCR job resource.
Create an OCR job resource. This creates several entities, including an empty Dataset for writing the results and associates the input dataset with them.
- Write
Create/start OCR job by job resource ID
Start an OCR job from the information in the OCR job resource. Each OCR job may be started exactly once.
- Write
Create multiple new features by changing the type of existing features by project ID
Create multiple new features by changing the type of existing features.
- Write
Generate the feature discovery SQL recipe by project ID
Generate the feature discovery SQL recipe for a project.
- Write
Create a new featurelist by project ID
Create a new featurelist from list of feature names.
- Write
Update an existing featurelist by project ID
Update an existing featurelist by ID.
- Write
Create a new modeling featurelist by project ID
Create new modeling featurelist from list of feature names. Only time series projects differentiate between modeling and input featurelists. On other projects, this route will behave the same as :http:post:/api/v2/projects/(projectId)/featurelists/.
- Write
Update an existing modeling featurelist by project ID
Update an existing modeling featurelist by ID. In non-time series projects, "modeling featurelists" and "featurelists" routes behave the same, except "modeling featurelists" are only accessible after the project is ready for modeling.
- Write
Restore discarded time series features by project ID
Restore discarded time series features.
- Write
Request the computation of image embeddings by project ID
Request the computation of image embeddings for the specified model.
- Write
Submit a relationship quality assessment job by project ID
Submit a job to assess the quality of the relationship configuration within a Feature Discovery project.
- Write
Create secondary dataset configurations by project ID
Create secondary dataset configurations for a project.
- Write
Create a new feature by changing the type of an existing one by project ID
Create a new feature by changing the type of an existing one.
- Write
Create a relationships configuration
Create a relationships configuration
- Write
Add one MCP prompt under one user MCP server deployment by mcp server deployment ID
Add one record of MCP prompt under one MCP server deployment.
- Write
Add one MCP resource under one user MCP server deployment by mcp server deployment ID
Add one record of MCP resource under one MCP server deployment.
- Write
Add one MCP tool under one user MCP server deployment by mcp server deployment ID
Add one record of MCP tool under one MCP server deployment.
- Write
Add one MCP prompt under one user MCP server version by mcp server version ID
Adds one record of an MCP prompt under one MCP server version.
- Write
Add one MCP resource under one user MCP server version by mcp server version ID
Add one record of an MCP resource under one MCP server version.
- Write
Add one MCP tool under one user MCP server version by mcp server version ID
Adds one record of an MCP tool under one MCP server version.
- Destructive
Delete a calendar by calendar ID
Delete a calendar. This can only be done if all projects and deployments using the calendar have been deleted.
- Destructive
Save the OCR job error report by job resource ID
Upload the job error report to the associated OCR job resource for later downloading.
- Destructive
Delete a specified featurelist by project ID
Delete a specified featurelist. All models using a featurelist, whether as the training featurelist or as a monotonic constraint featurelist, will also be deleted when the deletion is executed and any queued or running jobs using it will be cancelled.
- Destructive
Delete a specified modeling featurelist by project ID
Delete a specified modeling featurelist. All models using a featurelist, whether as the training featurelist or as a monotonic constraint featurelist, will also be deleted when the deletion is executed and any queued or running jobs using it will be cancelled.
- Destructive
Soft-delete a secondary dataset configuration by project ID
Soft-delete a secondary dataset configuration.
- Destructive
Replace a relationships configuration by relationships configuration ID
Replace a relationships configuration
- Destructive
Delete a relationships configuration by relationships configuration ID
Delete a relationships configuration
- Destructive
Delete one MCP prompt under one MCP server deployment by mcp server deployment ID
Delete one MCP prompt under one MCP server deployment.
- Destructive
Delete one MCP resource under one MCP server deployment by mcp server deployment ID
Delete one MCP resource under one MCP server deployment.
- Destructive
Delete one MCP tool under one MCP server deployment by mcp server deployment ID
Delete one MCP tool under one MCP server deployment.
Data registry
- Read
List all catalog items accessible by the user.
List all catalog items accessible by the user.
- Read
Retrieves latest version information, by ID by catalog ID
Retrieves latest version information, by ID, for catalog items.
- Read
Retrieve a data engine query generator by ID
Retrieve a data engine query generator
- Read
Read Data Engine workspace state by workspace state ID
Read and return previously stored Data Engine workspace state.
- Read
List datasets
List all datasets accessible by the user.
- Read
Get dataset details by dataset ID
Retrieves the details of the dataset with given ID.
- Read
List dataset access by dataset ID
List the users and their associated roles for the specified dataset.
- Read
Get dataset features by dataset ID
Return detailed information on all the features and transforms for this dataset.If the Dataset Item has attribute snapshot = True, all optional fields also appear
- Read
Get dataset feature histogram by dataset ID
Get histogram chart data for a specific feature in the specified dataset.
- Read
List dataset feature transforms by dataset ID
Retrieves the transforms of the dataset with given ID.
- Read
Get dataset feature transform by dataset ID
Retrieve the specified feature with descriptive information.
- Read
Retrieve dataset featurelists by dataset ID
Retrieves the featurelists of the dataset with given ID and the latest dataset version.
- Read
Get dataset featurelist by dataset ID
Retrieves the specified featurelist of the dataset with given ID and the latest dataset version.
- Read
Retrieve original dataset data by dataset ID
Retrieve all the originally uploaded data, in CSV form.
- Read
Describe dataset permissions by dataset ID
Describe what permissions current user has for given dataset.
- Read
Get dataset projects by dataset ID
Retrieves a dataset's projects by dataset ID.
- Read
Information about scheduled jobs by dataset ID
Paginated list of scheduled jobs descriptions for a specific dataset with given dataset ID, sorted by time of the last update.
- Read
Gets configuration of a user scheduled dataset refresh job by job ID
Gets configuration of a user scheduled dataset refresh job by job ID.
- Read
Results of dataset refresh job by dataset ID
Paginated list of execution results for refresh job with the given ID and dataset with the given ID, sorted from newest to oldest.
- Read
List related datasets by dataset ID
Retrieve a list of the dataset relationships for a specific dataset.
- Read
List dataset versions by dataset ID
List all versions associated with given datasetId and which match the specified query parameters.
- Read
Get dataset details by version by dataset ID
Retrieves the details of the dataset with given ID and version ID.
- Read
Retrieve all features details by ID
Return detailed information on all the features and transforms for this dataset.If the Dataset Item has attribute snapshot = True, all optional fields also appear
- Read
Retrieve feature histograms by ID
Get histogram chart data for a specific feature in the specified dataset.
- Read
Retrieve featurelists by ID
Retrieves the featurelists of the dataset with given ID and the latest dataset version.
- Read
Retrieve featurelists by ID
Retrieves the specified featurelist of the dataset with given ID and the latest dataset version.
- Read
Retrieve file by ID
Retrieve all the originally uploaded data, in CSV form.
- Read
Get dataset projects by version by dataset ID
Retrieves a dataset's projects for the specified catalog dataset and dataset version id.
- Read
List all files associated by catalog ID
Lists all files associated with the catalog item.
- Read
Retrieve data by catalog ID
Creates a URL to download specified data from the AI catalog (using either /files/{catalogId}/file/ or URL to external storage via signed URL) andredirects to the URL via HTTP 303.
- Read
Retrieve the requested data by streaming it by catalog ID
Retrieve the requested data from the catalog entity by streaming it.
- Read
List file refresh jobs by catalog ID
Paginated list of scheduled refresh jobs for a specific file-registry catalog item, sorted by time of the last update. Equivalent jobs are also available via the generic GET /scheduledJobs/?typeid=fileRefresh endpoint.
- Read
Get a file refresh job by job ID
Gets the configuration of a user-scheduled file refresh job by job ID.
- Read
List execution results of a file refresh job by catalog ID
Paginated list of runs for the given file refresh job, newest first. Each entry carries the run status and, on failure, the reason the refresh did not complete.
- Read
List catalog versions by catalog ID
List all versions associated with given catalogId and which match the specified query parameters.
- Read
Retrieve all files by ID
List all files associated with the catalog item and version.
- Read
Retrieve file by ID
Retrieve the requested data from the catalog entity and version by streaming it.
- Write
Update the name, description, or tags by catalog ID
Update the name, description, or tags for the requested catalog item.
- Write
Create a data engine query generator
Create a data engine query generator.
- Write
Create Data Engine workspace state.
Create Data Engine workspace state in database.
- Write
Create Data Engine workspace state
Create Data Engine workspace state in database from a query generator.
- Write
Execute bulk dataset action
Execute the specified bulk action on multiple datasets.
- Write
Create dataset
Create a dataset from a Data Engine workspace state.
- Write
Create a dataset from a data source
Create a Dataset Item from a data source.
- Write
Create a dataset from a file
Create a dataset from a file.
- Write
Create a dataset from a hdfs
Create a Dataset Item from an HDFS URL.
- Write
Create a dataset from a recipe
Create a dataset item and version from a recipe.During publishing, an immutable copy of the recipe is created, as well as a copy of the recipe's data source.
- Write
Create a dataset from a stage
Create a dataset from a data stage.
- Write
Create a dataset from an URL
Create a Dataset Item from a URL.
- Write
Modify dataset by dataset ID
Modifies the specified dataset.
- Write
Modify dataset access by dataset ID
Grant access to the dataset at the specified role level, or remove access to the dataset.
- Write
Recover deleted dataset by dataset ID
Recover the dataset item with given datasetId from deleted.
- Write
Create dataset feature transform by dataset ID
Create a new feature by changing the type of an existing one.
- Write
Create dataset featurelist by dataset ID
Create featurelist for specified dataset.
- Write
Update dataset featurelist by dataset ID
Modifies the indicated featurelist of the dataset with given ID.
- Write
Schedule dataset refresh by dataset ID
Create a dataset refresh job that will automatically create dataset snapshots on a schedule.
- Write
Update a dataset refresh job by dataset ID
Update a dataset refresh job. Optionally if the limit of enabled jobs per user is reached the following metadata will be added to the default error response payload: - datasetsWithJob (array) - The list of datasets IDs that have at least one enabled job.
- Write
Create dataset relationship by dataset ID
Create a dataset relationship.
- Write
Update dataset relationship by dataset ID
Update a dataset relationship.
- Write
Create dataset version by dataset ID
Create a new dataset version for a specified dataset from a Data Engine workspace state. The new dataset version should have the same schema as the specified dataset.
- Write
Create a version from a data source
Create a new version for the specified dataset from specified Data Source. The dataset must have been created from a compatible data source originally.
- Write
Create a version from a file
Create a new version for the specified dataset from a file.
- Write
Create a version from a hdfs
Create a new version for the specified dataset from a HDFS URL. The dataset must have been created from the same HDFS URL originally.
- Write
Create a version from a latest version
Create a new version of the specified dataset from the latest dataset version. This will reuse the same source of the data that was previously used. Not supported for datasets that were previously loaded from an uploaded file.
- Write
Create a version from a recipe
Create a new dataset version for a specified dataset from a wrangler recipe.
- Write
Create a version from a stage
Create a new version for the specified dataset from a data stage.
- Write
Create a version from an URL
Create a new version for the specified dataset from specified URL. The dataset must have been created from the same URL originally.
- Write
Recover deleted dataset version by dataset ID
Recover the dataset version item with given datasetId and datasetVersionId from deleted.
- Write
Create a version from a version
Create a new version of the specified dataset from the specified dataset version. This will reuse the same source of the data that was previously used. Not supported for datasets that were previously loaded from an uploaded file.
- Write
Create an empty files catalog item.
Create an empty files catalog item.
- Write
Execute bulk files action
Execute the specified bulk action on multiple files.
- Write
Create a files catalog item
Create a files catalog item from a data source.
- Write
Create a file from a file
Create a files catalog item from a file.
- Write
Create a file from an URL
Create a files catalog item from a URL.
- Write
Rename a file by catalog ID
Rename a file or folder within the same catalog item (fromPath/toPath), or set the isExecutable flag on a single file (fileName/isExecutable).
- Write
Create a duplicate files collection by catalog ID
Copy all files from the original catalog item into a newly created one. Optionally, omit some files.
- Write
Copy a file by catalog ID
Copy a file or folder within the same catalog item. Folder names should end with "/".
- Write
Copy multiple files by catalog ID
Copy one or multiple paths across different catalog items or within the same catalog item.
- Write
Recover a deleted file by catalog ID
Recover the file item with given catalogId from deleted.
- Write
Add file(s) into an existing files catalog item by catalog ID
Add file(s) into an existing files catalog item from a data source.
- Write
Create a file from a file
Add file(s) to an existing files catalog item.
- Write
Apply staged files by catalog ID
Add files from the stage into the catalog item. In the case of naming conflicts, rename files according to overwrite strategy.
- Write
Create a file from an URL
Add file(s) into an existing files catalog item from a URL.
- Write
Create links by ID
Creates URLs to download specified data from the AI catalog (using either /files/{catalogId}/file/ or URL to external storage via signed URL).
- Write
Schedule a file refresh by catalog ID
Create a scheduled file refresh job.
- Write
Update a file refresh job by catalog ID
Update an existing scheduled file refresh job.
- Write
Create an empty stage by catalog ID
Create an empty stage entity.
- Write
Stage file by catalog ID
Stage file for a batch upload. This endpoint won't unzip an archive for you. Use POST /files/ /fromFile/ (no stage) if you would like to unzip the archive on upload.
- Write
Recover deleted file version by catalog ID
Recover the file version item with given catalogId and catalogVersionId from deleted.
- Write
Create downloads by ID
Creates a URL to download specified data from the AI catalog (using either /files/{catalogId}/versions/{catalogVersionId}/file/ or URL to external storage via signed URL) andredirects to the URL via HTTP 303.
- Write
Create links by ID
Creates URLs to download specified data from the AI catalog (using either /files/{catalogId}/versions/{catalogVersionId}/file/ or URL to external storage via signed URL).
- Write
Perform a permanent deletion dry run of a file.
Perform a permanent deletion dry run of an AI catalog file. Detect if there will be any errors or warnings. Display file versions and associated files that would be deleted if the deletion were executed.
- Write
Permanently delete the files.
Permanently deletes the list of files from the AI catalog.
- Destructive
Delete dataset by dataset ID
Marks the dataset with the given ID as deleted.
- Destructive
Delete dataset featurelist by dataset ID
Deletes the indicated featurelist of the dataset with given ID.
- Destructive
Deletes an existing dataset refresh job by dataset ID
Deletes an existing dataset refresh job.
- Destructive
Delete dataset relationship by dataset ID
Delete a dataset relationship.
- Destructive
Delete dataset version by dataset ID
Marks the dataset version with the given ID as deleted.
- Destructive
Delete the file by catalog ID
Marks the file with the given ID as deleted.
- Destructive
Delete files or folders by catalog ID
Recursively delete one or more files or folders inside a catalog item. Folder names should end with "/".
- Destructive
Delete a file refresh job by catalog ID
Deletes an existing file refresh job.
- Destructive
Delete file version by catalog ID
Marks the file version with the given ID as deleted.
Infrastructure
- Read
Retrieve the information about cluster license
Retrieve the information about the currently deployed cluster license.
- Read
Check if a license is valid.
Check if a cluster license is valid.
- Read
Retrieve version information.
Provides the version information for the current version of the API.
- Destructive
Create
Create or replace the cluster license.
Value tracker
- Read
Retrieve a comment by comment ID
Retrieve a comment
- Read
List comments by entitytype
List comments
- Read
List available value tracker templates.
List available value tracker templates.
- Read
Get an individual value tracker value template by its name by templatetype
Get an individual value tracker value template by its name.
- Read
Calculate the value of the template by templatetype
Calculate the value of the template with the given template parameters.
- Read
List value trackers the requesting user has access to.
List value trackers the requesting user has access to.
- Read
Retrieve a value tracker by value tracker ID
Retrieve a value tracker.
- Read
Retrieve the activities of a value tracker by value tracker ID
Retrieve the activities of a value tracker.
- Read
Get the list of resources attached by value tracker ID
Get the list of resources attached to this value tracker.
- Read
Get a resource that is attached by value tracker ID
Get a resource that is attached to a value tracker.
- Read
Retrieve realized value information by value tracker ID
Retrieve realized value information for a given value tracker over a period of time.
- Write
Post a comment
Post a comment
- Write
Update a comment by comment ID
Update a comment
- Write
Create a new value tracker.
Create a new value tracker.
- Write
Update a value tracker by value tracker ID
Update a value tracker.
- Write
Attach the list of resources by value tracker ID
Attach the list of resources to this value tracker.
- Destructive
Delete a comment by comment ID
Delete a comment
- Destructive
Delete a value tracker by value tracker ID
Delete a value tracker.
- Destructive
Removes a resource by value tracker ID
Removes a resource from a value tracker.
Credentials
- Read
List credentials.
List all sets of credentials available for given user.
- Read
List credentials associated by association ID
Returns a list of credentials associated with the specified object for the given session user.
- Read
Retrieve the credentials set by credential ID
Return the credential set matching the specified ID.
- Read
List all objects associated by credential ID
List all objects associated with specified credentials for the current user.
- Write
Store a new set of credentials which can be used
Store a new set of credentials.
- Write
Update specified credentials by credential ID
Update specified credentials
- Write
Add objects associated by credential ID
Add objects associated with credentials.
- Destructive
Delete the credentials set by credential ID
Delete the credential set matching the specified ID if it is not used by any data connection or batch prediction job.
- Destructive
Set default credentials by credential ID
Set (create or update) the credentials' association for the given Data Connection for the given session Owner for the given credentials.
Custom applications
- Read
The list of custom application sources created
The list of custom application sources.
- Read
Retrieve a custom application source by app source ID
Retrieve a source.
- Read
Paginated list of custom application source versions of the specified by app source ID
List of custom application source versions.
- Read
Retrieve a custom application source version by app source ID
Retrieve a source version.
- Read
Download Custom Application Source version files as a zip archive by app source ID
Download all files from a Custom Application Source version as a zip archive.
- Read
Retrieve a file by app source ID
Retrieve a file stored inside a custom application source version.
- Read
The list of applications created by the currently authenticated user.
The list of applications created by the currently authenticated user.
- Read
Retrieve an application by application ID
Retrieve an application
- Read
Retrieve an application's publication history by application ID
Retrieve an application's publication history.
- Read
Retrieve an application's logs by application ID
Retrieve an application's logs
- Read
Retrieve an application's usages by application ID
Retrieve an application's usages
- Read
Download an application's access logs by application ID
Download an application's access logs
- Read
Retrieve a list of custom templates.
Retrieve a list of custom templates.
- Read
Retrieve a single custom template by custom template ID
Retrieve a single custom template.
- Read
Retrieve a single custom template file by custom template ID
Retrieve a single custom template file.
- Write
Create a custom application source.
Create a custom application source.
- Write
Create a custom application source
Create a custom application source from a template.
- Write
Update a custom application source's name by app source ID
Update a source's name.
- Write
Create a custom application source version by app source ID
Create a custom application source.
- Write
Update a custom application source version by app source ID
Update the source version
- Write
Update the custom application source version by app source ID
Update files in the source version from Codespace.
- Write
Update a codespace by app source ID
Update a codespace with files from the source version.
- Write
Create a custom application
Create a custom application
- Write
Update an application's name by application ID
Update an application's name
- Write
Create Migrate To Workload by application ID
POST /api/v2/customApplications/{applicationId}/migrateToWorkload/
- Write
Create Revert To Lrs by application ID
POST /api/v2/customApplications/{applicationId}/revertToLrs/
- Write
Create a custom template.
Create a custom template.
- Write
Update the given custom template by custom template ID
Update the given custom template.
- Destructive
Delete a custom application source by app source ID
Delete a custom application source.
- Destructive
Delete a custom application source version if it is still mutable by app source ID
Delete a custom application source version.
- Destructive
Delete an application by application ID
Delete an application
- Destructive
Delete a custom template by custom template ID
Delete a custom template.
Custom models
- Read
Get custom model feature impact by image ID
Retrieve feature impact scores for features in a custom inference model image. ..
- Read
Get custom model resource limits.
Retrieve custom model resource limits the user has access to.
- Read
List custom model tests.
Retrieve the testing history for a model.
- Read
Get custom model test by custom model test ID
Retrieve a specific testing history entry for a custom model.
- Read
Get custom model test log by custom model test ID
Retrieve the logs from a model testing attempt.
- Read
Get custom model test log tail by custom model test ID
Retrieve the last N lines of logs from a model testing attempt.
- Read
List custom models.
Retrieve metadata for all custom models the user has access to.
- Read
Get custom model by custom model ID
Retrieve metadata for a custom model.
- Read
Get a list of users who have access by custom model ID
Get a list of users who have access to this custom model and their roles on it.
- Read
Download the latest custom model version content by custom model ID
Download the latest item bundle from a custom model as a zip compressed archive.
- Read
List custom model versions by custom model ID
List custom model versions.
- Read
Get custom model version by custom model ID
Display a requested version of a custom model along with the files attached to it.
- Read
Get a list by custom model ID
Get the list of custom model conversions that are associated with the given custom model. Alternatively, it can return a single item list of the latest custom model conversion that is associated with the given custom model version.
- Read
Get a given custom model conversion by custom model ID
Get a given custom model conversion.
- Read
Retrieve the custom model version's dependency build status by custom model ID
Retrieve the custom model version's dependency build status.
- Read
Retrieve the custom model version's dependency build log by custom model ID
Retrieve the custom model version's dependency build log.
- Read
Download custom model version content by custom model ID
Download a specific item bundle from a custom model as a zip compressed archive.
- Read
Get custom model feature impact by custom model ID
Retrieve feature impact scores for features in a custom inference model image. This route is a counterpart of a corresponding endpoint for native models: :http:get:/api/v2/projects/(projectId)/models/(modelId)/featureImpact/
- Read
List all cleanup jobs.
List all cleanup jobs with their summary status.
- Read
Get cleanup job status by scan ID
Provide the current status of the cleanup scan, including the progress of the scan. It should include links to related resources, such as the scan report and the endpoint to trigger cleanup if the scan is complete.
- Read
Get cleanup job report by scan ID
Provide the detailed list of resources identified by the scan as candidates for cleanup, along with reasons. If the cleanup has been triggered, this endpoint should also return a summary of the results.
- Read
List execution environments.
List all execution environments sorted by creation time descending.
- Read
Get an execution environment by environment ID
Retrieve a single execution environment.
- Read
Get a list of users who have access by environment ID
Get a list of users who have access to this execution environment and their roles.
- Read
List execution environment versions by environment ID
List all execution environment versions sorted by creation time descending.
- Read
Get an execution environment version by environment ID
Retrieve an execution environment version by ID.
- Read
Download the execution environment build log by environment ID
Retrieve execution environment version build log.
- Read
Submit image tarball build by environment ID
Submit image tarball build for URI based environment.
- Read
Retrieve image cleanups (custommodels)
List all cleanup jobs with their summary status.
- Read
Retrieve image cleanups by ID
Provide the current status of the cleanup scan, including the progress of the scan. It should include links to related resources, such as the scan report and the endpoint to trigger cleanup if the scan is complete.
- Read
Retrieve report by ID
Provide the detailed list of resources identified by the scan as candidates for cleanup, along with reasons. If the cleanup has been triggered, this endpoint should also return a summary of the results.
- Read
Retrieve reserved runtime parameter names.
Retrieve the list of reserved environment variable name patterns that cannot be used as runtime parameter names. Supports wildcard patterns ( and ?) and entity-specific restrictions.
- Write
Create custom model feature impact by image ID
Add a request to calculate feature impact for a custom inference model image to the queue. ..
- Write
Create custom model test.
Test a custom inference model. This will start a job to check that the custom model can make predictions against the supplied dataset without breaking.
- Write
Create custom model.
Creates a new custom model and returns the newly created metadata record for it. All custom models must support at least one target type (binaryClassification, regression). Custom inference models can only support a single target type.
- Write
Clone custom model.
Creates a copy of the provided custom model, including metadata, versions of that model, and uploaded files. Associates the new versions with files owned by the custom model.
- Write
Create a custom model
Create a custom model from a template.
- Write
Create a new prediction explanations initialization
Create a new prediction explanations initialization for custom model. This is a necessary prerequisite for generating prediction explanations. ..
- Write
Update custom model by custom model ID
Updates metadata for an existing custom model. All custom models must support at least one target type (binaryClassification, regression). Custom inference models can only support a single target type.
- Write
Grant access or update roles by custom model ID
Grant access or update roles for users on this custom model and appropriate learning data. Up to 100 user roles may be set in a single request.
- Write
Assign training data by custom model ID
The current API is deprecated and scheduled for removal in v2.34. Training data assignment is implemented in CustomModelVersionCreateController and CustomModelVersionCreateFromLatestController. Assigns the specified dataset to the specified custom model as training data.
- Write
Create custom model version by custom model ID
Create a new custom model version with attached files if supplied.
- Write
Update custom model version files by custom model ID
Create a new custom model version with files added, replaced or deleted. Files from the previous version of a custom models will be used as a basis.
- Write
Create a new custom model version by custom model ID
Create a new custom model version with files from the codespace.
- Write
Create a version from a repository
Create a new custom model version with only files added from the specified remote repository.
- Write
Create custom model version from remote repository by custom model ID
Create a new custom model version with files added from a remote repository. Files from the previous version of a custom models will be used as a basis.
- Write
Add or replace training and holdout data by custom model ID
Current API is deprecated and will be removed in v2.33. Training data assignment is implemented in CustomModelVersionCreateController and CustomModelVersionCreateFromLatestController.
- Write
Update custom model version by custom model ID
Edit metadata of a specific model version.
- Write
Generates JAR file by custom model ID
Converts files in the given custom model version to a JAR file.
- Write
Start a custom model version's dependency build by custom model ID
Start a custom model version's dependency build. This is required to test, deploy, or train custom models.
- Write
Create custom model feature impact by custom model ID
Add a request to calculate feature impact for a custom inference model image to the queue. This route is a counterpart of a corresponding endpoint for native models: :http:post:/api/v2/projects/(projectId)/models/(modelId)/featureImpact/
- Write
Create a new prediction explanations initialization by custom model ID
Create a new prediction explanations initialization for custom model version. This is a necessary prerequisite for generating prediction explanations.
- Write
Update a codespace by custom model ID
Update a codespace with files from the custom model version.
- Write
Initiate a resource cleanup scan.
Initiate an asynchronous scan for resource cleanup. The scanId allows the client to poll for status updates.
- Write
Trigger resource cleanup by scan ID
Trigger the actual cleanup based on a previously completed scan. It might allow for a subset of the scanned resources to be selected for cleanup. NOTE: given the exact same parameters, this operation is idempotent.
- Write
Create an execution environment.
Create a new execution environment.
- Write
Update an execution environment by environment ID
Update an execution environment.
- Write
Grant access by environment ID
Grant access or update roles for users on this execution environment. Up to 100 user roles may be set in a single request.
- Write
Create an execution environment version by environment ID
Create a new execution environment version.
- Write
Stop the execution environment build by environment ID
Stop the execution environment version build.
- Write
Request on-demand image build by environment ID
Request on-demand image build for an execution environment version based on image URI.
- Write
Permanently delete execution environments.
Permanently delete records and files associated with previously soft deleted execution environments.
- Write
Create image cleanups (custommodels)
Initiate an asynchronous scan for resource cleanup. The scanId allows the client to poll for status updates.
- Write
Create cleanup by ID
Trigger the actual cleanup based on a previously completed scan. It might allow for a subset of the scanned resources to be selected for cleanup. NOTE: given the exact same parameters, this operation is idempotent.
- Destructive
Cancel custom model test by custom model test ID
Cancel custom inference model testing.
- Destructive
Delete custom model by custom model ID
Delete a custom model. Only users who have permission to edit custom model can delete it. Only custom models which are not currently deployed or undergoing custom model testing can be deleted.
- Destructive
Delete custom model version by custom model ID
Delete a custom model version. Only users who have permission to delete custom model can delete it's version. Only custom models versions which are not currently deployed can be deleted.
- Destructive
Stop a given custom model conversion by custom model ID
Stop a running conversion for given model and model version.
- Destructive
Cancel dependency build by custom model ID
Cancel the custom model version's dependency build.
- Destructive
Destroy an execution environment by environment ID
Mark a specified execution environment as deleted. Environments are never deleted from database, however marked environments don't appear in any API. Relevant CustomModelImage will be deleted.
- Destructive
Delete an execution environment version by environment ID
Mark a specified execution environment version as deleted.
Custom jobs
- Read
Retrieve custom job limits.
Retrieve custom job limits.
- Read
List custom jobs.
List custom jobs.
- Read
Retrieve custom job by custom job ID
Retrieve custom job.
- Read
Retrieve custom job file content by custom job ID
Retrieve custom job file content.
- Read
List custom job runs by custom job ID
List custom job runs.
- Read
Retrieve custom job run by custom job ID
Retrieve custom job run.
- Read
Retrieve custom job run file content by custom job ID
Retrieve custom job run file content.
- Read
Retrieve custom job run logs by custom job ID
Retrieve custom job run logs.
- Read
List deleted custom jobs.
List deleted custom jobs.
- Write
Create a custom job.
Create a custom job.
- Write
Create a custom jobs from a gallery template
Create a custom job.
- Write
Update custom job by custom job ID
Update custom job.
- Write
Create a custom job run by custom job ID
Create a custom job run.
- Write
Update custom job run by custom job ID
Update custom job run.
- Write
Permanently delete custom job by custom job ID
Permanently delete custom job.
- Destructive
Delete custom job by custom job ID
Delete custom job.
- Destructive
Cancel custom job run by custom job ID
Cancel custom job run.
- Destructive
De,ete custom job run logs by custom job ID
Delete custom job run logs.
Observability custom metrics
- Read
List all of the custom metrics associated by custom job ID
List all of the custom metrics associated with a custom job.
- Read
Retrieve a template by custom job ID
Retrieve a template for hosted custom metric job.
- Read
Retrieve a list of custom metrics by deployment ID
Retrieve a list of custom metrics.
- Read
Retrieve a single custom metric metadata by deployment ID
Retrieve a single custom metric metadata.
- Read
Retrieve the summary of deployment batch custom metric by deployment ID
Retrieve the summary of deployment batch custom metric.
- Read
Retrieve the summary of deployment custom metric by deployment ID
Retrieve the summary of deployment custom metric.
- Read
Retrieve custom metric values over batch by deployment ID
Retrieve custom metric values over batch.
- Read
Retrieve custom metric values over space by deployment ID
Retrieve custom metric values over space.
- Read
Retrieve custom metric values over time by deployment ID
Retrieve custom metric values over time.
- Read
Retrieve the bulk summary of deployment batch custom metrics by deployment ID
Retrieve the bulk summary of deployment batch custom metrics.
- Read
Retrieve the bulk summary of deployment custom metrics by deployment ID
Retrieve the bulk summary of deployment custom metrics.
- Write
Creates a custom job
Creates a custom job from the hosted custom metric template.
- Write
Update custom metric associated by custom job ID
Update custom metric associated with a custom job.
- Write
Creates a template by custom job ID
Creates a template for hosted custom metric job.
- Write
Updates a template by custom job ID
Updates a template for hosted custom metric job.
- Write
Create a deployment custom metric by deployment ID
Create a deployment custom metric.
- Write
Bulk upload custom metric values by deployment ID
Bulk upload custom metric values from JSON.
- Write
Create a custom metrics from a custom job
Create a deployment custom metric from an existing custom job.
- Write
Update given custom metric settings by deployment ID
Update given custom metric settings.
- Write
Upload custom metric values by deployment ID
Upload custom metric values from dataset.
- Write
Create a custom metrics from a JSON
Upload custom metric values from JSON.
- Destructive
Delete a custom metric associated by custom job ID
Delete a custom metric associated with a custom job.
- Destructive
Delete a custom metric by deployment ID
Delete a custom metric.
Deployment management
- Read
List custom model deployments.
List of model deployments for user sorted by creation time descending.
- Read
Get custom model deployment limits.
Retrieve custom model deployment limit state: maximum allowed, current count, and whether the limit has been reached.
- Read
Get custom model log by deployment ID
Retrieve the logs generated during deployment of the custom model.
- Read
Retrieve logs by ID
Retrieve the logs generated during predictions on the deployed custom model.
- Read
List deleted deployments
List deleted deployments.Only available as part of an enterprise (on-prem) installation. Requires a CANDELETEAPPPROJECTS permission to execute.
- Read
List deployments
List deployments a user can view.
- Read
Get deployment limits.
Fetch deployment limit information.
- Read
Retrieve deployment by deployment ID
Retrieve a deployment.
- Read
Retrieve the agent card by deployment ID
Retrieve the agent card associated with an agent deployment. The agent card is returned by this route as it was returned by the agent during deployment creation or as it was uploaded to DataRobot.
- Read
Retrieve capabilities by deployment ID
Retrieve the capabilities for the deployment.
- Read
Get deployment features by deployment ID
Retrieve features contained within the universe dataset associated with a specific deployment. By default, this returns all raw features required for predictions.
- Read
Retrieve champion model history of deployment by deployment ID
Retrieve champion model history of deployment.
- Read
Retrieve deployment consumers by deployment ID
Retrieve list of unique agents/users that have made requests to this deployment. Only available to deployment owners and users with read permissions.
- Read
Retrieve Scoring Code by deployment ID
Retrieve Scoring Code of the current deployed model for making predictions outside of a DataRobot prediction server. You need the "Scoring Code" feature enabled to use this route.
- Read
Retrieve deployment settings checklist by deployment ID
Return a checklist of deployment settings indicating which settings are configured and which are not.
- Read
List resource bundles.
Retrieve metadata for all resource bundles the user has access to.
- Read
Retrieve resource bundle by resource request bundle ID
Retrieve resource bundle.
- Read
Downloads the latest Portable Prediction Server (PPS) Docker image
Fetches the latest Portable Prediction Server (PPS) Docker image. The resulting image can be docker-loaded. Since the image can be quite large (14GB+) consider querying its metadata to check the image size in advance and content hash to verify the downloaded image afterwards.
- Read
Fetches currently active PPS Docker image metadata
Fetches currently active PPS Docker image metadata
- Write
Create logs by ID
Request logs from a custom deployed model.
- Write
Create deployment
Create a deployment from a DataRobot model. DEPRECATED in v2.37: Register the Leaderboard model with POST /api/v2/modelPackages/fromLeaderboard/. Use the following route to create a deployment POST /api/v2/deployments/fromModelPackage/.
- Write
Create a deployment from a model package
Create a deployment from a model package.
- Write
Update a deployment's prediction environment from dedicated
Update a deployment's prediction environment from dedicated to serverless.
- Write
Update deployment by deployment ID
Update a deployment's label and description.
- Write
Add report by deployment ID
Add report to execution queue.
- Write
Build Java package containing Scoring Code by deployment ID
Build Java package containing Scoring Code with agent integration.
- Write
Change deployment status by deployment ID
Change deployment status.
- Destructive
Erase deleted deployments
Permanently erase data for deleted deployments. Only available as part of an on-premise or private/hybrid cloud deployment. Requires a CANDELETEAPPPROJECTS permission to execute.
PATCH /api/v2/deletedDeployments/ - Destructive
Delete deployment by deployment ID
Delete a deployment.
- Destructive
Create by deployment ID
Upload the agent card for an agent deployment. The request body must be the agent card document as a JSON object. If an agent card already exists for this deployment it will be replaced. This operation is only supported for external deployments.
- Destructive
Delete the agent card by deployment ID
Delete the agent card associated with an external agent deployment. This operation is idempotent - returns 204 even if no agent card exists.
Custom scoring metrics
- Read
List custom scoring metrics.
List all custom scoring metrics, optionally filtered by target type or search.
- Read
Retrieve a custom scoring metric by metric ID
Get details of a single custom scoring metric.
- Read
List versions of a custom scoring metric by metric ID
List all versions for a given custom scoring metric.
- Read
Retrieve a custom scoring metric version by metric ID
Get details of a single custom scoring metric version.
- Read
Retrieve a custom scoring metric version's file contents by metric ID
Get the raw metadata.yaml and custommetrics.py file contents for a specific custom scoring metric version.
- Write
Create a custom scoring metric.
Create a new custom scoring metric container for a given target type.
- Write
Update a custom scoring metric by metric ID
Update the name, description, or tags of a custom scoring metric.
- Write
Upload a new version of a custom scoring metric by metric ID
Upload metadata.yaml and custommetrics.py to create a new version. Files are submitted as multipart form data (metadataFile and codeFile).
- Destructive
Delete a custom scoring metric by metric ID
Archive (soft-delete) a custom scoring metric.
- Destructive
Delete a custom scoring metric version by metric ID
Delete a specific version of a custom scoring metric.
Blueprints
- Read
List custom tasks.
Retrieve metadata for all accessible custom tasks. For more information on custom tasks, access the UI documentation.
- Read
Get custom task by custom task ID
Retrieve metadata for a custom task
- Read
Get a list of users who have access by custom task ID
Get a list of users who have access to this custom task and their roles on it.
- Read
Download the latest custom task version content by custom task ID
Download the latest item bundle from a custom task as a zip compressed archive.
- Read
List custom task versions by custom task ID
List custom task versions.
- Read
Get custom task version by custom task ID
Display a requested version of a custom task along with the files attached to it.
- Read
Retrieve the custom task version's dependency build status by custom task ID
Retrieve the custom task version's dependency build status.
- Read
Retrieve the custom task version's dependency build log by custom task ID
Retrieve the custom task version's dependency build log.
- Read
Download custom task version content by custom task ID
Download a specific item bundle from a custom task as a zip compressed archive.
- Read
List training blueprints.
List custom training blueprints. This route retrieves the metadata for all custom training blueprints a user has access to.
- Read
List of augmentation lists
List of augmentation lists that match the specified query.
- Read
Returns a single augmentation list by augmentation ID
Returns a single augmentation list with the specified id.
- Read
Retrieve latest Augmentation Samples generated by augmentation ID
Retrieve latest Augmentation Samples generated for list
- Read
Augmentation list of all available transformations that are supported by project ID
Augmentation list of all available transformations that are supported in the system.
- Read
(Deprecated in v2 by samples ID
(Deprecated in v2.28) Retrieve previously generated Augmentation Samples. This route is being deprecated please use GET /imageAugmentationLists/ /samples route instead.
- Read
List blueprints by project ID
List appropriate blueprints for the project.
- Read
Retrieve a blueprint by its ID.
Retrieve a blueprint by its ID.
- Read
Retrieve a blueprint chart by blueprint id.
Retrieve a blueprint chart by blueprint id.
- Read
Retrieve blueprint tasks documentation by project ID
Retrieve blueprint tasks documentation.
- Read
Retrieve the JSON representation of a datarobot blueprint by project ID
Retrieve a blueprint json by its ID.
- Read
Retrieve a reduced model blueprint chart by model id.
Retrieve a reduced model blueprint chart by model id. The model blueprint charts are reduced from the full blueprint charts to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.
- Read
Retrieve task documentation by project ID
Retrieve task documentation for a reduced model blueprint. The model blueprint is reduced from the full blueprint to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.
- Read
List user blueprints.
Fetch the list of the user blueprints the current user has access to.
- Read
Retrieve a user blueprint by user blueprint ID
Retrieve a user blueprint.
- Read
Validate many user blueprints.
Validate many user blueprints, optionally using a specific project. Any non-existent or inaccessible user blueprints will be ignored.
- Read
Retrieve input types.
Retrieve the input types which can be used with User Blueprints.
- Read
Validate task parameters.
Validate that each value assigned to specified task parameters are valid.
- Read
Retrieve tasks
Retrieve the available tasks, organized into categories, which can be used to create or modify User Blueprints.
- Read
Validate a user blueprint.
Validate a user blueprint.
- Write
Create a custom task
Creates a new custom task and returns the newly created metadata record for it. A custom task may either be an estimator or a transform. Estimators must support a single target type (e.g., binary classification, regression).
- Write
Clone custom task.
Creates a copy of the provided custom task, including metadata, versions of that task, and uploaded files. Associates the new versions with files owned by the custom task.
- Write
Update custom task by custom task ID
Updates metadata for an existing custom task. All custom tasks must support one target type (e.g. binaryClassification, regression, transform).
- Write
Grant access or update roles by custom task ID
Grant access or update roles for users on this custom task and appropriate learning data. Up to 100 user roles may be set in a single request.
- Write
Create custom task version by custom task ID
Create a new custom task version with attached files if supplied.
- Write
Update custom task version files by custom task ID
Create a new custom task version with files added, replaced or deleted. Files from the previous version of a custom task will be used as a basis.
- Write
Create a version from a repository
Create a new custom task version with only files added from the specified remote repository.
- Write
Create custom task version from remote repository by custom task ID
Create a new custom task version with files added from a remote repository. Files from the previous version of a custom task will be used as a basis.
- Write
Update custom task version by custom task ID
Edit metadata of a specific task version.
- Write
Start a custom task version's dependency build by custom task ID
Start a custom task version's dependency build. This is required to test, deploy, or train custom tasks.
- Write
Create a blueprint
This route creates a blueprint from a custom training estimator with an environment so that it can be trained via blueprint ID.
- Write
Creates a new augmentation list based
Creates a new augmentation list based on the posted payload data.
- Write
Update an existing augmentation list by augmentation ID
Update an existing augmentation list, with passed in values.
- Write
Requests the creation of sample augmentations based by augmentation ID
This endpoint will schedule a job to augment the specified images from a project's dataset and return a link to monitor the status of the job, as well as a link to retrieve the resulting augmented images.
- Write
(Deprecated in v2
(Deprecated in v2.28) This endpoint will schedule a job to augment the specified images from a project's dataset and return a link to monitor the status of the job, as well as a link to retrieve the resulting augmented images.
- Write
Create a user blueprint.
Create a user blueprint.
- Write
Clone a blueprint
Clone a blueprint from a project.
- Write
Create a user blueprint
Create a user blueprint from a single custom task.
- Write
Clone a user blueprint.
Clone a user blueprint.
- Write
Update a user blueprint by user blueprint ID
Update a user blueprint.
- Write
Add user blueprints
Add the list of user blueprints, by ID, to a specified (by ID) project's repository.
- Destructive
Delete custom task by custom task ID
Delete a custom task. Only users who have permission to edit custom task can delete it. Only custom tasks which are not currently deployed, used in a blueprint, or in the AIcatalog can be deleted. Relevant CustomTaskImage will be deleted also.
- Destructive
Cancel dependency build by custom task ID
Cancel the custom task version's dependency build.
- Destructive
Delete an existing augmentation lists by id by augmentation ID
Delete an existing augmentation lists by id
- Destructive
Delete user blueprints.
Delete user blueprints, specified by userBlueprintIds.
- Destructive
Delete a user blueprint by user blueprint ID
Delete a user blueprint, specified by the userBlueprintId.
Insights
- Read
Retrieve a Data Slice by data slice ID
Returns details about the specified data slice ID.
- Read
Returns the number of rows available after applying a data slice by data slice ID
Returns the number of rows available after applying a data slice to the specified subset of the dataset.
- Read
The list of paginated Confusion Matrix chart insights by entity ID
The list of paginated Confusion Matrix chart insights.
- Read
The list of paginated Feature Effects insights by entity ID
The list of paginated Feature Effects insights.
- Read
The list of paginated Feature Impact insights by entity ID
The list of paginated Feature Impact insights.
- Read
The list of paginated lift chart insights by entity ID
The list of paginated lift chart insights.
- Read
The list of paginated Residuals insights by entity ID
The list of paginated Residuals insights.
- Read
The list of paginated ROC curve insights by entity ID
The list of paginated ROC curve insights.
- Read
The list of paginated SHAP Distributions insights by entity ID
The list of paginated SHAP Distributions insights.
- Read
The list of paginated SHAP Impact insights by entity ID
The list of paginated SHAP Impact insights.
- Read
The list of paginated SHAP Matrix insights by entity ID
The list of paginated SHAP Matrix insights.
- Read
The list of paginated SHAP Preview insights by entity ID
The list of paginated SHAP Preview insights.
- Read
Retrieve multicategorical feature histogram by multilabelinsightskey
Retrieve multicategorical feature histogram.
- Read
Get all label lists by multilabelinsightskey
Get all label lists.
- Read
Retrieve pairwise statistics by multilabelinsightskey
Retrieve multilabel specific pairwise label statistics for the given multilabel insights key: correlation, joint probability and conditional probability.
- Read
Retrieve anomaly assessment records by project ID
Retrieve anomaly assessment records.
- Read
Retrieve anomaly assessment record by project ID
Retrieve anomaly assessment record. Two out of three parameters: startDate, endDate or pointsCount must be specified.
- Read
Retrieve predictions preview by project ID
Retrieve predictions preview for the anomaly assessment record.
- Read
List Bias vs Accuracy insights by project ID
Retrieve a list of Bias vs Accuracy insights for the model.
- Read
List paginated Data Slices by project ID
Returns a paginated list of data slices for the given project ID.
- Read
Retrieve the data by project ID
Retrieve the data for the Accuracy over Time plots.
- Read
Retrieve the metadata by project ID
Retrieve the metadata for the Accuracy over Time insights.
- Read
Retrieve the preview by project ID
Retrieve the preview for the Accuracy over Time plots.
- Read
Retrieve anomaly over time plots by ID
Retrieve the data for the Anomaly over Time plots.
- Read
Retrieve metadata by ID
Retrieve the metadata for the Anomaly over Time insights.
- Read
Retrieve preview by ID
Retrieve the preview for the Anomaly over Time plots.
- Read
Retrieve a plot displaying the stability of the datetime model across by project ID
Retrieve a plot displaying the stability of the datetime model across different backtests. All durations and datetimes should be specified in accordance with the :ref:timestamp and duration formatting rules .
- Read
Retrieve the Accuracy Over Time (AOT) chart data by project ID
Retrieve the Accuracy Over Time (AOT) chart data for an external dataset for a project. Datetimes are specified in accordance with. :ref:timestamp and duration formatting rules .
- Read
Retrieve the metadata of the Accuracy Over Time (AOT) chart by project ID
Retrieve the metadata of the Accuracy Over Time (AOT) chart for an external dataset. Datetimes are specified in accordance with. :ref:timestamp and duration formatting rules .
- Read
Retrieve a preview of the Accuracy Over Time (AOT) chart by project ID
Retrieve a preview of the Accuracy Over Time (AOT) chart for an external dataset. Datetimes are specified in accordance with. :ref:timestamp and duration formatting rules .
- Read
Retrieve Feature Effects by project ID
Retrieve Feature Effects for a model backtest. Feature Effects provides partial dependence and predicted vs actual values for the top 500 features, ordered by feature impact score.
- Read
Retrieve Feature Effects metadata for each backtest by project ID
Retrieve Feature Effects metadata for each backtest. Response contains status and available sources for each backtest of the model. One of the provided backtestIndex indexes used for submitting the compute request and retrieving Feature Effects.
- Read
Retrieve a plot displaying the stability of the time series model across by project ID
Retrieve a plot displaying the stability of the time series model across different forecast distances. .. note:: All durations and datetimes are specified in accordance with the :ref:timestamp and duration formatting rules .
- Read
Retrieve forecast vs actual plots by ID
Retrieve the data for the Forecast vs Actual plots.
- Read
Retrieve metadata by ID
Retrieve the metadata for the Forecast vs Actual insights.
- Read
Retrieve preview by ID
Retrieve the preview for the Forecast vs Actual plots.
- Read
Retrieve feature effects by project ID
Retrieve feature effects for each class in a multiclass datetime model.
- Read
Retrieve the histograms by project ID
Retrieve the histograms for series insights. Histogram is computed only for first 1000 series (ordered by name).
- Read
List the scores per individual series by project ID
List the scores per individual series for the specified multiseries model.
- Read
Retrieve the CSV file by project ID
Retrieve the CSV file for the series accuracy.
- Read
The list of scores on prediction datasets by project ID
The list of scores on prediction datasets for a project with filtering option by dataset, model, or both. A prediction dataset may have scores if it contained a column with actual values and predictions were computed on this dataset.
- Read
List all featurelists with feature association matrix availability flags by project ID
List all featurelists with feature association matrix availability flags for a project.
- Read
Retrieve pairwise feature association statistics by project ID
Retrieval for pairwise feature association statistics. Projects created prior to v2.17 are not supported by this feature.
- Read
Retrieval by project ID
Retrieval for feature association plotting between a pair of features. Projects created prior to v2.17 are not supported by this feature.
- Read
Retrieve the frequent values information by project ID
Retrieve the frequent values information for a particular feature. Only valid for numeric features. This route returns information about the frequent values seen for a particular feature, based on the EDA sample of the dataset.
- Read
Retrieve a map of one location feature by project ID
Retrieve a map of one location feature.
- Read
List all Image Activation Maps by project ID
List all Image Activation Maps for the project.
- Read
Retrieve a CSV file of the raw data displayed by project ID
Retrieve a CSV file of the raw data displayed with the anomaly score from the specific model. The number of rows included will be set by the expected outlier fraction but up to a maximum of 1000 rows. Only models built from anomaly detection blueprints have those insights.
- Read
Retrieve a table of the raw data displayed by project ID
Retrieve a table of the raw data displayed with the anomaly score from the specific model. The number of rows displayed is limited to 100 rows by the ANOMALYINSIGHTSAMPLEROWCOUNT configuration setting.
- Read
Retrieve Cluster Insights by project ID
Retrieve all computed Cluster Insights for a clustering project model.
- Read
Download Cluster Insights result by project ID
Download all computed Cluster Insights for a clustering project model.
- Read
Retrieve all available confusion charts by project ID
Retrieve all available confusion charts for model. The response will include a json array of all available confusion charts, in the same format as the response from :http:get:/api/v2/projects/(projectId)/models/(modelId)/confusionCharts/(source)/. ..
- Read
Retrieve the confusion chart data by project ID
Retrieve the confusion chart data from a single source. A confusion chart consists of the confusion matrix for all classes, classes frequencies and oneVsAll metrics for all classes.
- Read
Calculates and sends frequency of class in distributed among other classes by project ID
Calculates and sends frequency of class in distributed among other classes for actual and predicted data. A confusion chart class details for given class gives stats of misclassification done by model for given class for actual and predicted data. ..
- Read
Retrieve metadata by project ID
Retrieve metadata for the confusion chart of a model. .. note:: Available for multiclass projects only.
- Read
List Cross Class Accuracy scores by project ID
Retrieves a list of Cross Class Accuracy scores for the model.
- Read
Get Cross Class Data Disparity results by project ID
Retrieve a list of Cross Class Data Disparity insights for the model.
- Read
List of Confusion Charts objects on external datasets by project ID
List of Confusion Charts objects on external datasets for a project with filtering option by dataset. Prediction dataset may have Confusion Chart for multiclass projects computed if it contained a target with actual values and insights were computed on this dataset.
- Read
Retrieve Confusion Chart objects on external datasets by project ID
Retrieve Confusion Chart objects on external datasets for a project. Prediction dataset may have Confusion Chart for multiclass projects computed if it contained a target with actual values and insights were computed on this dataset.
- Read
Calculate and sends frequency of class in distributed among other classes by project ID
Calculate and sends frequency of class in distributed among other classes for actual and predicted data. A confusion chart class details for given class gives stats of misclassification done by model for given class for actual and predicted data.
- Read
Retrieve metadata by ID
Retrieve metadata for the confusion chart of a model on external dataset for a project. Available for multiclass projects only.
- Read
Retrieve List of Lift chart data on prediction datasets by project ID
List of Lift chart objects on prediction datasets for a project with filtering option by dataset. Prediction dataset may have Lift chart computed if it contained a column with actual values and predictions were computed on this dataset.
- Read
Retrieve List of Multiclass Lift chart data on prediction datasets by project ID
List of Multiclass Lift chart objects on prediction datasets for a project with filtering option by dataset. Prediction dataset may have Multiclass Lift chart computed if it contained a column with actual values and predictions were computed on this dataset.
- Read
The list of residuals chart objects by project ID
List of residuals charts objects on prediction datasets for a project with filtering option by dataset. Prediction dataset may have residuals chart computed if it contained a column with actual values and predictions were computed on this dataset.
- Read
List of ROC curve objects on prediction datasets for a project with filtering option by DEPRECATED by project ID
List of ROC curve objects on prediction datasets for a project with filtering option by dataset. Prediction dataset may have ROC curve computed if it contained a column with actual values and predictions were computed on this dataset.
- Read
List calculated Per Class Bias insights by project ID
Retrieve a list of Per Class Bias insights for the model.
- Read
Retrieve feature effects by ID
Retrieve Feature Effects for the model. Feature Effects provides partial dependence and predicted vs actual values for the top 500 features, ordered by feature impact score.
- Read
Retrieve Feature Effects metadata by project ID
Retrieve Feature Effects metadata. Response contains status and available sources. One of the provided source parameters used for retrieving Feature Effects. Source can be, at a minimum, training or validation.
- Read
Retrieve feature impact scores by project ID
Retrieve feature impact scores for features in a model. Feature Impact is computed for each column by creating new data with that column randomly permuted (but the others left unchanged), and seeing how the error metric score for the predictions is affected.
- Read
Retrieve cluster insights by ID
Retrieve computed Cluster Insights for a clustering project model on a single featurelist.
- Read
Retrieve Image Activation Maps by project ID
Retrieve Image Activation Maps for a feature of a model. Image Activation maps are a technique to get the discriminative image regions used by a CNN to identify a specific class in the image.
- Read
Retrieve labelwise ROC curves by project ID
Retrieve labelwise ROC curves for model and given source.
- Read
Retrieve all available lift charts by project ID
Retrieve all available lift charts for model. The response will include a json list of all available lift charts, in the same format as the response from :http:get:/api/v2/projects/(projectId)/models/(modelId)/liftChart/(source)/.
- Read
Retrieve the lift chart data by project ID
Retrieve the lift chart data from a single source.
- Read
Retrieve multiclass feature effects by ID
Retrieve feature effects for each class in a multiclass model.
- Read
Retrieve multiclass feature impact by ID
Retrieve feature impact scores for each class in a multiclass model. Feature Impact is computed for each column by creating new data with that column randomly permuted (but the others left unchanged), and seeing how the error metric score for the predictions is affected.
- Read
Retrieve multiclass lift chart by ID
Retrieve all available lift charts for multiclass model.
- Read
Retrieve the multiclass lift chart data by project ID
Retrieve the multiclass lift chart data from a single source.
- Read
Retrieve labelwise lift charts by project ID
Retrieve labelwise lift charts for model and given source.
- Read
Retrieve all residuals charts by project ID
Retrieve all residuals charts for a model.
- Read
Retrieve the residuals chart data by project ID
Retrieve the residuals chart data from a single source.
- Read
Retrieve all available ROC curves by project ID
Retrieve all available ROC curves for model. The response will include a json list of all available ROC curves, in the same format as the response from :http:get:/api/v2/projects/(projectId)/models/(modelId)/rocCurve/(source)/.
- Read
Retrieve the ROC curve data by project ID
Retrieve the ROC curve data from a single source. The response includes an array of pointsshowing the performance of the model at different thresholds for classification, and arrays of sample predictions for both the positive and negative classes.
- Read
Retrieve Feature Impact for a model by project ID
Retrieve Feature Impact for a model. SHAP impact is computed by calculating the shap values on a sample of training data and then taking the mean absolute value for each column. The larger the impact value, the more important the feature.
- Read
Retrieve word cloud data by project ID
Retrieve word cloud data for a model. Not all models will have word cloud data available, even when they use text features.
- Read
Retrieve multicategorical data quality log by project ID
Retrieve multicategorical data quality log.
- Read
Get file by project ID
Get file with format errors of potential multicategorical features.
- Read
List all payoff matrices by project ID
List all payoff matrices for a project.
- Read
List rating table models by project ID
Lists all the models from a project that have rating tables.
- Read
Retrieve a rating table model by project ID
Look up a particular rating table model.
- Read
List rating tables by project ID
List rating table objects for a project. These contain metadata about the rating table and the location at which the corresponding rating table file can be retrieved.
- Read
Retrieve rating table information by project ID
Retrieves a rating table.
- Read
Retrieve the rating table file by project ID
Retrieve the CSV file for the rating table.
- Read
List SHAP matrix records by project ID
Return a list of available SHAP matrix records. DEPRECATED: Use the componentized route instead: :http:get:/api/v2/insights/shapMatrix/models/(entityId)/
- Read
Return matrix with SHAP-based prediction explanations scores by project ID
Return matrix with SHAP-based prediction explanations scores. DEPRECATED: Use the componentized route instead: :http:get:/api/v2/insights/shapMatrix/models/(entityId)/
- Write
Request
Request to create a new data slice.
- Write
Compute the number of rows available after applying a data slice by data slice ID
Compute the number of rows available after applying a data slice to the specified subset of the dataset.
- Write
Request calculation of Confusion Matrix chart
Request calculation of insight with an optional data slice.
- Write
Request calculation of Feature Effects
Request calculation of Feature Effects with an optional data slice.
- Write
Request calculation of Feature Impact
Request calculation of insight with an optional data slice.
- Write
Request calculation of Lift chart
Request calculation of insight with an optional data slice.
- Write
Request calculation of Residuals chart
Request calculation of insight with an optional data slice.
- Write
Request calculation of ROC curve
Request calculation of insight with an optional data slice.
- Write
Request calculation of SHAP Distributions
Request calculation of insight with an optional data slice.
- Write
Request calculation of SHAP Impact
Request calculation of insight with an optional data slice.
- Write
Request calculation of SHAP Matrix
Request calculation of insight with an optional data slice.
- Write
Request calculation of SHAP Preview
Request calculation of insight with an optional data slice.
- Write
Save a list of manually selected labels by multilabelinsightskey
Save a list of manually selected labels for Feature Statistics matrix.
- Write
Update the label list name by multilabelinsightskey
Update the label list name.
- Write
Computes Datetime Trend plots by project ID
Computes Datetime Trend plots for time series and OTV projects: For OTV projects, computes Accuracy over Time plots. For time series supervised projects, computes both Accuracy over Time plots and Forecast vs Actual plots. ..
- Write
Add a request by project ID
Add a request to the queue to calculate Feature Effects for a backtest. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.
- Write
Compute feature effects by project ID
Compute feature effects for a multiclass datetime model. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.
- Write
Request the computation of per-series scores by project ID
Request the computation of per-series scores for a multiseries model. .. note:: Computation uses available partitions only. This endpoint will not compute backtesting scores if no backtesting scores exist prior to this request.
- Write
Compute model scores by project ID
Compute model scores for external dataset, first upload your dataset to the project, and then using the corresponding datasetId, compute scores against that dataset.
- Write
Compute the feature association matrix by project ID
Compute the feature association matrix for the given featurelist.
- Write
Create a map of one location feature by project ID
Create a map of one location feature.
- Write
Calculate the anomaly assessment insight by project ID
Initialize the anomaly assessment insight and calculate Shapley explanations for the most anomalous points in the subset. The insight is available for anomaly detection models in time series unsupervised projects which also support calculation of Shapley values.
- Write
Compute Cluster Insights by project ID
Compute Cluster Insights for a clustering project model.The number of features computed for cluster insights are capped at 100, starting with the features used to train the model sorted by feature impact (high to low), and then the remaining features in the dataset alphabeticall…
- Write
Start Cross Class Accuracy calculations by project ID
Submits a job to start Cross Class Accuracy scores calculations for the model.
- Write
Start insight calculations by project ID
Submits a job to start Cross Class Data Disparity insight calculations.
- Write
Create fairness insights by ID
Submits a job to start Per Class Bias insight calculations for the model.
- Write
Create feature effects by ID
Add a request to the queue to calculate Feature Effects. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.
- Write
Create feature impact by ID
Add a request to calculate feature impact to the queue. If the job has been previously submitted, the request will fail and return the jobId of previously submitted job. This jobId can be used to check status of previously submitted job.
- Write
Request the computation of image activation maps by project ID
Request the computation of image activation maps for the specified model.
- Write
Create multiclass feature effects by ID
Compute feature effects for a multiclass model. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.
- Write
Create SHAP-based Feature Impact by project ID
Create SHAP-based Feature Impact for the model. DEPRECATED: Use the componentized route instead: :http:post:/api/v2/insights/shapImpact/
- Write
Create a payoff matrix by project ID
Create a payoff matrix associated with a project.
- Write
Create new models by project ID
Create a new rating table model from a validated rating table record
- Write
Upload a modified rating table file by project ID
Create a new rating table from a rating table file This will create a new rating table, regardless of whether the validation succeeds. The rating table object will have a validationError which will be left blank in the case of successful validation.
- Write
Update an uploaded rating table by project ID
Rating tables may only be updated if they have not yet been used to create a model.
- Write
Calculate a matrix with SHAP-based prediction explanations scores by project ID
Submit a request to calculate a matrix with SHAP based prediction explanations scores. DEPRECATED: Use the componentized route instead: :http:post:/api/v2/insights/shapMatrix/
- Destructive
Data slices bulk deletion.
Data slices bulk deletion.
- Destructive
Delete a data slice by data slice ID
Deletes the data slice specified by the data slice ID.
- Destructive
Delete insights by insightname
Delete insights for a specific model.
- Destructive
Delete the label list by multilabelinsightskey
Delete the label list.
- Destructive
Delete the anomaly assessment record by project ID
Delete the anomaly assessment record.
- Destructive
Update a payoff matrix by project ID
Update all fields in a payoff matrix, including values and label.
- Destructive
Delete a payoff matrix by project ID
Delete a payoff matrix in a project.
Dataset definition
- Read
List all dataset definitions
List all dataset definitions.
- Read
Retrieve a dataset definition based by dataset definition ID
Retrieve a dataset definition.
- Read
Retrieve a list chunk definitions by dataset definition ID
Retrieve a list chunk definitions.
- Read
Retrieve a chunk definition based by dataset definition ID
Retrieve a chunk definition.
- Read
List all dataset definition versions by dataset definition ID
List all dataset definition versions.
- Write
Create a dataset definition.
Create a dataset definition.
- Write
Analyze a dataset definition by dataset definition ID
Analyze a dataset definition.
- Write
Create a chunk definition based by dataset definition ID
Create a chunk definition.
- Write
Update a chunk definition based by dataset definition ID
Update a chunk definition.
- Write
Analyze a chunk definition by dataset definition ID
Analyze a chunk definition.
- Destructive
Soft delete a dataset definition based by dataset definition ID
Soft delete a dataset definition.
- Destructive
Soft delete a chunk definition based by dataset definition ID
Soft delete a chunk definition.
Projects
- Read
Retrieve the list of soft-deleted projects.
Retrieve a list of soft-deleted projects matching search criteria
- Read
Count soft-deleted projects.
Get current number of deleted projects matching search criteria. Value is limited by DELETEDPROJECTSBATCHLIMIT system setting. That means that the actual amount of deleted projects can be greater than the limit, but counting will stop when reaching it.
- Read
Retrieve project permadelete job status.
Get async status of the project permadelete job.
- Read
Retrieve project permadelete job status by status ID
Get async status of the project permadelete job.
- Read
Download a projects permadeletion report by status ID
Get a file containing a per-project report of permanent deletion.
- Read
Get a projects cleanup jobs summary by status ID
Get number of projects whose deletion finished in particular state
- Read
List projects.
List all available projects.
- Read
Get project by project ID
Look up a particular project.
- Read
Get the project access control list by project ID
Get a list of users who have access to this project and their roles on the project.
- Read
Retrieve datetime partitioning configuration by project ID
Retrieve datetime partitioning configuration The datetime partition object in the response describes the full partitioning parameters.
- Read
Preview the fully specified datetime partitioning generated by the requested configuration by project ID
Preview the fully specified datetime partitioning generated by the requested configuration.
- Read
Validate baseline data by project ID
This route validates if a provided catalog version id can be used as baseline for calculating metrics.
- Read
Retrieve the baseline validation job by project ID
Retrieve information to confirm if the validation job triggered via /api/v2/projects/(projectId)/externalTimeSeriesBaselineDataValidationJobs/ is valid.
- Read
List project jobs by project ID
List the project's jobs.
- Read
Get a job by project ID
Retrieve details for a job that has been started but has not yet completed.
- Read
Retrieve eligible cross-series group-by columns by project ID
Retrieve eligible cross-series group-by columns. Note that validation will have to have been triggered via :http:post:/api/v2/projects/(projectId)/crossSeriesProperties/ in order for results to appear here.
- Read
List the names of a multiseries project by project ID
List the individual series names of a multiseries project.
- Read
Lists all created optimized datetime partitioning configurations by project ID
Lists all created optimized datetime partitioning configurations.
- Read
Retrieve the optimized datetime partitioning configuration by project ID
Retrieve optimized datetime partitioning configuration The optimized datetime partition objects are structurally identical to the original datetime partition objects, however they are retrieved from a mongo database after creation as opposed to being calculated synchronously.
- Read
Retrieve the optimized datetime partitioning input by project ID
Retrieve optimized datetime partitioning input The datetime partition object in the response describes the inputs used to create the full partitioning object.
- Read
Retrieve the datetime partitioning log by project ID
Retrieve the datetime partitioning log content and log length for an optimized datetime partitioning as JSON. The Date/Time Partitioning Log provides details about the partitioning process for an OTV or Time Series project.
- Read
Retrieve a text file containing the datetime partitioning log by project ID
Retrieve a text file containing the datetime partitioning log. The Date/Time Partitioning Log provides details about the partitioning process for an OTV or Time Series project.
- Read
Retrieve segmentation task statuses by project ID
Retrieve the statuses of segmentation task jobs associated with the ID.
- Read
List segmentation tasks by project ID
List all segmentation tasks created for the project.
- Read
Retrieve segmentation task by project ID
Retrieve information about a segmentation task.
- Read
Retrieve series ID by project ID
Retrieve the series ID to segment ID mappings for a segmentation task.
- Read
Check project status by project ID
Check the status of a project.
- Write
Recover soft-deleted project by project ID
Recover (undelete) soft-deleted project.
- Write
Create a project
Create a project from an HDFS file via WebHDFS API. Represent the file using URL, optionally, port, and optionally, user/password credentials. For example, {"url": "hdfs:// /path/to/file.csv", "port": "50070"}.
- Write
Schedule project permadelete job.
Add list of projects to permadelete and returns async status
- Write
Clone a project.
Create a clone of an existing project. The resultant project will begin the initial exploratory data analysis and will be ready to set the target of the new project shortly.
- Write
Create a project.
Create a new project.
- Write
Update a project by project ID
Change project name, worker count, or unlock the holdout. If any of the optional json arguments are not provided, that aspect of the project will not be altered.
- Write
Update the project's access controls by project ID
Set roles for users on this project.
- Write
Start modeling by project ID
Start the data modeling process.
- Write
Pause by project ID
Pause or unpause the autopilot for a project.
- Write
Start autopilot by project ID
Start autopilot on provided featurelist.
- Write
Detect multiseries properties by project ID
Analyze relationships between potential partition and multiseries ID columns. Time series projects require that each timestamp have at most one row corresponding to it.
- Write
Create an optimized datetime partitioning configuration using the target by project ID
Create an optimized datetime partitioning configuration using the target. Initializes a job to construct an optimized datetime partitioning using the date and target information to ensure that backtests sufficiently cover regions of interest in the target.
- Write
Create segmentation tasks by project ID
Create segmentation tasks for the dataset used in the project.
- Write
Update child segment project by project ID
The only supported operation right now is segment restart, which removes existing child segment project and starts another child project instead for the given segment. Should be only used for child segments which are stuck during project startup or upload.
- Destructive
Cancel scheduled project permadelete job by status ID
Stop permadelete job, if possible.
- Destructive
Delete a project by project ID
Delete a project.
- Destructive
Cancel a job by project ID
Cancel a pending job.
Observability accuracy
- Read
Retrieve accuracy metric by deployment ID
Retrieve accuracy metric for a certain time period.
- Read
Endpoint by deployment ID
Retrieve information about which accuracy metrics will be displayed and in what order.
- Read
Accuracy over batch by deployment ID
Retrieve accuracy metric baseline, and metric value calculated for each batch.
- Read
Retrieve accuracy over space by deployment ID
Retrieve accuracy metric baseline, and metric value calculated for each geospatial h3 hexagon.
- Read
Retrieve accuracy over time by deployment ID
Retrieve accuracy metric baseline, and metric value calculated for each time bucket dividing a longer time period.
- Read
Retrieve metrics about predictions and actuals, such as mean predicted & actual value, predicted & by deployment ID
Retrieve metrics about predictions and actuals, such as mean predicted & actual value, predicted & actual class distribution, over a specific set of batches.
- Read
Retrieve predictions vs by deployment ID
Retrieve predictions vs. actuals over space.
- Read
Retrieve predictions vs actuals over time info by deployment ID
Retrieve metrics about predictions and actuals, such as mean predicted & actual value, predicted & actual class distribution, over a specific time range.
- Destructive
Update deployment accuracy metrics settings by deployment ID
Update accuracy metrics being returned in accuracy endpoint.
Observability configuration
- Read
Retrieve Segment attributes by ID
Retrieve deployment segment attributes.
- Read
Retrieve Segment values by ID
Retrieve deployment segment values.
- Write
Submit actuals values by deployment ID
Submit actuals values for processing using catalog item. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals number of forecast distances.
- Write
Create a actuals from a JSON
Submit actuals values for processing. Values are not processed immediately and may take some time to propagate through deployment systems. Submission of actuals is limited to 10,000,000 actuals per hour.
- Write
Endpoint by deployment ID
Delete deployment monitoring data.
Observability data exploration
- Read
Retrieve a list of asynchronous actuals data exports by deployment ID
Retrieve a list of asynchronous actuals data exports.
- Read
Retrieve a single actuals data export by deployment ID
Retrieve a single actuals data export.
- Read
Retrieve metadata of the data by deployment ID
Retrieve metadata of the data to be exported.
- Read
A list prediction data exports by deployment ID
A list of asynchronous prediction data exports.
- Read
Retrieve a single prediction data export by deployment ID
Retrieve a single prediction data export.
- Read
Retrieve predictions results by deployment ID
Retrieve predictions results of the deployment.
- Read
The list of training data exports by deployment ID
A list of successful training data exports.
- Read
Retrieve details by deployment ID
Retrieve details for a single training data export.
- Write
Create a deployment actuals data export by deployment ID
Create a deployment actuals data export.
- Write
Update actuals data export by deployment ID
Update actuals data export.
- Write
Create a deployment prediction data export by deployment ID
Create a deployment prediction data export.
- Write
Update prediction data export by deployment ID
Update prediction data export.
- Write
Create a deployment training data export by deployment ID
Create a deployment training data export.
- Destructive
Delete an actual export by deployment ID
Delete an actual export.
Observability service health
- Read
Retrieve service health metrics by deployment ID
Retrieve all deployment service health metrics over a set of batches.
- Read
Retrieve service stats by ID
Retrieve all deployment service health metrics over a single period of time.
- Read
Retrieve service health metric over batch by deployment ID
Retrieve values for one single deployment service health metric over batch.
- Read
Retrieve service health metric over time by deployment ID
Retrieve values for one single deployment service health metric over time.
Mitigation challenger models
- Read
Retrieve challenger replay settings by deployment ID
Retrieve challenger replay settings.
- Read
List challenger models by deployment ID
List challenger models for deployment.
- Read
Get challenger model by deployment ID
Retrieve challenger model.
- Read
Retrieve information about the champion model package by deployment ID
Retrieve information about the champion model package
- Write
Score challenger models by deployment ID
Score main model prediction requests against challenger model requests.
- Write
Update challenger replay settings by deployment ID
Update challenger replay settings.
- Write
Create challenger model by deployment ID
Create new challenger model.
- Write
Update challenger model by deployment ID
Update challenger model.
- Destructive
Delete challenger model by deployment ID
Delete challenger model.
Observability bias fairness
- Read
Retrieve fairness over time info of the deployment by deployment ID
Retrieve fairness scores for all features, or for different classes of a single feature changes over a specific time period.
Observability drift
- Read
Retrieve feature drift scores by deployment ID
Retrieve drift scores for features of the deployment.
- Read
Retrieve drift over batch info by deployment ID
Retrieve drift over batch info for a feature of the deployment.
- Read
Retrieve feature drift scores over space through geospatial monitoring by deployment ID
Retrieve drift scores for a feature of the deployment over the geospatial feature data.
- Read
Retrieve drift over time info by deployment ID
Retrieve drift over time info for a feature of the deployment.
- Read
Retrieve prediction metadata over batches by deployment ID
Retrieve metrics about predictions, such as row count, mean predicted value, mean probabilities, and class distribution, over batches.
- Read
Retrieve predictions stats over space through geospatial monitoring by deployment ID
Retrieve predictions stats for the deployment over the geospatial feature data.
- Read
Retrieve metrics about predictions over time by deployment ID
Retrieve metrics about predictions, such as row count, mean predicted value, mean probabilities, and class distribution, over a specific time range.
- Read
Retrieve target drift by deployment ID
Retrieve target drift data.
Deployment configuration
- Read
Retrieve deployment health settings by deployment ID
Retrieve deployment health settings.
- Read
Retrieve default deployment health settings by deployment ID
Retrieve default deployment health settings.
- Read
Retrieve secondary datasets configuration by deployment ID
Retrieve the secondary datasets configuration used by a deployed Feature Discovery model.
- Read
List the secondary datasets configuration history by deployment ID
List all the secondary datasets configuration used by a given Feature Discovery deployment.
- Read
Retrieve deployment settings by deployment ID
Retrieve deployment settings.
- Write
Update deployment health settings by deployment ID
Update deployment health settings.
- Write
Update the secondary datasets configuration by deployment ID
Update the secondary datasets configuration used by the deployed feature discovery model.
- Write
Update deployment settings by deployment ID
Updates deployment settings.
Mitigation humility
- Read
Retrieve humility stats by deployment ID
Retrieve humility rule service triggers statistics overview.
- Read
Retrieve humility stats over time by deployment ID
Retrieve humility service statistics over time.
Deployment model replacement
- Write
Model Replacement by deployment ID
Replace the model used to make predictions for the deployment. A validation process will be performed to make sure the new model is eligible as a replacement.
- Write
Model Replacement Validation by deployment ID
Validate that a model can be used to replace the current model of the deployment.
Observability batch monitoring
- Read
Get the limits related by deployment ID
Get the limits related to monitoring batches.
- Read
List monitoring batches by deployment ID
List monitoring batches in a deployment.
- Read
Retrieve a monitoring batch by deployment ID
Retrieve a monitoring batch in a deployment.
- Read
List information about models that have data by deployment ID
List information about models that have data in a monitoring batch.
- Read
Get information about a model that has data by deployment ID
Get information about a model that has data in a monitoring batch.
- Write
Create a monitoring batch by deployment ID
Create a monitoring batch for a deployment.
- Write
Update a monitoring batch by deployment ID
Update a monitoring batch in a deployment.
- Write
Update information about model data by deployment ID
Update information about model data in a batch.
- Destructive
Delete a monitoring batch by deployment ID
Delete a monitoring batch in a deployment.
Tracking agent
- Write
Submit external deployment prediction data by deployment ID
Assigns prediction dataset to the external deployment to enable the analysis of historical model performance. Multiple datasets containing historical predictions for the external deployment can be uploaded. This requires one request for each dataset.
Mitigation retraining
- Read
Endpoint by deployment ID
Retrieve a list of deployment retraining policies.
- Read
Retrieve retraining policies by ID
Retrieve a deployment retraining policy.
- Read
Retrieve runs by ID
Retrieve a list of deployment retraining policy runs.
- Read
Retrieve runs by ID
Retrieve a single deployment retraining policy run.
- Read
Retrieve retraining settings by ID
Retrieve deployment retraining settings.
- Write
Create retraining policies by ID
Create a deployment retraining policy.
- Write
Modify retraining policies by ID
Update a deployment retraining policy.
- Write
Create runs by ID
Initiate a deployment retraining policy run.
- Write
Modify runs by ID
Update a single deployment retraining policy run.
- Write
Modify retraining settings by ID
Update deployment retraining settings.
- Destructive
Delete retraining policies by ID
Delete a deployment retraining policy.
Deployment runtime parameters
- Read
List runtime parameters by deployment ID
List runtime parameters.
- Destructive
Update runtime parameters by deployment ID
Update runtime parameters by replacing existing params with the provided set. Any values not provided will revert back to the values set from the model package.
Entitlements
- Read
Retrieve entitlement set leases.
Retrieve entitlement set leases with optional filtering by tenant, entitlement set, and status.
- Write
Apply entitlement set leases.
Request temporary entitlement leases for users within a tenant.
- Write
Evaluate entitlements.
Evaluate entitlements of the client requesting the API.
Notifications
- Read
List notification channels related by relatedentitytype
List the notification channels related to the entity according to the query.
- Read
Retrieve an entity notification channel by relatedentitytype
Retrieve the entity notification channel.
- Read
List entity notification policies by relatedentitytype
List the entity notification policies that satisfy the query condition.
- Read
Retrieve an entity notification policy by relatedentitytype
Retrieve the entity notification policy.
- Read
List entity notification policy templates by relatedentitytype
List the entity notification policies templates that satisfy the query condition.
- Read
Retrieve an entity notification policy template by relatedentitytype
Retrieve the entity notification policy template.
- Read
Retrieve list of all policies that are created from this template and are visible by relatedentitytype
Retrieve list of all policies that are created from this template and are visible for user
- Read
List notification channel templates.
List the notification channel template according to the query.
- Read
Retrieve a notification channel template by channel ID
Retrieve the notification channel template.
- Read
Retrieve list of all policy templates that are using this channel and are visible by channel ID
Retrieve list of all policy templates that are using this channel and are visible for user
- Read
Retrieve list of all policies that are created from this template and are visible by channel ID
Retrieve list of all policies that are created from this template and are visible for user
- Read
List notification channels.
List the notification channels according to the query.
- Read
Retrieve a notification channel by channel ID
Retrieve the notification channel.
- Read
Retrieve the status of whether the admin entered the code correctly.
Retrieve the status of whether the admin entered the code correctly.
- Read
The list of event types and groups the user can include
The list of event types and groups the user can include in notification policies. Events and groups are filtered by user permissions and event properties. It is not a complete list of all defined events; instead, it is the list of the events available to the user.
- Read
List the notification logs.
List the notification logs that correspond to provided conditions. Default ordering is desc by notification log timestamp
- Read
List notification policies.
List the notification policies that satisfy the query condition.
- Read
Retrieve a notification policy by policy ID
Retrieve the notification policy.
- Read
The list of the ignored notifications filtered by org ID if provided.
The list of the ignored notifications filtered by org ID if provided.
- Read
Retrieve the status of the notification channel test by notification ID
Retrieve the status of the notification channel test.
- Read
The list of user notifications.
The list of the user's notifications from latest to oldest.
- Write
Create an entity notification channel.
Create a new entity notification channel.
- Write
Create an entity notification policy.
Create a new entity notification policy.
- Write
Create an entity notification policy
Create a new entity notification policy from template.
- Write
Create an entity notification policy template.
Create a new entity notification policy template.
- Write
Create a notification channel template.
Create a new notification channel template.
- Write
Create a notification channel.
Create a new notification channel.
- Write
Send a 6-digit verification code
Send a 6-digit verification code to the user's email.
- Write
Create a notification policy.
Create a new notification policy.
- Write
Create a new ignored notification.
Create a new ignored notification.
- Write
Test the webhook notification channel.
Test the webhook notification channel.
- Write
Resend the notification.
Resend the notification.
- Write
Post a remote deployment event.
Post an event from a remote deployment.
- Write
Mark all as read
Mark all associated notifications with the user as read.
- Write
Mark as read by user notification ID
Mark one associated notification with the user as read.
- Destructive
Update an entity notification channel by relatedentitytype
Update the entity notification channel.
- Destructive
Delete an entity notification channel by relatedentitytype
Delete the entity notification channel.
- Destructive
Update an entity notification policy by relatedentitytype
Update the entity notification policy.
- Destructive
Delete an entity notification policy by relatedentitytype
Delete the entity notification policy.
- Destructive
Update an entity notification policy template by relatedentitytype
Update the entity notification policy template.
- Destructive
Delete an entity notification policy template by relatedentitytype
Delete the entity notification policy template.
- Destructive
Update a notification channel template by channel ID
Update the notification channel template.
- Destructive
Delete a notification channel template by channel ID
Delete the notification channel template.
- Destructive
Update a notification channel by channel ID
Update the notification channel.
- Destructive
Delete a notification channel by channel ID
Delete the notification channel.
- Destructive
Update a notification policy by policy ID
Update the notification policy.
- Destructive
Delete a notification policy by policy ID
Delete the notification policy.
- Destructive
Delete the existing notification policy mute by mute ID
Delete the existing notification policy mute.
- Destructive
Delete all user notifications
Delete all notifications associated with the user.
- Destructive
Delete user notification by user notification ID
Delete one notification associated with the user.
Entity tags
- Read
Retrieve the list of entity tags.
Retrieve the list of entity tags.
- Read
Get entity tag.
Look up an entity tag.
- Write
Update entity tag by entity tag ID
Update an entity tag.
- Destructive
Delete an entity tag by entity tag ID
Delete an entity tag.
Sso configuration
- Read
Retrieve global Inbound OAuth configuration.
Retrieve Inbound OAuth configuration for the global config.
- Read
Retrieve Inbound OAuth configuration by organization ID
Retrieve Inbound OAuth configuration for a specific organization.
- Read
List sso configurations.
List the sso configurations that correspond to provided conditions.
- Read
Retrieve SSO configuration of a specific organization by configuration ID
Retrieve SSO configuration of a specific organization.
- Write
Create global Inbound OAuth configuration.
Create Inbound OAuth configuration for the global config.
- Write
Update global Inbound OAuth configuration.
Partially update Inbound OAuth configuration for the global config.
- Write
Create Inbound OAuth configuration by organization ID
Create Inbound OAuth configuration for a specific organization.
- Write
Update Inbound OAuth configuration by organization ID
Partially update Inbound OAuth configuration for a specific organization.
- Write
Create an SSO configuration
Create an SSO configuration for a specific organization
- Write
Update an SSO configuration by configuration ID
Update an SSO configuration for a specific organization.
OAuth Providers
- Read
List OAuth Provider Authorizations
List OAuth Provider Authorizations for the user.
- Read
Get User Information by authorized provider ID
Retrieve user information from the OAuth Provider using the previously obtained authorization.
- Read
Get OAuth Provider Job by job ID
Retrieve the status of an OAuth Provider Job by ID.
- Read
List OAuth Providers
Returns a list of all available OAuth providers.
- Read
Get OAuth Provider by provider ID
Retrieves an OAuth provider by its ID.
- Write
Acquire OAuth Provider Authorization's Access Token by authorized provider ID
Acquire an access token for the OAuth Provider Authorization.
- Write
Create OAuth Provider
Creates a new OAuth provider.
- Write
OAuth Provider Callback
Handles the OAuth2 callback, exchanges authorization code for an access/refresh tokens, and creates a new
- Write
Update OAuth Provider by provider ID
Updates an existing OAuth provider by its ID.
- Write
Authorize OAuth Provider by provider ID
Returns a redirect URL to the OAuth2 provider's authorization page to get user's consent for accessing their data.
- Destructive
Delete OAuth Provider Authorization by authorized provider ID
Revoke an OAuth Provider Authorization by ID.
- Destructive
Delete OAuth Provider by provider ID
Initiates a job to delete an OAuth provider by its ID, along with all associated resources.
Agents
- Read
Obtain chat completion response by custom model ID
Obtain chat completion response for a given chat completion ID.
- Read
List search studies by use case ID.
Return all search studies for the specified use case .
- Read
Get existing search study by ID by search study ID
Return existing search study object from the database.
- Write
Request chat completion by custom model ID
Create a chat completion request for an agent using a custom model.
- Write
Run agentic search.
Run agentic search.
- Write
Edit search study by search study ID
Edit an existing search study object.
- Destructive
Delete existing search study by ID by search study ID
Delete existing search study object from the database.
Prompting
- Read
List chat prompts
List chat prompts.
- Read
Retrieve chat prompt by chat prompt ID
Retrieve an existing chat prompt.
- Read
List chats
List chats.
- Read
Retrieve chat by chat ID
Retrieve an existing chat.
- Read
List comparison chats
List comparison chats.
- Read
Retrieve comparison chat by comparison chat ID
Retrieve an existing comparison chat.
- Read
List comparison prompts
List the comparison prompts associated with a comparison chat or a set of LLM blueprints.
- Read
Retrieve comparison prompt by comparison prompt ID
Retrieve an existing comparison prompt.
- Read
List prompt templates
List prompt templates for the user with optional filtering and sorting.
- Read
List prompt templates versions
List prompt templates versions for the user with optional filtering.
- Read
Get prompt template by prompt template ID
Get prompt template by ID.
- Read
List prompt template versions by prompt template ID
List versions for a prompt template with pagination.
- Read
Get prompt template version by prompt template ID
Get prompt template version by ID.
- Write
Create chat prompt
Request the execution of a new prompt within a chat or an LLM blueprint.
- Write
Edit chat prompt by chat prompt ID
Edit an existing chat prompt.
- Write
Create chat
Create a new chat.
- Write
Edit chat by chat ID
Edit an existing chat.
- Write
Create comparison chat
Create a new comparison chat.
- Write
Edit comparison chat by comparison chat ID
Edit an existing comparison chat.
- Write
Create comparison prompt
Request the execution of a new comparison prompt.
- Write
Edit comparison prompt by comparison prompt ID
Edit an existing comparison prompt. Editing may involve adding new prompt result metadata or executing this comparison prompt on new LLM blueprints.
- Write
Create prompt template
Create a new prompt template.
- Write
Create prompt template version by prompt template ID
Create a new prompt template version.
- Destructive
Delete chat prompt by chat prompt ID
Delete an existing chat prompt.
- Destructive
Delete chat by chat ID
Delete an existing chat.
- Destructive
Delete comparison chat by comparison chat ID
Delete an existing comparison chat.
- Destructive
Delete comparison prompt by comparison prompt ID
Delete an existing comparison prompt.
AI Robustness Tests
- Read
Retrieve cost metric configuration by cost metric configuration ID
Retrieve an existing cost metric configuration.
- Read
List evaluation dataset configurations
List evaluation dataset configurations.
- Read
Retrieve evaluation dataset configuration by evaluation dataset configuration ID
Retrieve an existing evaluation dataset configuration.
- Read
List evaluation dataset metric aggregations
List evaluation dataset metric aggregations.
- Read
List evaluation dataset metric aggregations aggregated by llm blueprint.
List evaluation dataset metric aggregations aggregated by llm blueprint.
- Read
List evaluation dataset metric aggregations unique computed metrics by uniquefield
List evaluation dataset metric aggregations unique computed metrics.
- Read
List LLM test configuration
List LLM test configuration.
- Read
List non out-of-the-box datasets
List the supported non out-of-the-box datasets that can be used with an LLM test configuration.
- Read
List out-of-the-box datasets
List the supported out-of-the-box datasets that can be used with an LLM test configuration.
- Read
List supported insights
List the supported LLM test insight configurations for the specified use case.
- Read
Retrieve LLM test configuration by LLM test configuration ID
Retrieve an existing LLM test configuration.
- Read
List LLM test results
List LLM test results.
- Read
Retrieve LLM test result by LLM test result ID
Retrieve an existing LLM test result.
- Read
List LLM test suites
List LLM test suites.
- Read
Retrieve LLM test suite by LLM test suite ID
Retrieve an existing LLM test suite.
- Read
Get OOTB metric configuration by ootb metric configuration ID
Get OOTB metric configuration from the configuration.
- Read
List sidecar model metric validations
List sidecar model metric validations.
- Read
Validate sidecar model metric
Validate a metric hosted in a custom model deployment (also known as a sidecar model metric) for use in the playground.
- Read
Retrieve sidecar model metric validation status by validation ID
Retrieve the status of validating a sidecar model metric.
- Write
Create cost metric configuration
Create a new cost metric configuration.
- Write
Edit cost metric configuration by cost metric configuration ID
Edit an existing cost metric configuration.
- Write
Create evaluation dataset configuration
Create a new evaluation dataset configuration.
- Write
Edit evaluation dataset configuration by evaluation dataset configuration ID
Edit an existing evaluation dataset configuration.
- Write
Create evaluation dataset metric aggregation
Create a new evaluation dataset metric aggregation.
- Write
Create LLM test configuration
Create a new LLM test configuration.
- Write
Edit LLM test configuration by LLM test configuration ID
Edit an existing LLM test configuration.
- Write
Create LLM test result
Create a new LLM test result.
- Write
Create LLM test suite
Create a new LLM test suite.
- Write
Edit LLM test suite by LLM test suite ID
Edit an existing LLM test suite.
- Write
Edit sidecar model metric validation by validation ID
Edit an existing sidecar model metric validation.
- Write
Revalidate sidecar model metric by validation ID
Revalidate an existing sidecar model metric validation.
- Write
Generate synthetic evaluation dataset
Generate a synthetic evaluation dataset.
- Destructive
Delete cost metric configuration by cost metric configuration ID
Delete an existing cost metric configuration.
- Destructive
Delete evaluation dataset configuration by evaluation dataset configuration ID
Delete an existing evaluation dataset configuration.
- Destructive
Delete evaluation dataset metric aggregation
Delete the evaluation dataset metric aggregation associated with the specified LLM blueprint IDs and/or chat IDs.
- Destructive
Delete LLM test configuration by LLM test configuration ID
Delete an existing LLM test configuration.
- Destructive
Delete LLM test result by LLM test result ID
Delete an existing LLM test result.
- Destructive
Delete LLM test suite by LLM test suite ID
Delete an existing LLM test suite.
- Destructive
Delete OOTB metric configuration by ootb metric configuration ID
Delete single OOTB metric configuration.
- Destructive
Delete sidecar model metric validation by validation ID
Delete an existing sidecar model metric validation.
Vector Databases
- Read
List custom model embedding validations
List custom model embedding validations.
- Read
Validate custom model embedding
Validate an embedding model hosted in a custom model deployment for use in the playground.
- Read
Retrieve custom model embedding validation status by validation ID
Retrieve the status of validating a custom model embedding.
- Read
List custom model vector database validations
List custom model vector database validations.
- Read
Validate custom model vector database
Validate a vector database hosted in a custom model deployment for use in the playground.
- Read
Retrieve custom model vector database validation status by validation ID
Retrieve the status of validating a custom model vector database.
- Read
List vector databases
List vector databases.
- Read
List supported embedding models
List the supported embedding models for building vector databases.
- Read
List supported vector database retrieval settings
List all vector database retrieval settings that are supported by LLM blueprints.
- Read
List supported text chunking methods
List the supported text chunking methods for building vector databases.
- Read
Retrieve vector database by vector database ID
Retrieve an existing vector database.
- Read
Export vector database dataset by vector database ID
Export an existing vector database as dataset to Data Registry.
- Read
Retrieve vector database latest version by vector database ID
Retrieve the latest vector database within the family associated with this vector database.
- Read
List supported languages by vector database ID
List the languages for synthetic dataset generation that are supported by this vector database.
- Read
Retrieve text chunks and embeddings by vector database ID
Retrieve the text chunk and embeddings asset for an existing vector database.
- Write
Edit custom model embedding validation by validation ID
Edit an existing custom model embedding validation.
- Write
Revalidate custom model embedding by validation ID
Revalidate an existing custom model embedding validation.
- Write
Edit custom model vector database validation by validation ID
Edit an existing custom model vector database validation.
- Write
Revalidate custom model vector database by validation ID
Revalidate an existing custom model vector database.
- Write
Create vector database
Create a new vector database.
- Write
Create a vector databases from a custom model deployment
Create a new vector database from a custom model deployment.
- Write
Edit vector database by vector database ID
Edit an existing vector database.
- Write
Create custom model version by vector database ID
Export the specified Vector Database as a custom model version in Model Registry.
- Write
Create new custom model version by vector database ID
Export the specified vector database as a custom model version, register it, and deploy it on a new deployment.
- Write
Add documents by vector database ID
Add documents to a connected vector database.
- Destructive
Delete custom model embedding validation by validation ID
Delete an existing custom model embedding validation.
- Destructive
Delete custom model vector database validation by validation ID
Delete an existing custom model vector database validation.
- Destructive
Delete vector database by vector database ID
Delete an existing vector database.
LLM Generation
- Read
List custom model LLM validations
List custom model LLM validations.
- Read
Validate custom model LLM
Validate an LLM hosted in a custom model deployment for use in the playground.
- Read
Retrieve custom model LLM validation status by validation ID
Retrieve the status of validating a custom model LLM.
- Read
List LLM blueprints
List LLM blueprints.
- Read
Retrieve LLM blueprint by LLM blueprint ID
Retrieve an existing LLM blueprint.
- Read
List LLMs
List the large language models (LLMs) available in the DataRobot platform for the current user.
- Read
Get LLM by LLM ID
Get the large language model (LLM) by ID.
- Read
List playgrounds
List playgrounds.
- Read
Retrieve playground by playground ID
Retrieve an existing playground.
- Read
Retrive the NeMo configuration by playground ID
Retrieve the NeMo configuration for the playground.
- Read
List OOTB metric configurations by playground ID
List OOTB metric configurations for the selected playground.
- Read
List supported insights by playground ID
List the supported insights.
- Read
Retrieve playground prompt traces by playground ID
Retrieve the playground prompt traces for an existing playground.
- Read
Retrieve playground prompt traces metadata by playground ID
Retrieve the prompt traces metadata for an existing playground.
- Read
Retrieve job status by status ID
Retrieve the execution status of a GenAI worker job.
- Read
Retrieve vector database creation count
Retrieve the number of vector databases the user has created which count towards the usage limit.
- Write
Edit custom model LLM validation by validation ID
Edit an existing custom model LLM validation.
- Write
Revalidate custom model LLM by validation ID
Revalidate an existing custom model LLM validation.
- Write
Create custom model version
Export the specified LLM blueprint as a custom model version in Model Registry.
- Write
Create LLM blueprint
Create a new LLM blueprint.
- Write
Create a LLM blueprints from a chat prompt
Create a new LLM blueprint using the LLM and vector database settings currently used by the specified existing chat prompt.
- Write
Duplicate LLM blueprint
Create a new LLM blueprint using the LLM and vector database settings currently used by the specified existing LLM blueprint.
- Write
Edit LLM blueprint by LLM blueprint ID
Edit an existing LLM blueprint.
- Write
Create playground
Create a new playground.
- Write
Edit playground by playground ID
Edit an existing playground.
- Write
Update/insert the NeMo configuration by playground ID
Update/insert the NeMo configuration for the playground.
- Write
Create OOTB metric configuration by playground ID
Create a new OOTB metric configuration.
- Write
Create playground prompt trace dataset by playground ID
Export prompt traces for an existing playground as a Data Registry dataset.
- Destructive
Delete custom model LLM validation by validation ID
Delete an existing custom model LLM validation.
- Destructive
Delete LLM blueprint by LLM blueprint ID
Delete an existing LLM blueprint.
- Destructive
Delete playground by playground ID
Delete an existing playground.
- Destructive
Delete the NeMo configuration by playground ID
Delete the NeMo configuration for the playground.
- Destructive
Delete a NeMo metric by playground ID
Delete a NeMo metric for the playground.
- Destructive
Copy supported insights by target playground ID
Copy supported insights between playgrounds.
Guardrails
- Read
The list of resource tags.
The list of resource tags.
- Read
Show the prediction environments in use
Show the prediction environments in use for moderation.
- Read
Retrieve info about a guard configuration by config ID
Retrieve info about a guard configuration.
- Read
List guard templates.
List guard templates.
- Read
Retrieve information about a guard template by template ID
Retrieve information about a guard template.
- Read
The list of supported LLMs
The list of supported LLMs for moderation.
- Read
Get the overall moderation configuration
Get the overall moderation configuration for an entity.
- Write
Create a guard configuration.
Create a guard configuration.
- Write
Apply moderation configuration
Apply moderation configuration to a new custom model version.
- Write
Update a guard config by config ID
Update a guard config.
- Write
Update the overall moderation configuration
Update the overall moderation configuration for an entity.
- Destructive
Delete a guard config by config ID
Delete a guard config.
Meta memory space
Model management
- Read
List model packages
Retrieve the list of model packages a user has access to.
- Read
Retrieve info about a model package by model package ID
Retrieve info about a model package.
- Read
Retrieve capabilities by model package ID
Retrieve the capabilities for the model package.
- Read
Retrieve feature list by model package ID
Retrieve the feature list for given model package.
- Read
The list of the model package's model logs by model package ID
The list of the model package's model logs.
- Read
List registered models.
List registered models.
- Read
Retrieve information about a registered model by registered model ID
Retrieve information about a registered model.
- Read
List deployments associated by registered model ID
List deployments associated with the given registered model
- Read
List the registered model's versions by registered model ID
List the registered model's versions.
- Read
Get the registered model's version by registered model ID
Get the registered model's version.
- Read
List all deployments associated by registered model ID
List all deployments associated with registered model version.
- Write
Create model package
Create model package from a Leaderboard model.
- Write
Create a model packages from a learning model
Create model package from DataRobot model. .. minversion:: v2.31 DEPRECATED: please use the following route instead: :http:post:/api/v2/modelPackages/fromLeaderboard/
- Write
Update a registered model by registered model ID
Update a registered model.
- Destructive
Archive a model package by model package ID
(Deprecated in v2.32) Permanently archive a model package. It will no longer be able to be used in new deployments or replacement. It will not be accessible in the model package list api. It will only be accessible at the model package retrieve route for this model package.
- Destructive
Archive a registered model by registered model ID
Permanently archive a registered model and all of its versions
Models
- Read
Retrieve an archive (tar by project ID
Retrieve an archive (tar.gz) of the logs produced and persisted by a model. Note that only blueprints with custom tasks create persistent logs - this will not work with any other type of model.
- Read
Retrieve training artifact by ID by project ID
Retrieve an archive (tar.gz) of the artifacts produced and persisted by a model. Note that only blueprints with custom tasks create these artifacts - this will not work with any other type of model.
- Write
Create a model package
Create a model package from json.
Notebooks
- Read
Retrieve Notebook Code Snippets
GET /api/v2/notebookCodeSnippets/
- Read
Retrieve Tags
GET /api/v2/notebookCodeSnippets/tags/
- Read
Retrieve Notebook Code Snippets by snippet ID
GET /api/v2/notebookCodeSnippets/{snippetId}/
- Read
Retrieve Notebook Environment Variables by notebook ID
GET /api/v2/notebookEnvironmentVariables/{notebookId}/
- Read
Retrieve Notebook Execution Environments
GET /api/v2/notebookExecutionEnvironments/
- Read
Retrieve Machines
Returns all available environment machine options for which to run the notebook.
- Read
Retrieve Notebooks by environment ID
Return list of notebooks that are using environment by environment ID.
- Read
List Notebook Execution Environments versions by environment ID
GET /api/v2/notebookExecutionEnvironments/{environmentId}/versions/
- Read
Retrieve Notebook Execution Environments by notebook ID
Return assigned execution environment as an EnvironmentPublic entity.
- Read
Retrieve Ports by notebook ID
List all exposed ports for a given notebook.
- Read
Retrieve Notebook jobs
Get scheduled jobs list.
- Read
Retrieve Run history
GET /api/v2/notebookJobs/runHistory/
- Read
Retrieve Notebook jobs by notebook schedule ID
GET /api/v2/notebookJobs/{notebookScheduleId}/
- Read
Retrieve Notebook Revisions by notebook ID
List all revisions for the given notebook.
- Read
Retrieve notebook revisions by ID
Get a specific revision for the given notebook.
- Read
Retrieve Cells by notebook ID
Get cells for a specific revision version of the given notebook.
- Read
Retrieve To File by notebook ID
Export Notebook Revision to file.
- Read
Retrieve Notebooks by notebook ID
Retrieves the notebook session or returns the one in the default state.
- Read
Retrieve Dataframe by notebook ID
Gets a dataframe from a cell execution.
- Read
Retrieve Dataframe List by notebook ID
Lists all dataframes for a notebook.
- Read
Retrieve Execution Status by notebook ID
Gets execution status.
- Read
Retrieve Download by notebook ID
Download entire file system as an archive.
- Read
Retrieve Objects by notebook ID
Get paginated list of objects for a given path in the filesystem.
- Read
Retrieve download by ID
Download many files or directories from the notebook session.
- Read
Retrieve Metadata by notebook ID
Get the filesystem's metadata.
- Read
Retrieve objects by ID
Preview a file. The file path is passed as a parameter. For example: filesystem/objects/home/usr/storage/img.png/
- Read
Retrieve Status by notebook ID
GET /api/v2/notebookSessions/{notebookId}/git/clone/status/
- Read
Retrieve Kernels by notebook ID
GET /api/v2/notebookSessions/{notebookId}/kernels/
- Read
Retrieve kernels by ID
GET /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/
- Read
Retrieve Kernelspecs by notebook ID
GET /api/v2/notebookSessions/{notebookId}/kernelspecs/
- Read
Retrieve Notebook by notebook ID
GET /api/v2/notebookSessions/{notebookId}/notebook/
- Read
Retrieve Cells by notebook ID
GET /api/v2/notebookSessions/{notebookId}/notebook/cells/
- Read
Retrieve Dataframes by notebook ID
GET /api/v2/notebookSessions/{notebookId}/notebook/dataframes/
- Read
Retrieve dataframes by ID
GET /api/v2/notebookSessions/{notebookId}/notebook/dataframes/{referenceId}/
- Read
Retrieve Execution by notebook ID
GET /api/v2/notebookSessions/{notebookId}/notebook/execution/
- Read
Retrieve Executing by notebook ID
GET /api/v2/notebookSessions/{notebookId}/scripts/executing/
- Read
Retrieve Terminals by notebook ID
GET /api/v2/notebookSessions/{notebookId}/terminals/
- Read
Retrieve Notebooks
Return list of notebooks.
- Read
Retrieve Filter Options
GET /api/v2/notebooks/filterOptions/
- Read
Retrieve Notebooks by notebook ID
GET /api/v2/notebooks/{notebookId}/
- Read
Retrieve Cells by notebook ID
GET /api/v2/notebooks/{notebookId}/cells/
- Read
Retrieve To File by notebook ID
Export Notebook to file endpoint.
- Read
Retrieve Providers
List authorized Git OAuth Providers.
- Read
Retrieve Repositories by authorization ID
Get or search repositories for a given authorized Git provider.
- Write
Create Notebook Environment Variables by notebook ID
POST /api/v2/notebookEnvironmentVariables/{notebookId}/
- Write
Modify Notebook Environment Variables by notebook ID
PATCH /api/v2/notebookEnvironmentVariables/{notebookId}/{envVarId}/
- Write
Modify Notebook Execution Environments by notebook ID
Sets the environment configuration for the notebook.
- Write
Create Ports by notebook ID
POST /api/v2/notebookExecutionEnvironments/{notebookId}/ports/
- Write
Modify Ports by notebook ID
PATCH /api/v2/notebookExecutionEnvironments/{notebookId}/ports/{portId}/
- Write
Create Notebook jobs
POST /api/v2/notebookJobs/
- Write
Create Manual Run
Create a manual run.
- Write
Modify Notebook jobs by notebook schedule ID
PATCH /api/v2/notebookJobs/{notebookScheduleId}/
- Write
Create Clone by notebook ID
Clone a notebook from a revision.
- Write
Create Restore by notebook ID
Restore a notebook from a revision.
- Write
Create Notebook Revisions by notebook ID
Create a new revision from the given notebook's current state.
- Write
Modify Notebook Revisions by notebook ID
Update a revision's name.
- Write
Create And Start Codespace
Creates the Codespace and starts a session.
- Write
Create Autocomplete by notebook ID
Autocompletes code.
- Write
Create Client Activity by notebook ID
Reset session TTL from client, when there is a user activity.
- Write
Execute Notebooks by notebook ID
Executes specific cells or the entire notebook.
- Write
Create Input Reply by notebook ID
Endpoint used in response to when the kernel requests input from the user.
- Write
Create Inspect by notebook ID
Inspects code.
- Write
Create Restart Kernel by notebook ID
Restarts kernel.
- Write
Start Notebooks by notebook ID
Starts a new notebook session.
- Write
Stop Notebooks by notebook ID
Stops the notebook session.
- Write
Create Copy by notebook ID
Copy a filesystem object at a given path to a specific destination.
- Write
Create Download by notebook ID
Download a file or directory from the notebook session.
- Write
Modify Metadata by notebook ID
Update a filesystem object's metadata.
- Write
Create Move by notebook ID
Move a filesystem object at a given path.
- Write
New by notebook ID
Create a new filesystem object (file or directory) at the given path.
- Write
Create Upload by notebook ID
Upload a file or directory into the notebook session and save it under given path. If file exists by given path, it will be overridden.
- Write
Create Clone by notebook ID
POST /api/v2/notebookSessions/{notebookId}/git/clone/
- Write
Create Kernels by notebook ID
POST /api/v2/notebookSessions/{notebookId}/kernels/
- Write
Create Completion by notebook ID
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/completion/
- Write
Execute Kernels by notebook ID
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/execute/
- Write
Create Input Reply by notebook ID
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/inputReply/
- Write
Create Inspect by notebook ID
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/inspect/
- Write
Create Interrupt by notebook ID
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/interrupt/
- Write
Create Restart by notebook ID
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/restart/
- Write
Create Notebook by notebook ID
POST /api/v2/notebookSessions/{notebookId}/notebook/
- Write
Create Activity by notebook ID
Reports that the client is still working with these notebooks. UI uses it to report notebooks that are open and potentially viewed by the user. Knowing this information helps to shut down inactive notebook reconcilers/executors.
- Write
Create Cells by notebook ID
POST /api/v2/notebookSessions/{notebookId}/notebook/cells/
- Write
Modify Cells by notebook ID
PATCH /api/v2/notebookSessions/{notebookId}/notebook/cells/
- Write
Create Reorder by notebook ID
POST /api/v2/notebookSessions/{notebookId}/notebook/cells/reorder/
- Write
Create move by ID
POST /api/v2/notebookSessions/{notebookId}/notebook/cells/{cellId}/move/
- Write
Execute Notebook by notebook ID
POST /api/v2/notebookSessions/{notebookId}/notebook/execute/
- Write
Create Kernel by notebook ID
Sets kernel for a given notebook.
- Write
Create Trigger Execution by notebook ID
A variation of executenotebook that automatically prepares, assigns kernel and executes the notebook in its entirety.
- Write
Execute scripts by notebook ID
POST /api/v2/notebookSessions/{notebookId}/scripts/execute/
- Write
Create Terminals by notebook ID
POST /api/v2/notebookSessions/{notebookId}/terminals/
- Write
Modify Terminals by notebook ID
PATCH /api/v2/notebookSessions/{notebookId}/terminals/{terminalId}/
- Write
Create Notebooks
POST /api/v2/notebooks/
- Write
Create Bulk Link Use Case
POST /api/v2/notebooks/bulkLinkUseCase/
- Write
Create From File
Import Notebook from file endpoint.
- Write
Create From URL
Import the notebook from the URL endpoint.
- Write
Modify Notebooks by notebook ID
PATCH /api/v2/notebooks/{notebookId}/
- Write
Modify Batch Clear Cells Execution Count by notebook ID
PATCH /api/v2/notebooks/{notebookId}/batchClearCellsExecutionCount/
- Write
Create Cells by notebook ID
POST /api/v2/notebooks/{notebookId}/cells/
- Write
Modify Batch Clear Output by notebook ID
PATCH /api/v2/notebooks/{notebookId}/cells/batchClearOutput/
- Write
Create Batch Create by notebook ID
POST /api/v2/notebooks/{notebookId}/cells/batchCreate/
- Write
Create Batch Delete by notebook ID
POST /api/v2/notebooks/{notebookId}/cells/batchDelete/
- Write
Modify Batch Update Metadata by notebook ID
PATCH /api/v2/notebooks/{notebookId}/cells/batchUpdateMetadata/
- Write
Modify Batch Update Sources by notebook ID
PATCH /api/v2/notebooks/{notebookId}/cells/batchUpdateSources/
- Write
Modify Cells by notebook ID
PATCH /api/v2/notebooks/{notebookId}/cells/{cellId}/
- Write
Modify Output by notebook ID
PATCH /api/v2/notebooks/{notebookId}/cells/{cellId}/output/
- Write
Modify Reorder Cells by notebook ID
PATCH /api/v2/notebooks/{notebookId}/reorderCells/
- Write
Modify State by notebook ID
PATCH /api/v2/notebooks/{notebookId}/state/
- Write
Create To Codespace by notebook ID
POST /api/v2/notebooks/{notebookId}/toCodespace/
- Destructive
Delete Notebook Environment Variables by notebook ID
DELETE /api/v2/notebookEnvironmentVariables/{notebookId}/
- Destructive
Delete notebook environment variables by ID
DELETE /api/v2/notebookEnvironmentVariables/{notebookId}/{envVarId}/
- Destructive
Delete Ports by notebook ID
Remove all exposed port for a given notebook.
- Destructive
Delete ports by ID
Remove previously exposed port for a given notebook.
- Destructive
Delete Notebook jobs by notebook schedule ID
DELETE /api/v2/notebookJobs/{notebookScheduleId}/
- Destructive
Cancel Notebook jobs by notebook schedule ID
POST /api/v2/notebookJobs/{notebookScheduleId}/cancel/
- Destructive
Delete Notebook Revisions by notebook ID
Delete all revisions for the given notebook.
- Destructive
Delete notebook revisions by ID
Delete single revision.
- Destructive
Cancel Notebooks by notebook ID
Cancels execution.
- Destructive
Delete Delete by notebook ID
Delete a filesystem object(s) from a list of paths.
- Destructive
Cancel Clone by notebook ID
POST /api/v2/notebookSessions/{notebookId}/git/clone/cancel/
- Destructive
Delete Kernels by notebook ID
DELETE /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/
- Destructive
Delete Cells by notebook ID
DELETE /api/v2/notebookSessions/{notebookId}/notebook/cells/
- Destructive
Cancel Cells by notebook ID
POST /api/v2/notebookSessions/{notebookId}/notebook/cells/cancel/
- Destructive
Delete Output by notebook ID
DELETE /api/v2/notebookSessions/{notebookId}/notebook/cells/output/
- Destructive
Delete Terminals by notebook ID
DELETE /api/v2/notebookSessions/{notebookId}/terminals/{terminalId}/
- Destructive
Delete Notebooks by notebook ID
DELETE /api/v2/notebooks/{notebookId}/
- Destructive
Delete Cells by notebook ID
DELETE /api/v2/notebooks/{notebookId}/cells/{cellId}/
Data exports and tracing
- Read
Gets OTel statistics
GET /api/v2/otel/stats/
- Read
List OpenTelemetry traces
POST /api/v2/otel/traces/
- Read
Retrieve OpenTelemetry logs by entitytype
GET /api/v2/otel/{entityType}/{entityId}/logs/
- Read
List pods and containers found by entitytype
List pods and containers found in OpenTelemetry logs of the specified entity.
- Read
Get aggregated values of OpenTelemetry metrics that DataRobot automatically collects by entitytype
Get aggregated values of OpenTelemetry metrics that DataRobot automatically collects for the specified entity.
- Read
List the OpenTelemetry metric configurations by entitytype
List the OpenTelemetry metric configurations for the specified entity.
- Read
Get the OpenTelemetry metric configuration by entitytype
Get an OpenTelemetry metric configuration for the specified entity.
- Read
Retrieve resource consumers by entitytype
Retrieve list of unique agents/users that have made requests to this resource. Only available to resource owners and users with read permissions.
- Read
Retrieve pod info by ID
List pods and containers found in OpenTelemetry metrics of the specified entity.
- Read
List reported OpenTelemetry metrics of the specified entity by entitytype
List reported OpenTelemetry metrics of the specified entity.
- Read
Get a single OpenTelemetry metric value of the specified entity over time by entitytype
Get a single OpenTelemetry metric value of the specified entity over time.
- Read
Get OpenTelemetry metrics values of the specified entity over a single time by entitytype
Get OpenTelemetry metrics values of the specified entity over a single time period.
- Read
Get OpenTelemetry metric values, grouped by entitytype
Get OpenTelemetry metric values for the specified entity, grouped by the segment attribute name and values over a single time period.
- Read
Get OpenTelemetry configured metrics values of the specified entity over time by entitytype
Get OpenTelemetry configured metrics values of the specified entity over time.
- Read
Get OpenTelemetry metric values by entitytype
Get OpenTelemetry metric values for the specified entity, grouped by multiple attributes.
- Read
Get OpenTelemetry metric values, grouped by segment attribute by entitytype
Get OpenTelemetry metric values for the specified entity, grouped by the segment attribute name and values.
- Read
List OpenTelemetry traces by entitytype
GET /api/v2/otel/{entityType}/{entityId}/traces/
- Read
List attribute values used in OpenTelemetry traces by entitytype
GET /api/v2/otel/{entityType}/{entityId}/traces/attributes/
- Read
List evaluation names used in OpenTelemetry traces by entitytype
GET /api/v2/otel/{entityType}/{entityId}/traces/evaluationNames/
- Read
Retrieve the specified OpenTelemetry trace by entitytype
GET /api/v2/otel/{entityType}/{entityId}/traces/{traceId}/
- Read
Retrieve the evaluation spans by entitytype
GET /api/v2/otel/{entityType}/{entityId}/traces/{traceId}/evaluations/
- Write
Create an OpenTelemetry metric configuration by entitytype
Create an OpenTelemetry metric configuration for the specified entity.
- Write
Update an OpenTelemetry metric configuration by entitytype
Update an OpenTelemetry metric configuration for the specified entity.
- Destructive
Delete all OpenTelemetry logs by entitytype
DELETE /api/v2/otel/{entityType}/{entityId}/logs/
- Destructive
Delete all OpenTelemetry metrics by entitytype
DELETE /api/v2/otel/{entityType}/{entityId}/metrics/
- Destructive
Set all the OpenTelemetry metric configurations by entitytype
Set all the OpenTelemetry metric configurations for the specified entity.
- Destructive
Delete an OpenTelemetry metric configuration by entitytype
Delete an OpenTelemetry metric configuration for the specified entity.
- Destructive
Delete OpenTelemetry traces by entitytype
DELETE /api/v2/otel/{entityType}/{entityId}/traces/
Use cases
- Read
Retrieve Pinned Usecases
GET /api/v2/pinnedUsecases/
- Read
Retrieve the list of Use Cases.
Retrieve the list of Use Cases.
- Read
Get a Use Case.
Look up a Use Case.
- Read
Get the list of the references associated
Get a list of the all used assets associated with a Use Case.
- Read
Get the list of the notebooks
Get the list of the notebooks from all Use Cases.
- Read
Get a Use Case by use case ID
Retrieve a single Use Case.
- Read
Get the list of the applications associated by use case ID
Get the list of the applications associated with a Use Case.
- Read
The list of the custom applications referenced by a Use Case by use case ID
The list of the custom applications referenced by a Use Case.
- Read
List datasets by use case ID
Get a list of the data (datasets and recipes) associated with a use case.
- Read
Get the list of the datasets associated by use case ID
Get the list of the datasets associated with a Use Case.
- Read
Get the dataset details by use case ID
Retrieves the details of the dataset with given ID for given use case ID.
- Read
Get the deployments associated by use case ID
The list of deployments associated with the Use Case.
- Read
Get the list of the catalog files associated by use case ID
Get the list of the catalog files associated with a use case.
- Read
Get the file details by use case ID
Retrieves the details of the file with given ID for a given Use Case ID.
- Read
Get filtering metadata information from Use Cases associated by use case ID
Get filtering metadata information from Use Cases associated with a Use Case.
- Read
Gets a list of models from projects associated with a Use Case by use case ID
Get a list of models from projects associated with a Use Case for direct comparison. NOTE: Datetime partitioned models are not supported currently.
- Read
Get the list of the notebooks associated by use case ID
Get the list of the notebooks associated with a Use Case.
- Read
Get the list of the playgrounds associated by use case ID
Get the list of the playgrounds associated with a Use Case.
- Read
Get the list of the projects associated by use case ID
Get the list of the projects associated with a Use Case.
- Read
The list of the registered models referenced by a Use Case by use case ID
The list of the registered models referenced by a Use Case.
- Read
Get the list of the references associated by use case ID
Get the list of the references associated with a Use Case.
- Read
Get a list of vector databases associated by use case ID
Get a list of vector databases associated with a Use Case.
- Read
Get a list of custom models that are associated by use case ID
Get a list of custom models that are associated with this vector database
- Read
Get a list of deployments that are associated by use case ID
Get a list of deployments that are associated with this vector database
- Read
Get a list of registered models that are associated by use case ID
Get a list of registered models that are associated with this vector database
- Read
Use an endpoint
Retrieves the list of Use Cases using a new endpoint that abbreviates the display metadata for faster retrieval.
- Write
Modify Pinned Usecases
PATCH /api/v2/pinnedUsecases/
- Write
Update a Use Case by use case ID
Update a Use Case.
- Write
Link multiple entities by use case ID
Link multiple entities to a Use Case.
- Write
Link entity by use case ID
Link entity to a single Use Case.
- Write
Move entity from one Use Case by use case ID
Move entity from one Use Case to another.
- Destructive
Delete a Use Case by use case ID
Delete a Use Case.
- Destructive
Remove a related entity by use case ID
Remove a related entity from a Use Case.
Pipelines
- Read
List pipelines
List all pipelines accessible to the authenticated user.
- Read
Get pipeline by pipeline ID
Retrieve a pipeline, including its versions.
- Read
Get draft pipeline graph by pipeline ID
Retrieve the task graph of a draft pipeline.
- Read
Get draft pipeline source by pipeline ID
Retrieve the source file of a draft pipeline.
- Read
Get draft pipeline task by pipeline ID
Retrieve a task in a draft pipeline.
- Read
List pipeline versions by pipeline ID
List the locked versions of a pipeline.
- Read
Get pipeline version by pipeline ID
Retrieve a locked version of a pipeline.
- Read
Get pipeline version graph by pipeline ID
Retrieve the task graph of a locked pipeline version.
- Read
Get pipeline version source by pipeline ID
Retrieve the source file of a locked pipeline version.
- Read
Get pipeline version task by pipeline ID
Retrieve a task in a locked pipeline version.
- Write
Create pipeline
Upload a Python file that defines a pipeline. The pipeline is created as a draft.
- Write
Update pipeline by pipeline ID
Update a draft pipeline's source file, name, description, or execution image.
- Write
Clone pipeline by pipeline ID
Create a new draft pipeline from a copy of an existing pipeline.
- Write
Lock pipeline by pipeline ID
Lock a draft pipeline, creating a new immutable pipeline version.
- Destructive
Delete pipeline by pipeline ID
Delete a pipeline.
Pipeline execution images
- Read
List execution images
List the execution images accessible to the authenticated user, newest first.
- Read
Get execution image by image ID
Retrieve an execution image, including its versions.
- Read
Get execution image build logs by image ID
Retrieve the build log of an execution image version.
- Write
Create execution image
Create an execution image for pipelines and start its first build.
- Write
Update execution image by image ID
Add packages to an execution image, creating and building a new image version.
- Destructive
Delete execution image by image ID
Delete an execution image and all of its versions.
- Destructive
Delete execution image version by image ID
Delete a version of an execution image.
Pipeline dispatches
- Read
List draft pipeline dispatches by pipeline ID
List the runs (dispatches) of a draft pipeline.
- Read
Get draft pipeline dispatch by pipeline ID
Retrieve a run (dispatch) of a draft pipeline.
- Read
Get draft pipeline dispatch status by pipeline ID
Retrieve the current status of a draft pipeline run. Use this endpoint to poll for completion.
- Read
List dispatch tasks by pipeline ID
List the tasks of a pipeline run (dispatch) and their status.
- Read
Get dispatch task by pipeline ID
Retrieve a task of a pipeline run (dispatch), including its status.
- Read
Get dispatch task logs by pipeline ID
Retrieve the live container logs of a task. After the task finishes, use the log stream endpoint.
- Read
Get dispatch task log stream by pipeline ID
Retrieve the stored stdout or stderr output of a task. Available after the task finishes.
- Read
Get dispatch task result by pipeline ID
Retrieve a short-lived download URL for the result of a completed task. The result is a cloudpickle payload; load it with cloudpickle.loads.
- Read
List pipeline version dispatches by pipeline ID
List the runs (dispatches) of a locked pipeline version.
- Read
Get pipeline version dispatch by pipeline ID
Retrieve a run (dispatch) of a locked pipeline version.
- Read
Get pipeline version dispatch status by pipeline ID
Retrieve the current status of a locked pipeline version run. Use this endpoint to poll for completion.
- Write
Run draft pipeline by pipeline ID
Run a draft pipeline with an input payload. Returns the new dispatch.
- Write
Run pipeline version by pipeline ID
Run a locked pipeline version with an input payload. Returns the new dispatch.
- Destructive
Cancel draft pipeline dispatch by pipeline ID
Cancel a run (dispatch) of a draft pipeline.
- Destructive
Cancel pipeline version dispatch by pipeline ID
Cancel a run (dispatch) of a locked pipeline version.
Pipeline inputs
- Read
List draft pipeline inputs by pipeline ID
List the input payloads of a draft pipeline.
- Read
Get draft pipeline input by pipeline ID
Retrieve an input payload of a draft pipeline.
- Read
List pipeline version inputs by pipeline ID
List the input payloads of a locked pipeline version.
- Read
Get pipeline version input by pipeline ID
Retrieve an input payload of a locked pipeline version.
- Write
Create draft pipeline input by pipeline ID
Create an input payload for a draft pipeline.
- Write
Update draft pipeline input by pipeline ID
Update an input payload of a draft pipeline.
- Write
Create pipeline version input by pipeline ID
Create an input payload for a locked pipeline version. Inputs of a locked version cannot be changed.
- Destructive
Delete draft pipeline input by pipeline ID
Delete an input payload of a draft pipeline.
- Destructive
Delete pipeline version input by pipeline ID
Delete an input payload of a locked pipeline version.
Pipeline schedules
- Read
List pipeline schedules by pipeline ID
List the schedules of a pipeline, across all of its versions.
- Read
Get pipeline schedule by pipeline ID
Retrieve a pipeline schedule.
- Write
Create pipeline schedule by pipeline ID
Schedule a locked pipeline version to run on a recurring cron schedule.
- Write
Update pipeline schedule by pipeline ID
Update the cron expression or timezone of a pipeline schedule.
- Destructive
Delete pipeline schedule by pipeline ID
Delete a pipeline schedule. Future runs are not started.
Predictions info
- Read
List prediction servers.
The list of prediction servers available for a user.
Datarobot models
- Read
List of bias mitigated models by project ID
List of bias mitigated models for the selected project.
- Read
Get bias mitigation data quality information by project ID
Get bias mitigation data quality information for a given projectId and featureName.
- Read
List all blenders by project ID
List all blenders in a project.
- Read
Check if models can be blended by project ID
Check if models can be blended.
- Read
Retrieve a blender by project ID
Retrieve a blender. Blenders are a special type of models, so the response includes all attributes that would be in a response to :http:get:/api/v2/projects/(projectId)/models/(modelId)/ as well as some additional ones.
- Read
Retrieve all existing combined models by project ID
Retrieve all existing combined models for this project. .. note:: To retrieve information on the segments for a combined model, retrieve the combined model using :http:get:/api/v2/projects/(projectId)/combinedModels/(combinedModelId)/
- Read
Retrieve an existing combined model by project ID
Retrieve an existing combined model. If available, contains information on which champion model is used for each segment.
- Read
Retrieve Combined Model segments info by project ID
Retrieve Combined Model segments info (name, related project & model details).
- Read
Download Combined Model segments info by project ID
Download Combined Model segments info (name, related project & model details) as a CSV.
- Read
List datetime partitioned project models by project ID
List all the models from a datetime partitioned project.
- Read
Get datetime model by project ID
Look up a particular datetime model All durations and datetimes are specified in accordance with :ref:timestamp and duration formatting rules .
- Read
Retrieve Eureqa model details plot by project ID
Retrieve Eureqa model details plot. Available for classification projects only.
- Read
Retrieve eureqa model detail by ID
Retrieve Eureqa model details plot. Available for regression projects only.
- Read
Retrieve the pareto front by project ID
Retrieve the pareto front for the specified Eureqa model. Only the best solution in the pareto front will have a corresponding model initially. Models can be created for other solutions using :http:post:/api/v2/projects/(projectId)/eureqaModels/.
- Read
List all frozen models by project ID
List all frozen models from a project.
- Read
Look up a particular frozen model by project ID
Look up a particular frozen model. If model with given ID exists but it's not frozen, returns 404 Not Found.
- Read
List modeling jobs by project ID
List modeling jobs.
- Read
Look up a specific modeling job by project ID
Look up a particular modeling job.
- Read
Retrieve model records, supports filtering by project ID
Retrieve model records, supports filtering and search
- Read
List project models by project ID
Lists all the models from a project. .. minversion:: v2.34 .. deprecated:: v2.34 Use :http:get:/api/v2/projects/(projectId)/modelRecords/ instead. Fewer attributes are returned in the response of model records route.
- Read
Get model by project ID
Look up a particular model.
- Read
Retrieve information about all advanced tuning parameters available by project ID
Retrieve information about all advanced tuning parameters available for the specified model. Note: This route currently supports all models other than: OSS, blenders, prime, scaleout, baseline and user-created
- Read
Retrieve cluster names assigned by project ID
Retrieve all cluster names assigned to an unsupervised cluster model
- Read
Get cross validation scores by project ID
Get Cross Validation scores for each partition in a model. .. note:: Individual partition scores are only available for newer models; older models that have cross validation score calculated will need to be retrained.
- Read
List the features used by project ID
List the features used in a model.
- Read
Retrieve grid search scores by project ID
Retrieve grid search scores.
- Read
Retrieve a summary of how the model's subtasks handle missing values by project ID
Retrieve a summary of how the model's subtasks handle missing values Only models built after the missing value report feature was added will have reports, and only models with at least one imputation or encoding task, e.g. ordinal encoding, missing value imputation.
- Read
Get number of iterations trained by project ID
Retrieve the actual number of iterations or estimators trained by a tree-based early stopping model.
- Read
Retrieve model parameters by project ID
Retrieve model parameters. These are the parameters that appear in the webapp on the Coefficients tab. Note that they are only available for some models.
- Read
Retrieve prediction intervals that are already calculated by project ID
Retrieve prediction intervals (in descending order) that are already calculated for this model. Note that the project this model belongs to must be a time series project.
- Read
Check a Model for Prime Eligibility by project ID
Check if a model can be approximated by DataRobot Prime. Deprecated in v2.35.
- Read
List rulesets by project ID
List all the rulesets approximating a model When rulesets are created for the parent model, all of the rulesets are created at once, but not all rulesets have corresponding Prime models (until they are directly requested).
- Read
Retrieve scoring code by project ID
Retrieve Scoring Code for making new predictions from an existing model offline. You need the "Scoring Code" feature enabled to use this route.
- Read
Get supported capabilities by project ID
Get supported capabilities for a model.
- Read
Get Prime files by project ID
List all DataRobot Prime files available for download.
- Read
Retrieve metadata about a DataRobot Prime file by project ID
Retrieve metadata about a DataRobot Prime file available for download.
- Read
Download code by project ID
Download code from an existing Prime file.
- Read
List all Prime models by project ID
List all Prime models in a project.
- Read
Retrieve Prime model details by project ID
Retrieve Prime model details.
- Read
List recommended models by project ID
Retrieves all of the current recommended models for the project
- Read
Get the recommended model by project ID
This route returns the simplest recommended model available. To see all the available recommended models, use :http:get:/api/v2/projects/(projectId)/recommendedModels/
- Read
Get RuleFit code files by project ID
List all RuleFit code files available for download.
- Read
Get RuleFit code file information by project ID
Get information about a RuleFit code file available for download.
- Read
Download RuleFit code by project ID
Download code from an existing RuleFit file.
- Write
Add a request by project ID
Add a request to the queue to train a model with bias mitigation applied. If the job has been previously submitted, the request will return the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.
- Write
Submit a job by project ID
Submit a job to create bias mitigation data quality information for a given projectId and featureName.
- Write
Create a blender by project ID
Create a blender from other models using a specified blender method. Note: Time Series projects only allow the following blender methods: "AVG", "MED", "FORECASTDISTANCEENET", and "FORECASTDISTANCEAVG".
- Write
Train a new datetime model by project ID
Train a new datetime model. All durations and datetimes should be specified in accordance with the :ref:timestamp and duration formatting rules .
- Write
Retrain an existing datetime model by project ID
Retrain an existing datetime model using a new training period for the model training set (with optional time window sampling) or different feature list. All durations and datetimes should be specified in accordance with the :ref:timestamp and duration formatting rules .
- Write
Score all the available backtests of a datetime model by project ID
Score all the available backtests of a datetime model.
- Write
Prepare a model by project ID
Prepare a specific model for deployment. This model will go through the recommendation stages.
- Write
Create a new model by project ID
Create a new model from an existing eureqa solution.
- Write
Train a frozen datetime model by project ID
Train a frozen datetime model. If no training data is specified, the frozen datetime model will be trained on the most recent data using an amount of data that is equivalent to the original model.
- Write
Train a new frozen model by project ID
Train a new frozen model with parameters from an existing model. Frozen models use tuning parameters from another model on the leaderboard, allowing them to be retrained on a larger amount of the training data more efficiently.
- Write
Train a new incremental learning model based on an existing model and external data, that was not by project ID
Train a new incremental learning model based on an existing model and external data, that was not seen during partitioning.
- Write
Train a new model by project ID
Train a new model. To specify the amount of data to use to train the model, use either samplePct to express a percentage of the rows of the dataset to use or trainingRowCount to express the number of rows to use.
- Write
Retrain a model by project ID
Retrain an existing model using a new sample size and/or feature list.When configuring retraining sample sizes for models in projects with large row counts, DataRobot recommends requesting sample sizes using integer row counts instead of percentages.
- Write
Update a model's attributes by project ID
Update a model's attributes.
- Write
Create advanced tuning by ID
Submit a job to make a new version of the model with different advanced tuning parameters. Note: This route currently supports all models other than: OSS, blenders, prime, scaleout, baseline and user-created. Currently, only single-stage models (most simple models) are supported.
- Write
Update cluster names assigned by project ID
Update and then retrieve all cluster names assigned to an unsupervised cluster model
- Write
Run cross validation by project ID
Run cross validation on a model.
- Write
Calculate prediction intervals by project ID
Submit a job to calculate prediction intervals for the specified percentiles for this model. Note that the project this model belongs to must be a time series project.
- Write
Create Rulesets by project ID
Approximate an existing model on the leaderboard with DataRobot Prime. A request body should be an empty JSON {}. Deprecated in v2.35.
- Write
Create a Prime File by project ID
Request creation and validation of source code from a Prime model. Deprecated in v2.35.
- Write
Create a Prime Model from a Ruleset by project ID
Create a Prime model using a particular ruleset. DataRobot Prime is not available for multiclass projects.
- Write
Create a RuleFit code file by project ID
Request creation and validation of source code from a RuleFit model.
- Destructive
Cancel a modeling job by project ID
Cancel a modeling job.
- Destructive
Delete a model by project ID
Delete a model from the leaderboard
- Destructive
Update champion model by project ID
Update champion model for a segment project.
Quotas
- Read
Retrieve Quota Templates
GET /api/v2/quotaTemplates/
- Read
Retrieve Quota Templates by quota template ID
GET /api/v2/quotaTemplates/{quotaTemplateId}/
- Read
Retrieve Quotas
GET /api/v2/quotas/
- Read
Retrieve Quotas by quota ID
GET /api/v2/quotas/{quotaId}/
- Write
Create Quotas
POST /api/v2/quotas/
- Write
Modify Quotas by quota ID
PATCH /api/v2/quotas/{quotaId}/
- Destructive
Delete Quotas by quota ID
DELETE /api/v2/quotas/{quotaId}/
Data wrangling
- Read
List recipes.
Get a list of the recipes available for given user.
- Read
Retrieve a wrangling recipe by recipe ID
Retrieve a wrangling recipe given ID.
- Read
Gets inputs by recipe ID
Gets inputs of the given recipe.
- Read
Retrieve recipe insights by recipe ID
Retrieve recipe insights.
- Read
Retrieve a recipe operation details by recipe ID
Returns an operation configuration with an additional inputColumns field to show the list of columns available at that stage.
- Read
Retrieve a wrangling preview by recipe ID
Retrieve a wrangling preview given ID.
- Read
Retrieve generated time series transformation plan by recipe ID
Returns a list of recipe operations, which serve as the plan to transform a regular dataset into a time series dataset.
- Write
Create a recipe and a data source
Create a recipe which could be used for wrangling from a created fully reconfigured source of data.
- Write
Create a recipe given dataset.
Create a recipe which could be used for wrangling from given dataset.
- Write
Clone given wrangling recipe.
Shallow copy the given recipe, reusing existing data sources. Implicitly creates duplicate of wrangling session.
- Write
Patched wrangling recipe by recipe ID
Patch a wrangling recipe name and description
- Write
Start the job by recipe ID
Starts the preview process for the recipe. Since this is an asynchronous process this endpoint returns a status ID to use with the status endpoint and a location header with the URL that can be polled for status.Launch WranglingJob, which includes: 1.
- Write
Submit a relationship quality assessment job by recipe ID
Submit a job to assess the quality of the relationship configuration within a Feature Discovery session in Workbench.
- Write
Updates recipe settings by recipe ID
Updates some recipe settings applicable in the modeling stage.
- Write
Build SQL query by recipe ID
Builds a SQL query for the recipe. Overrides operations to get the adjusted query without changing the recipe.
- Write
Generate a time series transformation plan by recipe ID
Generate a list of recipe operations, which serve as the plan to transform a regular dataset into a time series dataset.
- Destructive
Deletes the wrangling recipe by recipe ID
Marks the wrangling recipe with a given ID as deleted.
- Destructive
Updates the downsampling by recipe ID
Updates the downsampling directive in the recipe.Downsampling will be applied on top of the recipe during publishing.
- Destructive
Sets the input of the given recipe by recipe ID
Set the inputs on a recipe to change the configuration. Implicitly restart the initial sampling job which calculates:1) Column names;2) resulting size of the sample in bytes;3) resulting size of the sample in rows.
- Destructive
Update the operations by recipe ID
Updates the operations in a recipe by saving new directives. To validate the new operations, run preview validation and SQL generation. To apply them to the new recipe, you must run a request to preview the results must be run.
- Destructive
Stop wrangling session.
Stop the underlying interactive Spark session, if applicable.
Seat licenses
- Read
List seat license allocations.
List seat license allocations. Org admins can view seat licenses that were allocated to their organization. System admins can view allocations across all organizations.
- Read
List users without a seat license.
List the active users of an organization who hold no seat license of any type, ordered by username. Org admins list their own organization. System admins must pass orgId.
- Read
Retrieve a seat license allocation by allocation ID
Retrieve an allocated seat license by ID. Org admins can view seat licenses that were allocated to their organization. System admins can view allocations across all organizations.
- Read
List seat licenses.
List seat licenses in the current installation. Seat licenses may become available only when applied through the cluster license. Accessible to system admins only.
- Write
Allocate seat licenses.
Allocate the seat license to the organization, given that the total number of allocated seats in the cluster, including the new organization's limit, does not exceed the cluster-level limit applied through the license key. Available to system admins only.
- Write
Evaluate the seat license
Evaluate whether the subject has been authorized to use the seat license.
- Write
Update a seat license allocation by allocation ID
Update Seat License Allocation.
- Destructive
Delete a seat license allocation by allocation ID
Delete the seat license allocation. Only system admins can execute this operation.
Secure config
- Read
Retrieve a list of secure configuration schemas.
Retrieve all secure configuration schemas.
- Read
Retrieve a secure configuration schema by secure config schema ID
Retrieve a secure configuration schema.
- Read
Retrieve a list of secure configurations.
Retrieve all secure configurations.
- Read
Retrieve a secure configuration by secure config ID
Retrieve a secure configuration.
- Read
Retrieve a list of values by secure config ID
Retrieve all values created for the secure configuration.
- Write
Create a secure configuration.
Create a secure configuration.
- Write
Update a secure configuration by secure config ID
Update a secure configuration.
- Destructive
Delete secure configuration by secure config ID
Delete secure configuration and its values.
Jobs
- Read
List tasks
List the async tasks that are currently running for your account
- Read
Get task status by status ID
Check the status of an asynchronous task such as project creation
- Destructive
Delete a task by status ID
Destroy an async status object
Utilities
- Write
Encrypt a string
DataRobot does not store your credentials when accessing external data stores. Instead you first encrypt your sensitive information with DataRobot and then, when accessing those data stores, supply the encrypted credentials.
Workloads
- Read
List Resource Bundles
List resource bundles available to the authenticated user. Union of the platform's workload-curated compute bundles and any additional bundles already in use across the user's enclaves. Bundle listing is tenant-wide, so no enclave id is needed (or accepted) here.
- Read
List Workloads
List all workloads accessible to the authenticated user.
- Read
Get All Workloads Stats
Get aggregated statistics across all workloads accessible to the authenticated user.
- Read
Get Workload by workload ID
Retrieve a workload by ID.
- Read
Get Workload Events by workload ID
List events for a workload, such as status changes and errors.
- Read
Get Artifact Histories by workload ID
List the artifact deployment history for a workload.
- Read
List Workload Protons by workload ID
List all protons associated with a workload.
- Read
Get Workload Proton by workload ID
Get a specific proton for a workload.
- Read
Get Workload Proton Status Details by workload ID
Get per-replica status details for a proton. Returns 204 if no status update has been received yet. Returns 200 with the latest replica snapshot when available.
- Read
Get Workload Related Entities by workload ID
List entities related to a workload, such as linked artifacts.
- Read
Get Replacement by workload ID
Get Replacement by workload ID
- Read
Get Workload Settings by workload ID
Retrieve the configuration settings for a workload.
- Read
Get Workload Stats by workload ID
Get aggregated performance statistics for a workload. For agent workloads, and only for users with agent monitoring enabled, the response also carries an agent block with token usage, tool, component and guard-quality statistics.
- Read
Get Workload Stats Per Metric by workload ID
Get time-series data for a specific performance metric of a workload.
- Write
Create Workload
Create a workload from the specified artifact and schedule its initial runtime.
- Write
Update Workload by workload ID
Partially update a workload's name, description and importance. Runtime settings are changed with PATCH /workloads/{workloadId}/settings and the deployed artifact with POST /workloads/{workloadId}/replacement.
- Write
Promote Workload Artifact by workload ID
Lock the draft artifact currently running on a workload. The workload continues running the same artifact, which is promoted from draft to locked and assigned a version number. Workload stats are reset and the event is recorded in the replacement history.
- Write
Create Replacement by workload ID
Start a rolling replacement of a workload onto an existing artifact. A body naming a field that another endpoint changes is rejected with 422, one error per such field saying where it is changed; any other field is ignored.
- Write
Update Workload Settings by workload ID
Update workload runtime settings by triggering a rolling replacement with the current artifact. Only runtime is applied here. A body naming a field that another endpoint changes is rejected with 422, one error per such field saying where it is changed; any other field is ignored.
- Write
Start Workload by workload ID
Start a workload by scheduling its proton.
- Write
Stop Workload by workload ID
Stop a workload by stopping its proton.
- Destructive
Delete Workload by workload ID
Delete a workload permanently. Returns 204 on success. Proton stop failures are logged internally but do not change the response status.
- Destructive
Delete Replacement by workload ID
Delete Replacement by workload ID
- Destructive
Reset Workload Stats by workload ID
Clear collected statistics for a workload within the specified time range.
Permadelete
- Read
Get Permadelete Job by job ID
Get Permadelete Job by job ID
No operations match.
See How connections work for access and permissions, or browse all integrations.