This topic provides complete reference information about all of Domino’s public REST API endpoints. For details about endpoints that are not officially public, see the legacy Domino Data Lab API documentation.
AsyncPredictions
Request a prediction from an Async model
POST
/api/modelApis/async/v1/{asyncModelId}
Description
Request a prediction from an Async Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
asyncModelId | Id of Async Model | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewAsyncPredictionV1 | Information for new Async Prediction NewAsyncPredictionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 413 | ||
| 422 | ||
| 429 | ||
| 500 |
Retrieve the result of an Async Model prediction
GET
/api/modelApis/async/v1/{asyncModelId}/{asyncPredictionId}
Description
Retrieve the result of an Async Model prediction
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
asyncModelId | Id of Async Model | string | path | ||
asyncPredictionId | Id of Async Prediction | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Cost
Get the cost allocation over a time window
GET
/api/cost/v1/allocation
Description
Retrieve cost allocation
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | string | query | ||
start | Start time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
end | End time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
accumulate | If the result will be accumulated. Default is false. If true, the result will be accumulated from the start time to the end time. | boolean | query | ||
filter | Filter the result by cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster. | string | query | ||
shareIdle | if the idle cost will be shared | boolean | query | ||
shareNamespaces | list of namespaces to share the costs | string | query | ||
shareSplit | Determines how to split shared costs among non-idle, unshared allocations. | string | query | ||
shareCost | The cost to share | string | query | ||
shareLabels | The label to share the cost | string | query | ||
reconcile | If the cost will be reconciled | boolean | query | ||
shareTenancyCosts | If the tenancy costs will be shared | boolean | query | ||
idle | If the idle cost will be calculated | boolean | query | ||
external | If the external cost will be calculated | boolean | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success |
Get the asset cost over a time window
GET
/api/cost/v1/asset
Description
Retrieve asset cost
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | string | query | ||
start | Start time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
end | End time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
accumulate | If the result will be accumulated. Default is false. If true, the result will be accumulated from the start time to the end time. | boolean | query | ||
filter | Filter the result by cluster, namespace, pod, deployment, service, daemonset, statefulset | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success |
Set AWS Billing API Configuration
PUT
/athenaConfigs
Description
Set AWS Billing API Configuration
Body Parameter
| Name | Description | Required |
|---|---|---|
AthenaBillingConfigsV1 | AWS Billing API Config AthenaBillingConfigsV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Add kubecost license key
PUT
/licenseKey
Description
Add kubecost license key
Body Parameter
| Name | Description | Required |
|---|---|---|
KubecostLicenseV1 | Kubecost License Key KubecostLicenseV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
CustomMetrics
Send a metric alert
POST
/api/metricAlerts/v1
Description
Send a metric out of range alert for a monitored model. Required Permissions: None
Body Parameter
| Name | Description | Required |
|---|---|---|
MetricAlertRequestV1 | Details about the metric alert to send MetricAlertRequestV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Log metric values
POST
/api/metricValues/v1
Description
Log metric values. Required Permissions: None
Body Parameter
| Name | Description | Required |
|---|---|---|
NewMetricValuesEnvelopeV1 | List of metric values to log NewMetricValuesEnvelopeV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 201 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Retrieve metric values
GET
/api/metricValues/v1/{modelMonitoringId}/{metric}
Description
Retrieve metric values. Required Permissions: None
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelMonitoringId | ID of the monitored model | string | path | ||
metric | Name of the metric to retrieve | string | path | ||
startingReferenceTimestampInclusive | Timestamp to filter metrics by referenceTimestamp >= startingReferenceTimestampInclusive. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00 | string | query | ||
endingReferenceTimestampInclusive | Timestamp to filter metrics by referenceTimestamp <= endingReferenceTimestampInclusive. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00 | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DatasetRw
Deprecated - Get datasets accessible to user
GET
/api/datasetrw/v1/datasets
Description
Deprecated: Use GetDatasetsV2. Get Datasets that a user has access to
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID filter | string | query | ||
offset | How many Datasets from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Datasets to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a dataset
POST
/api/datasetrw/v1/datasets
Description
Create a new Dataset. Requires access to the project the dataset will originate from
Body Parameter
| Name | Description | Required |
|---|---|---|
NewDatasetRwV1 | Dataset to create NewDatasetRwV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Update dataset metadata
PATCH
/api/datasetrw/v1/datasets/{datasetId}
Description
Update Dataset name or description. Requires Update access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to update | string | path | 62604702b7e5d347dbe7a909 |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetRwMetadataV1 | Fields to update DatasetRwMetadataV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get dataset grants by ID
GET
/api/datasetrw/v1/datasets/{datasetId}/grants
Description
Get Dataset grants by ID. Requires List access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to get grants for | string | path | 62604702b7e5d347dbe7a909 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Add a grant to a dataset's existing sequence of grants
POST
/api/datasetrw/v1/datasets/{datasetId}/grants
Description
Add a grant to a dataset's existing sequence of grants. Requires EditSecurity access to the dataset.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to add a grant to | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetRwGrantV1 | Grant to add DatasetRwGrantV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Remove a grant from a dataset's existing sequence of grants
DELETE
/api/datasetrw/v1/datasets/{datasetId}/grants
Description
Remove a grant from a dataset's existing sequence of grants. Requires EditSecurity access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to remove the grant from | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetRwGrantV1 | Grant to remove DatasetRwGrantV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get snapshots belonging to dataset
GET
/api/datasetrw/v1/datasets/{datasetId}/snapshots
Description
Get Snapshots belonging to a dataset. Requires List access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to retrieve snapshots for | string | path | 62604702b7e5d347dbe7a909 | |
offset | How many Snapshots from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Snapshots to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a snapshot
POST
/api/datasetrw/v1/datasets/{datasetId}/snapshots
Description
Create a new Snapshot in a dataset. Requires Read access to the dataset and project access
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | Dataset ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewSnapshotV1 | Snapshot to create NewSnapshotV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Tag a snapshot in this Dataset
POST
/api/datasetrw/v1/datasets/{datasetId}/tags
Description
Tag a snapshot in this Dataset with the given tagName. Requires Update access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | Dataset ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetRwTagToAddV1 | Tag name and snapshot ID to apply it to DatasetRwTagToAddV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Remove a tag from a Dataset
DELETE
/api/datasetrw/v1/datasets/{datasetId}/tags/{tagName}
Description
Remove a Tag from a dataset. Requires Update access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | Dataset ID | string | path | ||
tagName | Name of tag to delete | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get datasets the user has access to
GET
/api/datasetrw/v2/datasets
Description
Get Datasets that a user has access to based on dataset permissions and input filters
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
minimumPermission | Filter for minimum dataset permission the principal needs to have in returned datasets. | Undefined | query | ||
projectIdsToExclude | ProjectIds of datasets to exclude from result. | array | query | ||
projectIdsToInclude | ProjectIds to get the datasets from. Should not be passed in if projectIdsToExclude is and vice versa. | array | query | ||
includeProjectInfo | Boolean to determine whether or not to return project-info in return objects. | boolean | query | ||
offset | How many Datasets from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Datasets to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DataSource
Get DataSource Audit Data
GET
/api/datasource/v1/audit
Description
Gets data source audit data given filter input parameters
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
dataSourceIds | Datasource IDs to query audit data for | array | query | ||
dataSourceNames | Datasource names to query audit data for | array | query | ||
eventKinds | events to query - AccessDataSource, CreateDataSource, DataSourceAssociatedToProject, DataSourceDissociatedFromProject, DataSourceChangeOfOwnership, DataSourceChangeOfPermissions, DeleteDataSource | array | query | ||
startTime | Start time (iso8601) | string | query | ||
endTime | End time (iso8601) | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Environments
Get Environments visible to a user
GET
/api/environments/beta/environments
Description
Get environments that a user can see. Required permissions: `None`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many Environments from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Environments to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create an environment
POST
/api/environments/beta/environments
Description
Create an environment. Required permissions: `CreateEnvironment, EditEnvironment, UseFileStorage`.
Note
This is a beta endpoint with known limitations.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewEnvironmentV1 | Environment to create NewEnvironmentV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a Revision of an Environment
POST
/api/environments/beta/environments/{environmentId}/revisions
Description
Create a revision of an environment. Required permissions: `ManageEnvironments, EditEnvironment, UseFileStorage`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | Id of environment to create revision of | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewEnvironmentRevisionV1 | Environment revision to create NewEnvironmentRevisionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Update the restricted revision of an environment
PATCH
/api/environments/beta/environments/{environmentId}/revisions/{revisionId}
Description
Update a revision of an environment to mark if isRestricted. Required permissions: `ClassifyEnvironments`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | Id of environment to mark restricted revision | string | path | ||
revisionId | Id of environment revision to mark is restricted | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdateEnvironmentRevisionV1 | Body of isRestricted UpdateEnvironmentRevisionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get an environment
GET
/api/environments/v1/environments/{environmentId}
Description
Get an Environment by its Id. Required permissions: `ViewEnvironment`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | Id of environment to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Archive an environment
DELETE
/api/environments/v1/environments/{environmentId}
Description
Archive an Environment, removing it from the list of visible environments. Required permissions: `ManageEnvironments, EditEnvironment`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | Id of environment to archive | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Jobs
Get Jobs for a project
GET
/api/jobs/beta/jobs
Description
Retrieve all Jobs that belong to a project. Required permissions: `ViewJobs.`
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Id of project to retrieve Jobs for | string | query | 622a6944dde1a920fcccff0d | |
offset | Number of jobs from the start to skip. Defaults to 0. | integer | query | 2 | |
limit | Total number of Jobs to retrieve. Defaults to 10. | integer | query | 25 | |
sortBy | Field to sort Jobs by. Defaults to "number". | string | query | number title command startedTime duration status user commentCount dominoStatsField | |
dominoStatsSortFieldName | Field in domino stats to sort by. Only used if sortBy = dominoStatsField. | string | query | r-squared | |
ascending | Whether to sort ascending or descending. Defaults to False. | boolean | query | ||
showArchived | Whether to include archived Jobs in results. Defaults to false. | boolean | query | ||
statusFilter | Status of Jobs to fetch. Defaults to "all". | string | query | all queued running completed archived active | |
tagFilter | Tag to filter by. Must match tag name exactly. | string | query | MyTag |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get Job details
GET
/api/jobs/beta/jobs/{jobId}
Description
Retrieve a Job's details by its Id. Required permissions: `ViewJobs`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of Job to retrieve details for | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get logs for a Job
GET
/api/jobs/beta/jobs/{jobId}/logs
Description
Retrieve the logs for the Job with the specified Id. Required permissions: `ViewJobs`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to get logs for | string | path | ||
logType | Type of log to retrieve. Case insensitive. | string | query | stdOut stdErr prepareOutput complete | |
limit | Max number of log lines to fetch. Will not retrieve over 10000 log lines at a time. | integer | query | ||
latestTimeNano | The epoch time in nanoseconds to start fetching from | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Link a goal to a job
POST
/api/jobs/v1/goals
Description
Link the Goal with the specified Id to a Job. Required permissions: `ViewJobs, Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to link to goal | string | query |
Body Parameter
| Name | Description | Required |
|---|---|---|
GoalToLinkV1 | undefined GoalToLinkV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Unlink goal from job
DELETE
/api/jobs/v1/goals/{goalId}
Description
Unlink the Goal with the specified Id from a Job. Required permissions: `ViewJobs, Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
goalId | Id of goal to remove | string | path | ||
jobId | Id of job to remove goal from | string | query | ||
projectId | Id of project for the goal | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Start a Job
POST
/api/jobs/v1/jobs
Description
Start a new Job. Required permissions: `StartJob, UseGlobalCompute`
Body Parameter
| Name | Description | Required |
|---|---|---|
NewJobV1 | undefined NewJobV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Add a tag to a Job
POST
/api/jobs/v1/jobs/{jobId}/tags
Description
Add a Tag to the Job with the specified Id. Required permissions: `ViewJobs`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to add tag to | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
TagToAddV1 | undefined TagToAddV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Remove a tag from a Job
DELETE
/api/jobs/v1/jobs/{jobId}/tags/{tagId}
Description
Remove a Tag from the Job with the specified Id. Required permissions: `ViewJobs`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to remove tag from | string | path | ||
tagId | Id of tag to remove | string | path | ||
projectId | Id of project that tag belongs to | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Organizations
Get the Organizations for a user
GET
/api/organizations/v1/organizations
Description
Retrieve all Organizations of which this user is a member. Required permissions: `None`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
nameFilter | Optional value to filter organization names with. Must exactly match organization name. | string | query | ||
offset | How many orgs from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of orgs to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create an organization
POST
/api/organizations/v1/organizations
Description
Create a new Organization. Required permissions: `Must be logged in user`
Body Parameter
| Name | Description | Required |
|---|---|---|
NewOrganizationV1 | undefined NewOrganizationV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get all organizations. Only accessible to admin users.
GET
/api/organizations/v1/organizations/all
Description
Get all organizations. Required permissions: `ManageOrganizations`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
nameFilter | Optional value to filter organization names with. | string | query | ||
offset | How many orgs from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of orgs to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get an organization by Id
GET
/api/organizations/v1/organizations/{organizationId}
Description
Retrieve an Organization by its Id. Required permissions: `ViewOrganization`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
organizationId | Id of organization to retrieve. This is the id of the org in the users collection, not the organizations collection. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Add a user to an org
PUT
/api/organizations/v1/organizations/{organizationId}/user
Description
Add a new user to an Organization. Required permissions: `EditMembers`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
organizationId | Id of organization to add a user to. This is the id of the org in the users collection, not the organizations collection. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
OrganizationMemberV1 | undefined OrganizationMemberV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Remove a user from an org
DELETE
/api/organizations/v1/organizations/{organizationId}/user
Description
Remove a user from an Organization. Required permissions: `EditMembers`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
organizationId | Id of organization to add a user to. This is the id of the org in the users collection, not the organizations collection. | string | path | ||
memberToRemoveId | Id of user to remove from org. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Projects
Get Projects visible to user
GET
/api/projects/beta/projects
Description
Get projects that a user can see. Required permissions: `ListProject`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many Projects from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Projects to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a project
POST
/api/projects/beta/projects
Description
Create a project. Required permissions: `CreateProject, UseFileStorage`.
Note
This is a beta endpoint with known limitations.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewProjectV1 | Project to create NewProjectV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Archive project by id
DELETE
/api/projects/beta/projects/{projectId}
Description
Archive a project by id. Required permissions: `ArchiveProject`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a new project by copying an existing project and providing optional overrides. Deprecated.
POST
/api/projects/beta/projects/{projectId}/copy-project
Description
Create a new project by copying an existing project and providing optional overrides. Specify a git repository to link to the copied project or copy the original project's git repository for the copied project.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
CopyProjectSpecBeta | Information needed in order to copy a project. CopyProjectSpecBeta |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Update project result settings
PUT
/api/projects/beta/projects/{projectId}/results-settings
Description
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ProjectResultsSettingsV1 | Project status ProjectResultsSettingsV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Add a collaborator to this project
POST
/api/projects/v1/projects/{projectId}/collaborators
Description
Add a collaborator to this project. Required permissions: `ManageCollaborators`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ProjectCollaboratorV1 | Collaborator ID ProjectCollaboratorV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Remove a collaborator from project
DELETE
/api/projects/v1/projects/{projectId}/collaborators/{collaboratorId}
Description
Remove a collaborator from the project. Required permissions: `ManageCollaborators`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to remove collaborator from | string | path | ||
collaboratorId | ID of the collaborator to remove | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a new project by copying an existing project and providing optional overrides.
POST
/api/projects/v1/projects/{projectId}/copy-project
Description
Create a new project by copying an existing project and providing optional overrides. Specify a git repository to link to the copied project or copy the original project's git repository for the copied project.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
CopyProjectSpecV1 | Information needed in order to copy a project. CopyProjectSpecV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 429 | ||
| 500 |
Add a goal to this project
POST
/api/projects/v1/projects/{projectId}/goals
Description
Add a goal to this project. Required permissions: `Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewProjectGoalV1 | Goal to add NewProjectGoalV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Update project goal status
PATCH
/api/projects/v1/projects/{projectId}/goals/{goalId}
Description
Update project goal status. Required permissions: `Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID of the goal | string | path | ||
goalId | ID of the goal to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ProjectGoalForUpdateV1 | Project goal for update ProjectGoalForUpdateV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Delete a project goal
DELETE
/api/projects/v1/projects/{projectId}/goals/{goalId}
Description
Delete a project goal. Required permissions: `Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to delete goal from | string | path | ||
goalId | ID of the goal to delete | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get all imported git repositories in this project
GET
/api/projects/v1/projects/{projectId}/repositories
Description
Get all imported git repositories in this project. Required permissions: `ListProject`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path | ||
offset | How many Projects from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Projects to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Add an imported git repository to this project
POST
/api/projects/v1/projects/{projectId}/repositories
Description
Add an imported git repository to this project. Required permissions: `ChangeProjectSettings`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewProjectGitRepositoryV1 | Repository to add NewProjectGitRepositoryV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Remove an imported repository from project
DELETE
/api/projects/v1/projects/{projectId}/repositories/{repositoryId}
Description
Remove an imported repository from the project. Required permissions: `ChangeProjectSettings`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to remove goal from | string | path | ||
repositoryId | ID of the repository to remove | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Update project status
PUT
/api/projects/v1/projects/{projectId}/status
Description
Update the status of a project. Required permissions: `Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ProjectStatusV1 | Project status ProjectStatusV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
ProjectsFiles
Returns the contents of a file
GET
/api/projects/beta/projects/{projectId}/files/{commitId}/{path}/content
Description
Return the raw contents of a file in a project at given commit.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Id of the project to return files for | string | path | ||
commitId | Id of a commit in the project repository to list files from | string | path | ||
path | Path in the project's repository to the file. It must be url-encoded and is case-sensitive. | string | path | nested%2Ffolder%2Ffile.ext |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success. It returns a stream of data with the file content, specifying the appropriate media type based on the file extension in a best-effort basis. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
ProjectSharedDatasets
Get shared datasets that a project uses
GET
/api/projects/v1/projects/{projectId}/shared-datasets
Description
List shared datasets used by a project. Required permissions: `GetDatasetsRw`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Link a shared dataset to this project
POST
/api/projects/v1/projects/{projectId}/shared-datasets
Description
Link a shared dataset to this project. Required permissions: `ManageDatasetsRw,UseFileStorage`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetToAddV1 | Dataset ID DatasetToAddV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Unlink a shared dataset from this project
DELETE
/api/projects/v1/projects/{projectId}/shared-datasets/{datasetId}
Description
Unlink the dataset with the specified Id from a project. Required permissions: `ManageDatasetsRw,UseFileStorage`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Id of project | string | path | ||
datasetId | Id of shared dataset to remove | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success |
RegisteredModels
Get Registered Models visible to user
GET
/api/registeredmodels/v1
Description
Get registered models that a user can see.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID of requested models. | string | query | ||
searchPattern | Search parameter to retrieve models from Mlflow (currently supports name and tags) | string | query | ||
pageToken | Pagination token to go to the next page based on a previous search query. | string | query | ||
maxResults | Max number of Registered Models to fetch. Defaults to 25. | integer | query | ||
orderBy | List of columns for ordering search results, which can include model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default. Tiebreaks are done by model name ASC. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a new a Registered Model from an experiment run
POST
/api/registeredmodels/v1
Description
Create a new a Registered Model from an experiment run
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelV1 | Details of the registered model to create NewRegisteredModelV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get a list of Registered Models' names visible to user
GET
/api/registeredmodels/v1/names
Description
Get a list of Registered Models' names visible to user.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
search | Search filter by model name | string | query | ||
offset | How many Registered Models from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Registered Models to fetch. Defaults to 10. | integer | query | ||
projectId | Project ID of requested models. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get Registered Models visible to user
GET
/api/registeredmodels/v1/ui
Description
Get registered models that a user can see.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID of requested models. | string | query | ||
searchPattern | Search parameter to retrieve models from Mlflow (currently supports name and tags) | string | query | ||
globallyDiscoverable | globallyDiscoverable flag to indicate if we want to return globally discoverable models. Defaults to false. | boolean | query | ||
pageToken | Pagination token to go to the next page based on a previous search query. | string | query | ||
maxResults | Max number of Registered Models to fetch. Defaults to 25. | integer | query | ||
orderBy | List of columns for ordering search results, which can include model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get registered model version stages for a project
GET
/api/registeredmodels/v1/versions/stages/projects/{projectId}
Description
Get registered model version stages for a project
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path | ||
includeDefaults | includeDefaults flag to indicate if we want to return global stages if no overrides are set for the project | boolean | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Set registered model version stages for a project
PUT
/api/registeredmodels/v1/versions/stages/projects/{projectId}
Description
Set registered model version stages for a project
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
RegisteredModelVersionStagesV1 | List of registered model version stages to set for a project RegisteredModelVersionStagesV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Update a Registered Model
PATCH
/api/registeredmodels/v1/{modelName}
Description
Update a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
PatchRegisteredModelV1 | Details of the model to update PatchRegisteredModelV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Returns list of Model APIs deployed from a specific Registered Model
GET
/api/registeredmodels/v1/{modelName}/modelapis
Description
Gets all active model Apis that were deployed from a given Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get all versions of a Registered Model
GET
/api/registeredmodels/v1/{modelName}/versions
Description
Get all versions of a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
offset | Offset for pagination from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Registered Models to fetch. Defaults to 20 | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a new version of a Registered Model
POST
/api/registeredmodels/v1/{modelName}/versions
Description
Create a new version of a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelVersionV1 | Details of the model version to create NewRegisteredModelVersionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get a specific version of a Registered Model
GET
/api/registeredmodels/v1/{modelName}/versions/{version}
Description
Get a specific version of a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Update a Registered Model version
PATCH
/api/registeredmodels/v1/{modelName}/versions/{version}
Description
Update a Registered Model version
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedRegisteredModelVersionV1 | Updated details of the registered model version UpdatedRegisteredModelVersionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Returns list of Model APIs deployed from a specific Registered Model Version
GET
/api/registeredmodels/v1/{modelName}/versions/{version}/modelapis
Description
Gets all active model Apis that were deployed from a given Registered Model Version
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a review of a Registered Model
POST
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews
Description
Create a review of a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelReviewV1 | Details about the review to create NewRegisteredModelReviewV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 201 | Created | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Update a review of a Registered Model - add or remove reviewers with an option to change notes, or change status to canceled with an option to change notes but cannot do both simultaneously or simply change notes
PATCH
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews/{modelReviewId}
Description
Update a review of a Registered Model by 1) adding or remove reviewers with an option to change notes, or 2) changing status to canceled with an option to change notes, but cannot do both simultaneously, or 3) changing only notes
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path | ||
modelReviewId | Id of the model review to edit | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedRegisteredModelReviewV1 | Details about the review edit UpdatedRegisteredModelReviewV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | Updated | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Create a response to a Registered Model review
POST
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews/{modelReviewId}/responses
Description
Create a response to a Registered Model review
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path | ||
modelReviewId | Id of Model Review | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelReviewResponseV1 | Details about the review to create NewRegisteredModelReviewResponseV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 201 | Created | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get registered model version stages valid for starting a model review
GET
/api/registeredmodels/v1/{modelName}/versions/{version}/reviewstages
Description
Get registered model version stages valid for starting a model review
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | model name | string | path | ||
version | version of the model | integer | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Validates whether a model version can transition to a given stage
PUT
/api/registeredmodels/v1/{modelName}/versions/{version}/stages/validation
Description
Validates whether a model version can transition to a given stage
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
RegisteredModelVersionStageValidationV1 | The information of the stage to transition RegisteredModelVersionStageValidationV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Users
Get git credential accessor for a User
GET
/api/users/beta/credentials/{userId}
Description
Retrieve a users git credentials. Required permissions: `UpdateUser`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
userId | Id of the User to fetch creds for | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Get all users visible to the current user
GET
/api/users/v1/users
Description
Retrieves all users visible to the current user. Required permissions: `None`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many users from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of users to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
Workspaces
Create workspace session
POST
/api/projects/v1/projects/{projectId}/workspaces/{workspaceId}/sessions
Description
Creates a new session given an existing workspace. Required permissions: `OpenWorkspace`, `UseGlobalCompute`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path | ||
workspaceId | Workspace ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewWorkspaceSessionV1 | New session parameters NewWorkspaceSessionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
ComputeClusterConfigV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| clusterType | ClusterTypeV1 | |||
| computeEnvironmentId | String | Id of compute environment to use. | 623139857a0af0281c01a6a4 | |
| computeEnvironmentRevisionSpec | EnvironmentRevisionSpecV1 | |||
| masterHardwareTierId | String | Hardware tier to use for master node in compute cluster. | medium-k8s | |
| maxWorkerCount | Integer | Max number of workers to use in compute cluster. Enables auto-scaling for cluster when present. | 10 | |
| workerCount | Integer | Number of workers to use in compute cluster. Used as min number of workers in maxWorkerCount is set. | 4 | |
| workerHardwareTier | String | Hardware tier to use for workers in compute cluster. | large-k8s | |
| workerStorageMB | Number | Disk size in MB for each worker. | 5 |
CopyProjectSpecBeta
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| copyDatasets | Boolean | Whether to copy the Project's datasets or not | ||
| gitCodeRepoSpec | GitCodeRepoSpecBeta | |||
| importedGitReposCredentialId | String | The Domino ID of the PAT credential, which will be used to access the Imported Git Repos on the new project. | ||
| name | String | The name of the new Domino Project. | ||
| ownerId | String | The Domino ID of owner of the copied project. | ||
| visibility | ProjectVisibilityV1 | The visibility of the new Project. |
CopyProjectSpecV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| copyDatasets | Boolean | Whether to copy the Project's datasets or not | ||
| gitCodeRepoSpec | GitCodeRepoSpecV1 | |||
| importedGitReposCredentialId | String | The Domino ID of the PAT credential, which will be used to access the Imported Git Repos on the new project. | ||
| name | String | The name of the new Domino Project. | ||
| ownerId | String | The Domino ID of owner of the copied project. | ||
| visibility | ProjectVisibilityV1 | The visibility of the new Project. |
CostAllocationEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAllocationV1 |
CostAllocationV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| cpuCoreHours | Double | |||
| cpuCoreRequestAverage | Double | |||
| cpuCoreUsageAverage | Double | |||
| cpuCores | Double | |||
| cpuCost | Double | |||
| cpuCostAdjustment | Double | |||
| cpuEfficincy | Double | |||
| discount | Double | |||
| gpuCount | Double | |||
| gpuHours | Double | |||
| gpucost | Double | |||
| gpucostAdjustment | Double | |||
| labels | Object | |||
| loadBalancerCost | Double | |||
| loadBalancerCostAdjustment | Double | |||
| name | String | |||
| nodeType | String | |||
| pv | Object | |||
| ramCost | Double | |||
| ramCostAdjustment | Double | |||
| totalCost | Double | |||
| window | Object |
CostAssetsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAssetsV1 |
DataSourceAuditDataV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataSourceId | String | ID of the datasource | ||
| dataSourceName | String | name of the datasource | ||
| dataSourceType | String | type of the datasource | ||
| eventKind | DataSourceAuditEventKindV1 | |||
| metadata | DataSourceAuditMetadataV1 | |||
| performedBy | String | username of user who performed the event | ||
| timestamp | String | timestamp of when event was performed | 1996-07-19T03:13:44.467Z |
DatasetInfoV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the dataset was created | 2022-03-12T02:13:44.467Z | |
| description | String | A description of the dataset | ||
| id | String | Dataset ID | 62313ce67a0af0281c01a6a5 | |
| name | String | Name of the dataset | My Dataset | |
| projectId | String | ID of the project this dataset belongs to | 62313ce67a0af0281c01a6a5 |
DatasetMountV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| containerPath | String | Location dataset is mounted at in the Job. | /domino/datasets/local/quick-start | |
| datasetName | String | Name of dataset to be mounted. | MyDataset | |
| id | String | Id of dataset to be mounted. | 623137f57a0af0281c01a6a0 | |
| isInput | Boolean | Whether a dataset was an input to be used in the execution, or an output created by the execution. | ||
| projectId | String | Id of project the dataset belongs to. | 6231383c7a0af0281c01a6a1 | |
| snapshotId | String | Id of snapshot to mount for this dataset. | 623138807a0af0281c01a6a2 | |
| snapshotVersion | Integer | Version of dataset snapshot to mound. | 2 |
DatasetNotCopiedV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasetInfo | DatasetInfoV1 | dataset not copied | ||
| errorMessage | String | error message explaining why dataset wasn't copied |
DatasetRwDetailsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the dataset was created | 2022-03-12T02:13:44.467Z | |
| description | String | A description of the dataset | ||
| id | String | ID of the dataset | 62313ce67a0af0281c01a6a5 | |
| name | String | Name of the dataset | My Dataset | |
| projectId | String | ID of the project this dataset belongs to | 62313ce67a0af0281c01a6a5 | |
| snapshotIds | List of string | List of snapshot IDs belonging to this dataset | ||
| tags | DatasetRwTagsV1 |
DatasetRwEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataset | DatasetRwDetailsV1 | |||
| metadata | MetadataV1 |
DatasetRwGrantDetailsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| grantDetails | List of DatasetRwGrantDetailsV1 | |||
| metadata | MetadataV1 |
DatasetRwGrantDetailsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| isOrganization | Boolean | If target id is an organization | ||
| targetId | String | ID of the user within the grant | ||
| targetName | String | Username of user within the grant | ||
| targetRole | DatasetRwRoleV1 |
DatasetRwGrantEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| grants | List of DatasetRwGrantV1 | |||
| metadata | MetadataV1 |
DatasetRwGrantV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| targetId | String | ID of the user within the grant | ||
| targetRole | DatasetRwRoleV1 |
DatasetRwInfoDtoV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataset | DatasetRwDetailsV1 | |||
| projectInfo | DatasetRwProjectInfoDtoV1 |
DeepCopyGitRepoSpecV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| newRepoName | String | The name of the new repository. | ||
| newRepoOwnerName | String | The name of the user who will own the new repository in the git service provider. | ||
| visibility | ProviderRepoVisibilityV1 |
DeleteEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| success | Boolean |
EnvironmentEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environment | EnvironmentV1 | |||
| metadata | MetadataV1 |
EnvironmentOwnerV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | Id of owner of an environment. | 6231327c7a0af0281c01a69b | |
| ownerType | EnvironmentOwnerTypeV1 | |||
| username | String | Username of owner of an environment. | OrgOwner |
EnvironmentRevisionEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environmentRevision | EnvironmentRevisionV1 | |||
| metadata | MetadataV1 |
EnvironmentRevisionV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| availableTools | List of EnvironmentToolV1 | |||
| id | String | Id of Environment Revision. | 62313cfd7a0af0281c01a6a6 | |
| number | Integer | Revision number, increasing sequentially with each revision. | 4 | |
| status | EnvironmentRevisionBuildStatusV1 |
EnvironmentToolV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| iconUrl | String | Url to pull icon image from | /assets/images/workspace-logos/Jupyter.svg | |
| name | String | Name of environment tool | Jupyter | |
| proxyConfig | ProxyConfigV1 | |||
| startScripts | List of string | |||
| supportedFileExtensions | List of string | |||
| title | String | Title of environment tool. | Jupyter |
EnvironmentV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| activeRevisionTags | List of string | The tags on the active revision for this environment | ||
| archived | Boolean | Whether the environment is archived | ||
| id | String | Id of environment | 623132867a0af0281c01a69c | |
| internalTags | List of string | The internal tags specifying if this environment is restricted | ||
| isCurated | Boolean | Whether or not the environment is curated for a deployment | ||
| latestRevision | EnvironmentRevisionV1 | |||
| name | String | MyOrg | ||
| owner | EnvironmentOwnerV1 | |||
| restrictedRevision | EnvironmentRevisionV1 | |||
| selectedRevision | EnvironmentRevisionV1 | |||
| supportedClusters | List of ClusterTypeV1 | |||
| visibility | EnvironmentVisibilityV1 |
ExternalVolumeMountV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mountPath | String | Path to mount the external volume at. | /path/to/my/volume | |
| name | String | Name of external volume to mount. | MyExternalVolume | |
| readOnly | Boolean | Whether to mount the volume as read only. | ||
| subPath | String | Path within the external volume to mount. The entire volume will be mounted if not specified. | /mypath |
GitCodeRepoSpecBeta
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentialId | String | The Domino ID of the PAT credential, which will be used to copy and/or read from the code repository on the new project. | ||
| deepCopy | DeepCopyGitRepoSpecBeta | |||
| referenceCopy | ReferenceCopyGitRepoSpecV1 |
GitCodeRepoSpecV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentialId | String | The Domino ID of the PAT credential, which will be used to copy and/or read from the code repository on the new project. | ||
| deepCopy | DeepCopyGitRepoSpecV1 | |||
| referenceCopy | ReferenceCopyGitRepoSpecV1 |
GitCredentialsAccessorV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| domain | String | The domain these credentials apply to | github.com | |
| fingerprint | String | ba:78:09:d8:4b:3b:09:9b:43:bf:9b:5a:34:f7:3f:28 | ||
| gitServiceProvider | GitServiceProviderV1 | |||
| id | String | Id for these git credentials | ||
| name | String | Name for these git credentials | My creds | |
| protocol | String | https |
GoalEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| goal | LinkedGoalV1 | |||
| metadata | MetadataV1 |
JobDetailsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| commentsCount | Integer | |||
| commitDetails | CommitDetailsV1 | |||
| computeCluster | ComputeClusterConfigV1 | |||
| datasetMounts | List of DatasetMountV1 | |||
| dominoStats | List of DominoStatsV1 | |||
| externalVolumeMounts | List of ExternalVolumeMountV1 | |||
| gitRepos | List of MountedGitRepoV1 | |||
| goalIds | List of string | |||
| id | String | |||
| mainRepoGitRef | GitRefV1 | |||
| number | Integer | |||
| projects | List of MountedProjectV1 | |||
| queuedJobStatusDetails | QueuedJobStatusDetailsV1 | |||
| runCommand | String | |||
| runLauncherId | String | |||
| stageTimes | StageTimesV1 | |||
| startedById | String | |||
| status | JobStatusV1 | |||
| tags | List of TagV1 | |||
| title | String | |||
| usage | JobUsageV1 |
JobEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| job | JobDetailsV1 | |||
| metadata | MetadataV1 |
JobLogsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| helpLink | String | Suggestion link for helpful resources. | Error. No such file or directory. | |
| isComplete | Boolean | Whether all logs for the job have been retrieved. | ||
| logContent | List of LogContentV1 | |||
| problem | String | Description of issue that occurred in a job. | python: can't open file 'invalid.py': [Errno 2] No such file or directory |
JobV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| commitDetails | CommitDetailsV1 | |||
| computeCluster | ComputeClusterConfigV1 | |||
| datasetMounts | List of DatasetMountV1 | |||
| dominoStats | List of DominoStatsV1 | |||
| externalVolumeMounts | List of ExternalVolumeMountV1 | |||
| gitRepos | List of MountedGitRepoV1 | |||
| id | String | |||
| mainRepoGitRef | GitRefV1 | |||
| number | Integer | |||
| projects | List of MountedProjectV1 | |||
| runCommand | String | |||
| runLauncherId | String | |||
| stageTimes | StageTimesV1 | |||
| startedById | String | |||
| status | JobStatusV1 | |||
| title | String | |||
| usage | JobUsageV1 |
LinkedGoalV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currentStage | String | The stage this goal is currently assigned. | Ideation | |
| description | String | Description of the Goal. | Develop a better performing model | |
| goalId | String | Id of Goal linked to Job. | 62313cfd7a0af0281c01a6a6 | |
| jobId | String | Id of Job linked to Goal. | 62313d207a0af0281c01a6a7 | |
| projectId | String | Id of project resources belong to. | 62313d377a0af0281c01a6a8 | |
| title | String | Name of goal. | MyGoal |
LogContentV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| log | String | Log message | Pulling image "172.20.22.242:5000/noahjax11699-compute/environment:622a6879dde1a920fcccfef5-1" | |
| logType | LogTypeV1 | |||
| size | Integer | Length of log line. | 94 | |
| timestamp | String | Time logs were written. | 2022-03-12T02:13:51.616Z |
LogsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| logs | JobLogsV1 | |||
| metadata | Object |
MetricAlertRequestV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| description | String | Optional text to append to the metric alert message | ||
| metric | String | Name of the metric to send alert for | ||
| modelMonitoringId | String | ID of the monitored model to send metric alerts for | ||
| targetRange | TargetRangeV1 | |||
| value | Number | Value of the metric |
MetricValueV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| referenceTimestamp | String | Timestamp associated with the metric log entry | ||
| tags | List of MetricTagV1 | List of tags associated with the metric | ||
| value | Number | Value of the metric |
MetricValuesEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| metricValues | List of MetricValueV1 |
MountedGitRepoV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endingBranch | String | Branch this git repo ended at. | final-branch | |
| endingCommitId | String | Ending commitId for this git repo. | dff155c9a736f9cd230eac420e3c1ef3daa0ad7e | |
| id | String | Id of the git repo mounted to the Job. | 6231365e7a0af0281c01a69f | |
| name | String | Name of the git repo mounted to the Job. | MyRepo | |
| ref | String | |||
| serviceProvider | GitServiceProviderV1 | |||
| startingBranch | String | Branch this git repo started at. | init-test-branch | |
| startingCommitId | String | CommitId the git repo should be mounted at. | 4f2d5c2f54db4fbb16a093d4fb11fdb1fe0794c7 | |
| uri | String | Uri for the repo being mounted. | git@github.com:apache/spark.git |
NewDatasetRwV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| description | String | Description of the dataset | ||
| grants | List of DatasetRwGrantV1 | Permission grants to be assigned for this newly created dataset. Note that permissions can be edited after creation. If snapshotId is passed in, this parameter won't have any effect and caller will be assigned dataset Ownership. | ||
| name | String | Name of this dataset. The name must be unique in the same project | ||
| projectId | String | ID of the project this dataset belongs to. Either projectId or snapshotId must be provided | ||
| snapshotId | String | ID of an existing snapshot to create a new dataset from. Either snapshotId or projectId must be provided. |
NewEnvironmentRevisionV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dockerfileInstructions | String | |||
| environmentVariables | List of EnvironmentVariableV1 | |||
| image | String | Environment revision image. Required for creating a new environment | ||
| postRunScript | String | |||
| postSetupScript | String | |||
| preRunScript | String | |||
| preSetupScript | String | |||
| skipCache | Boolean | |||
| summary | String | |||
| supportedClusters | List of ClusterTypeV1 | |||
| tags | List of string | |||
| useVpn | Boolean | |||
| workspaceTools | List of EnvironmentToolV1 |
NewEnvironmentV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| addBaseDependencies | Boolean | Required for creating a new environment | ||
| description | String | |||
| duplicateFromEnvironmentId | String | The id of the environment to duplicate. When specifying this property, no other properties in the payload must be set. | ||
| isCurated | Boolean | |||
| isRestricted | Boolean | Specifies if an environment is restricted. Only users with ClassifyEnvironments permission can set this to true | ||
| name | String | Environment name. Required for creating a new environment | ||
| orgOwnerId | String | Sets an Organization as the Environment owner. Only used if visibility is 'Private', as 'Global' environments don't have owners. | ||
| visibility | NewEnvironmentVisibilityV1 |
NewJobV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| commitId | String | Git commitId to start job from. Defaults to head commitId for the project. | 960a4c99a4cc38194cbacbcce41caa68ba5369ea | |
| computeCluster | ComputeClusterConfigV1 | |||
| environmentId | String | Id of environment to use when creating job. Defaults to project default environment. | 623131507a0af0281c01a699 | |
| environmentRevisionSpec | EnvironmentRevisionSpecV1 | |||
| externalVolumeMountIds | List of string | Id's of external volumes to be mounted on this job. | 6231327c7a0af0281c01a69b623132867a0af0281c01a69c | |
| hardwareTier | String | Hardware tier to use for this job. Defaults to project default hardware tier. | small-k8s | |
| mainRepoGitRef | GitRefV1 | |||
| projectId | String | Id of project to create job in. | 623130ad7a0af0281c01a698 | |
| runCommand | String | Command for job to run | main.py | |
| snapshotDatasetsOnCompletion | Boolean | Whether to snapshot datasets mounted on the Job when the Job completes. | ||
| title | String | Name of job to start | K-means clustering |
NewMetricValueV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metric | String | Name of the metric to log values for | ||
| modelMonitoringId | String | ID of the monitored model to log metric values for | ||
| referenceTimestamp | String | Timestamp to associate the metric log entry with. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00 | ||
| tags | List of MetricTagV1 | List of tags associated with the metric | ||
| value | Number | Value of the metric |
NewMetricValuesEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| newMetricValues | List of NewMetricValueV1 |
NewOrganizationV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| members | List of OrganizationMemberV1 | |||
| name | String | The name for this organization | MyNewOrg |
NewProjectGitRepositoryV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| defaultRef | ProjectRepositoryReferenceV1 | |||
| gitCredentialId | String | Id of the git creds to use for the repo. Credentials only apply for the current user, and other users will need to add their own unique creds. | ||
| name | String | Optional name of the repository in the project | ||
| serviceProvider | GitServiceProviderV1 | |||
| uri | String | URI of the repository origin | https://github.com/torvalds/linux |
NewProjectV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| description | String | Project description. | ||
| isRestricted | Boolean | Optional flag for setting a new project as restricted. ProjectClassifier permission required for use. | ||
| mainRepository | NewProjectGitRepositoryV1 | |||
| name | String | Name of this project. The name must be unique and cannot contain white space. | ||
| ownerId | String | Optional Id of a user to own this project. Defaults to the calling user if not provided. Does not currently support creating projects owned by Organizations. | ||
| templateDetails | ProjectTemplateDetailsV1 | |||
| visibility | ProjectVisibilityV1 |
NewRegisteredModelV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| description | String | The description of the registered model | This model predicts housing prices | |
| discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. | ||
| experimentRunId | String | The id of the experiment run to create the version from | a8ea375c781d4b9c8e58469f0ad738f8 | |
| modelName | String | The name of the registered model | Housing Price Predictor | |
| tags | RegisteredModelTagsV1 |
NewRegisteredModelVersionV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| artifact | String | The artifact of the run to create the version from | LogisticRegression | |
| description | String | The description of the registered model version | Logistic regression model version 2 | |
| experimentRunId | String | The id of the experiment run to create the version from | a8ea375c781d4b9c8e58469f0ad738f8 |
OrganizationEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| org | OrganizationV1 |
OrganizationMemberV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| organizationRole | OrganizationRoleV1 | |||
| userId | String | Id of the user in the org. | 6234c9542bc6731e3471ade8 |
OrganizationV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| defaultEnvironmentId | String | Id of the default environment used in the organization. | 6231327c7a0af0281c01a65f | |
| id | String | Organization identifier in the users collection. | 623132867a0af0281c01a69c | |
| members | List of OrganizationMemberV1 | List of the organization members. | ||
| name | String | Organization name. | MyOrg |
PaginatedDatasetRwEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasets | List of DatasetRwDetailsV1 | |||
| metadata | PaginatedMetadataV1 |
PaginatedDatasetRwEnvelopeV2
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasets | List of DatasetRwInfoDtoV1 | |||
| metadata | PaginatedMetadataV1 |
PaginatedEnvironmentEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environments | List of EnvironmentV1 | |||
| metadata | PaginatedMetadataV1 |
PaginatedGitCredentialsAccessorEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials | List of GitCredentialsAccessorV1 | |||
| metadata | MetadataV1 |
PaginatedGitRepositoriesEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| repositories | List of ProjectGitRepositoryV1 |
PaginatedGoalEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| goals | List of LinkedGoalV1 | |||
| metadata | MetadataV1 |
PaginatedJobEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| jobs | List of JobV1 | |||
| metadata | PaginatedMetadataV1 |
PaginatedOrganizationEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| orgs | List of OrganizationV1 |
PaginatedProjectsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| projects | List of ProjectV1 |
PaginatedRegisteredModelNamesV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of string | |||
| metadata | PaginatedMetadataV1 |
PaginatedRegisteredModelVersionModelApiEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelVersionModelApiV1 | |||
| metadata | PaginatedMetadataV1 |
PaginatedRegisteredModelVersionOverviewEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelVersionOverviewV1 | |||
| metadata | PaginatedMetadataV1 |
PaginatedRegisteredModelsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelV1 | |||
| metadata | TokenPaginatedMetadataV1 |
PaginatedRegisteredModelsForUIEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelForUIV1 | |||
| metadata | TokenPaginatedMetadataV1 |
PaginatedSnapshotEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| snapshots | List of SnapshotDetailsV1 |
PaginatedUserEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| users | List of UserV1 |
ProjectCollaboratorEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaborator | ProjectCollaboratorV1 | |||
| metadata | MetadataV1 |
ProjectCopyResultEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasetsNotCopied | List of DatasetNotCopiedV1 | |||
| metadata | MetadataV1 | |||
| project | ProjectV1 |
ProjectEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| project | ProjectV1 |
ProjectGitRepositoryEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| repository | ProjectGitRepositoryV1 |
ProjectGitRepositoryV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| defaultRef | ProjectRepositoryReferenceV1 | |||
| id | String | Id of the repository | 62604702b7e5d347dbe7a908 | |
| name | String | Optional name of the repository in the project. If not provided, a name will be inferred from the URL | ||
| serviceProvider | GitServiceProviderV1 | |||
| uri | String | URI of the repository origin | https://github.com/torvalds/linux |
ProjectGoalEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| goal | ProjectGoalV1 | |||
| metadata | MetadataV1 |
ProjectGoalV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | Timestamp at which goal was created | 2022-03-12T02:13:44.467Z | |
| creatorId | String | User id that created the goal | ||
| description | String | Optional description of project goal | ||
| id | String | The unique project goal id | ||
| isComplete | Boolean | Flag indicating if the goal is complete | ||
| projectId | String | Id of project to which the goal belongs | ||
| title | String | The title of project goal |
ProjectGoalsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| goals | List of ProjectGoalV1 | |||
| metadata | MetadataV1 |
ProjectRepositoryReferenceV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| refType | GitReferenceTypeV1 | |||
| value | String |
ProjectResultsSettingsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| resultsSettings | ProjectResultsSettingsV1 |
ProjectStatusEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| status | ProjectStatusV1 |
ProjectV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaborators | List of ProjectCollaboratorV1 | List of collaborators, if any | ||
| description | String | A description of the project | ||
| id | String | Project ID | 626046fcb7e5d347dbe7a904 | |
| internal tags | List of string | Optional list of strings containing internal tags of project | restricted | |
| mainRepository | ProjectGitRepositoryV1 | |||
| name | String | Name of the project | My Project | |
| ownerId | String | userId of the project owner | 662604702b7e5d347dbe7a908 | |
| ownerUsername | String | username of the project owner | steve_holt | |
| visibility | ProjectVisibilityV1 |
ProxyConfigV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| internalPath | String | Path to find workspace at. Used internally. | /{{ownerUsername}}/{{projectName}}/{{sessionPathComponent}}/{{runId}}/{{#if pathToOpen}}tree/{{pathToOpen}}{{/if}} | |
| port | Integer | Port to run this tool on. | 8888 | |
| requireSubdomain | Boolean | Whether workspace requires subdomains. Subdomain workspaces only work if deployment is configured to support subdomains. Defaults to false. | ||
| rewrite | Boolean | If url rewriting is necessary for routing. Defaults to false |
QueuedJobStatusDetailsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| expectedWait | String | Message describing estimated wait time between state changes. | Now | |
| explanation | String | Message explaining the wait time | Your run has been assigned to a machine | |
| helpText | String | Message informing the caller what should be done next | It will start being prepared for execution momentarily |
RegisteredModelForUIV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| description | String | Description of the model | Customer churn model | |
| discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. This field may be omitted when false. | ||
| latestVersion | Integer | The latest version of the model | 1 | |
| latestVersionExperimentMetrics | RegisteredModelMetricsV1 | |||
| latestVersionStage | String | The current stage of the latest version of the model | Staging | |
| modelApiCount | Integer | The number of model APIs associated with the latest version of the model | 1 | |
| name | String | Name of the registered model | churn-prediction | |
| ownerUsername | String | Username of the project owner | martin_hito | |
| predictionCount | Integer | The number of predictions captured for the active versions of model APIs associated with the latest version of the model | 100 | |
| project | RegisteredModelProjectSummaryV1 | |||
| tags | RegisteredModelTagsV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
RegisteredModelProjectSummaryV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | ID of the project housing the model | 62313ce67a0af0281c01a6a5 | |
| isGitBasedProject | Boolean | Whether the project is a git-based project | ||
| name | String | Name of the project overview housing the model | TO-DO | |
| ownerUsername | String | Name of the project owner | TO-DO |
RegisteredModelRequestingUserAccessV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| canEditModel | Boolean | True if the requesting user can update this model | ||
| canEditProjectAssets | Boolean | True if the requesting user has permissions to edit other assets of the project that this model belongs to. | ||
| canViewExperimentRuns | Boolean | True if the requesting user can view experiment runs of the project that this model belongs to. | ||
| canViewModelApis | Boolean | True if the requesting user can view model apis of the project that this model belongs to. | ||
| canViewProject | Boolean | True if the requesting user can view the project overview of the project that this model belongs to. | ||
| canViewProjectFiles | Boolean | True if the requesting user can view the files of the project that this model belongs to. |
RegisteredModelReviewUserInfoV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| firstName | String | The first name of the model review user | Tuanathon | |
| id | String | The id of the model review user | 452f88ac21bd0c60eca085 | |
| lastName | String | The last name of the model review user | Nguyen | |
| username | String | The username of the model review user | ddl-tnguyen |
RegisteredModelStageEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelStageV1 | The Registered Model stages | ||
| metadata | MetadataV1 |
RegisteredModelV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| description | String | Description of the model | Customer churn model | |
| discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. This field may be omitted when false. | ||
| latestVersion | Integer | The latest version of the model | 1 | |
| name | String | Name of the registered model | churn-prediction | |
| ownerUsername | String | Username of the model's creator | martin_hito | |
| project | RegisteredModelProjectSummaryV1 | |||
| requestingUserAccess | RegisteredModelRequestingUserAccessV1 | |||
| tags | RegisteredModelTagsV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
RegisteredModelVersionDetailsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| currentStage | String | The current stage of the model version | Staging | |
| experimentRunId | String | The name of experiment run linked to the model version | db79712b47084c27a463a188bf901943 | |
| modelName | String | Name of the registered model | churn-prediction | |
| modelVersion | Integer | The latest version of the model | 4 | |
| modelVersionDescription | String | Description of the model version | Customer churn model V1 | |
| ownerUsername | String | username of the project owner | martin_hito | |
| project | RegisteredModelProjectSummaryV1 | |||
| reviewSummary | RegisteredModelReviewSummaryV1 | |||
| tags | RegisteredModelTagsV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z | |
| versionUiDetails | RegisteredModelVersionUiDetailsV1 |
RegisteredModelVersionModelApiV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| activeModelVersionId | String | The id of the Model API | 6452f88ac21bd0c60eca087 | |
| activeVersionNumber | Integer | The active version number of the Model API | 2 | |
| activeVersionStatus | String | The status of the Model API | Running | |
| description | String | Description of the model | Customer churn model | |
| id | String | ID of the Model API | 6452f88ac21bd0c60eca085 | |
| name | String | Name of the Model API | Test Model API | |
| project | RegisteredModelProjectSummaryV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
RegisteredModelVersionOverviewV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| experimentRunId | String | The name of experiment run linked to the model version | db79712b47084c27a463a188bf901943 | |
| modelName | String | Name of the registered model | churn-prediction | |
| modelVersion | Integer | The latest version of the model | 4 | |
| ownerUsername | String | username of the project owner | martin_hito | |
| project | RegisteredModelProjectSummaryV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
RegisteredModelVersionReviewStagesResponseV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | The registered model version stages valid for starting a model review | |||
| metadata | MetadataV1 |
RegisteredModelVersionStagesResponseV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | The Registered Model Version stages for a project | |||
| metadata | MetadataV1 |
RegisteredModelVersionUiDetailsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| experimentRunInfo | RegisteredModelVersionExperimentRunInfoV1 | |||
| modelVersionDataSources | ||||
| modelVersionDatasets |
SharedDatasetsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataset | SharedDatasetRwEntryV1 | |||
| metadata | MetadataV1 |
SnapshotDetailsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the snapshot was created | 2022-03-12T02:13:44.467Z | |
| creatorId | String | ID of the user who created this snapshot | ||
| datasetId | String | ID of the dataset this snapshot belongs to | ||
| description | String | |||
| id | String | ID of this snapshot | ||
| lastMounted | String | When the snapshot was last mounted | ||
| status | String | active markForDeletion deletionInProgress deleted pending failed copying |
SnapshotEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| snapshot | SnapshotDetailsV1 |
TagEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| tag | TagV1 |
TargetRangeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| condition | String | Condition to evaluate metric value against upperLimit/lowerLimit | lessThan lessThanEqual greaterThan greaterThanEqual between | |
| lowerLimit | Number | Lower limit in the target range for a metric; lowerLimit, upperLimit, or both must be provided | ||
| upperLimit | Number | Upper limit in the target range for a metric; lowerLimit, upperLimit, or both must be provided |
UserEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| user | UserV1 |
WorkspaceSessionCreatedEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| workspaceSession | WorkspaceSessionCreatedV1 |
AIGatewayEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpoints | List of EndpointEnvelopeV1 | |||
| metadata | MetadataV1 |
EndpointEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpointId | String | ID of the endpoint | 62604702b7e5d347dbe7a909 | |
| endpointName | String | Valid name of the endpoint | completions | |
| endpointType | String | Type of the endpoint | llm/v1/completions | |
| modelProvider | String | Provider of the model | openai | |
| modelName | String | Name of the model | gpt-4 | |
| modelConfig | ModelConfigV1 |
NewEndpointV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpointName | String | Valid name of the endpoint | completions | |
| endpointType | String | Type of the endpoint | llm/v1/completions | |
| endpointPermissions | EndpointPermissionsDtoV1 | |||
| modelProvider | String | Provider of the model | openai | |
| modelName | String | Name of the model | gpt-4 | |
| modelConfig | ModelConfigV1 |
UpdatedEndpointV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpointName | String | Valid name of the endpoint | completions-1 | |
| endpointType | String | Type of the endpoint | llm/v1/completions | |
| modelProvider | String | Provider of the model | openai | |
| modelName | String | Name of the model | gpt-3.5 | |
| modelConfig | ModelConfigV1 |