Domino Platform API reference

This topic provides complete reference information about all of Domino’s public REST API endpoints.

Endpoints
To Models

AIGateway
AsyncPredictions
BillingTag
BillingTagSettings
ComputeProviders
Cost
CustomMetrics
DatasetRw
DataSource
Environments
HardwareTier
Jobs
ModelAPI
ModelAPIVersion
ModelDeployment
Organizations
Projects
ProjectsFiles
ProjectSharedDatasets
RegisteredModels
Users
Workspaces

AIGateway
Top

Get AI Gateway Audit Data

Get all active Gateway LLMs accessible by the user

Create a new endpoint

Get a endpoint by name

Update a endpoint by name

Delete a endpoint by name

Get permissions for a endpoint by name

Update permissions for a endpoint by name

AsyncPredictions
Top

Request a prediction from an Async model

Retrieve the result of an Async Model prediction

BillingTag
Top

Get usable billing codes

Upsert billing codes

Get billing tag by tag name

Deactivate billing tag

BillingTagSettings
Top

Get billing tags setting

Update billing tags setting

ComputeProviders
Top

Get all Compute Provider Types

Get all non-archived Compute Provider

Create a new Compute Provider

Update a Compute Provider

Delete a Compute Provider

Gets all non-archived Compute Tiers based on the provided filters

Create a new Compute Tier

Get full configuration details for a Compute Tier

Gets selectable Compute Tiers based on the provided filters

Update a Compute Tier

Delete a Compute Tier

Cost
Top

Get the cost allocation over a time window

Get the asset cost over a time window

Set AWS Billing API Configuration

Add kubecost license key

CustomMetrics
Top

Send a metric alert

Log metric values

Retrieve metric values

DatasetRw
Top

Deprecated - Get datasets accessible to user

Create a dataset

Get dataset by ID

Update dataset metadata

Delete Dataset

Get dataset grants by ID

Add a grant to a dataset's existing sequence of grants

Remove a grant from a dataset's existing sequence of grants

Get snapshots belonging to dataset

Create a snapshot

Tag a snapshot in this Dataset

Remove a tag from a Dataset

Get snapshot

Get datasets the user has access to

DataSource
Top

Get Data Source Audit Data

Get all active Data Source the user has access to

Create a Data Source

Get Data Source by ID

Update Data Source with specified ID

Delete Data Source with specified ID

Environments
Top

Get Environments visible to a user

Create an environment

Create a Revision of an Environment

Update the restricted revision of an environment

Get an environment

Archive an environment

HardwareTier
Top

Get all hardware tiers

Create a hardware tier

Update a hardware tier

Get a hardware tier by Id

Archive a hardware tier

Jobs
Top

Get Jobs for a project

Get Job details

Get logs for a Job

Get linked goals for a job

Link a goal to a job

Unlink goal from job

Start a Job

Add a tag to a Job

Remove a tag from a Job

ModelAPI
Top

listModelAPIs

createModelApi

getModelApi

updateModelApi

deleteModelApi

listModelApiAccessTokens

createModelApiAccessToken

getModelApiAccessToken

updateModelApiAccessToken

deleteModelApiAccessToken

listModelApiCollaborators

createModelApiCollaborator

getModelApiCollaborator

updateModelApiCollaborator

removeModelApiCollaborator

deleteModelApiEnvironmentVariable

listModelApiVolumes

createModelApiVolume

deleteModelApiVolume

ModelAPIVersion
Top

listModelVersions

createModelApiVersion

getModelApiVersion

getModelApiVersionBuildLogs

getModelApiVersionDeploymentLogs

getModelApiVersionExportLogs

getModelApiVersionInstanceLogs

updateModelApiVersionProductionLabel

updateModelApiVersionTargetState

ModelDeployment
Top

Retrieve all Model Deployments

Create a new Model Deployment

Retrieve a specific Model Deployment

Update a Model Deployment

deleteModelDeployment

Retrieve all versions of a specific Model Deployment

Retrieve a specific version of a Model Deployment

Organizations
Top

Get the Organizations for a user

Create an organization

Get all organizations. Only accessible to admin users.

Get an organization by Id

Add a user to an org

Remove a user from an org

Projects
Top

Get Projects visible to user

Create a project

Archive project by id

Get project result settings

Update project result settings

Get Project by Id

Add a collaborator to this project

Remove a collaborator from project

Create a new project by copying an existing project and providing optional overrides.

Get goals in this project

Add a goal to this project

Update project goal status

Delete a project goal

Get all imported git repositories in this project

Add an imported git repository to this project

Remove an imported repository from project

Update project status

ProjectsFiles
Top

Returns the contents of a file (deprecated, use v1 endpoint instead)

Returns the contents of a file

ProjectSharedDatasets
Top

Get shared datasets that a project uses

Link a shared dataset to this project

Unlink a shared dataset from this project

RegisteredModels
Top

Get Registered Models visible to user

Create a new a Registered Model from an experiment run

Request access to a project

Get a list of Registered Models' names visible to user

Get Registered Models visible to user

Get registered model version stages for a project

Set registered model version stages for a project

Get a specific Registered Model

Update a Registered Model

Returns list of Model APIs deployed from a specific Registered Model

Get all versions of a Registered Model

Create a new version of a Registered Model

Get a specific version of a Registered Model

Update a Registered Model version

Returns list of Model APIs deployed from a specific Registered Model Version

Create a review of a Registered Model

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

Create a response to a Registered Model review

Get registered model version stages valid for starting a model review

Validates whether a model version can transition to a given stage

Get the possible stages of a Registered Model

Users
Top

Get git credential accessor for a User

Get the current user

Get all users visible to the current user

Workspaces
Top

Create workspace session

Models
Top

AIGatewayAuditDataV1

AIGatewayAuditMetadataV1

AIGatewayEnvelopeV1

AsyncPredictionEnvelopeV1

AsyncPredictionRequestEnvelopeV1

AthenaBillingConfigsV1

BillingTagEnvelopeV1

BillingTagV1

BillingTagWithStatusV1

BillingTagsEnvelopeV1

BillingTagsModeEnvelopeV1

BillingTagsModeV1

BillingTagsNotificationsEnvelopeV1

BillingTagsNotificationsV1

BillingTagsSettingModeV1

BillingTagsSettingNotificationsV1

BillingTagsSettingsEnvelopeV1

BillingTagsSettingsV1

ClusterTypeV1

CommitDetailsV1

ComputeClusterConfigV1

ComputeProvider

ComputeProviderCreation

ComputeProviderType

ComputeTier

ComputeTierCreation

ComputeTierFullConfiguration

ConstraintSchemaDefinition

CopyProjectSpecV1

CostAllocationEnvelopeV1

CostAllocationV1

CostAssetsEnvelopeV1

CostAssetsV1

CostAssetsV1Window

DataSourceAuditDataV1

DataSourceAuditEventKindV1

DataSourceAuditMetadataV1

DataSourceAuthTypeV1

DataSourceConfigV1

DataSourceCredentialTypeV1

DataSourceCredentialsV1

DataSourceEnvelopeV1

DataSourcePermissionsV1

DataSourceTypeV1

DataSourceUpdateV1

DatasetInfoV1

DatasetMountV1

DatasetNotCopiedV1

DatasetRwDetailsV1

DatasetRwEnvelopeV1

DatasetRwGrantDetailsEnvelopeV1

DatasetRwGrantDetailsV1

DatasetRwGrantEnvelopeV1

DatasetRwGrantV1

DatasetRwInfoDtoV1

DatasetRwMetadataV1

DatasetRwPermissionV1

DatasetRwProjectInfoDtoV1

DatasetRwRoleV1

DatasetRwTagToAddV1

DatasetRwTagsV1

DatasetToAddV1

DeepCopyGitRepoSpecV1

DefinedSchemaValue

DeleteEnvelopeV1

DominoStatsV1

EndpointEnvelopeV1

EndpointPermissionsDtoV1

EnvironmentEnvelopeV1

EnvironmentOwnerTypeV1

EnvironmentOwnerV1

EnvironmentRevisionBuildStatusV1

EnvironmentRevisionEnvelopeV1

EnvironmentRevisionSpecV1

EnvironmentRevisionUpdateEnvelopeV1

EnvironmentRevisionV1

EnvironmentToolV1

EnvironmentV1

EnvironmentVariableV1

EnvironmentVisibilityV1

ExternalVolumeMountV1

FailureEnvelopeV1

GenericFieldValueType

GitCodeRepoSpecV1

GitCredentialsAccessorV1

GitRefV1

GitReferenceTypeV1

GitServiceProviderV1

GoalEnvelopeV1

GoalToLinkV1

HardwareTierCapacityV1

HardwareTierComputeClusterRestrictionsV1

HardwareTierEnvelopeV1

HardwareTierFlagsV1

HardwareTierGpuConfigurationV1

HardwareTierOverProvisioningV1

HardwareTierPodCustomizationV1

HardwareTierResourcesV1

HardwareTierV1

HealthCheck

InformationV1

InvalidBodyEnvelopeV1

JobDetailsV1

JobEnvelopeV1

JobLogsV1

JobStatusV1

JobUsageV1

JobV1

KubecostLicenseResponseV1

KubecostLicenseV1

LinkedGoalV1

LogContentV1

LogTypeV1

LogsEnvelopeV1

LogsPaginationV1

MetadataV1

MetricAlertRequestV1

MetricTagV1

MetricValueV1

MetricValuesEnvelopeV1

ModelApi

ModelApiAccessConfiguration

ModelApiAccessToken

ModelApiAccessTokenCreationRequest

ModelApiCollaboratorRole

ModelApiCreationRequest

ModelApiEnvironmentVariable

ModelApiHealthCheckConfiguration

ModelApiMetadata

ModelApiPaginatedList

ModelApiSource

ModelApiUpdateRequest

ModelApiVersion

ModelApiVersionBuildLogs

ModelApiVersionCreationRequest

ModelApiVersionDeployment

ModelApiVersionDeploymentLogs

ModelApiVersionExportLogs

ModelApiVersionInstanceLogs

ModelApiVersionLogLine

ModelApiVersionLogTag

ModelApiVersionMetadata

ModelApiVersionProductionLabel

ModelApiVersionSummary

ModelApiVersionTargetState

ModelApiVolume

ModelConfigV1

ModelDeployment

ModelDeploymentCreation

ModelDeploymentPaginatedList

ModelDeploymentType

ModelDeploymentTypeSchema

ModelDetail

ModelDetailSource

MountedGitRepoV1

MountedProjectV1

NewAsyncPredictionV1

NewBillingTagsV1

NewDataSourceV1

NewDatasetRwV1

NewEndpointV1

NewEnvironmentRevisionV1

NewEnvironmentV1

NewEnvironmentVisibilityV1

NewHardwareTierFlagsV1

NewHardwareTierV1

NewJobV1

NewMetricValueV1

NewMetricValuesEnvelopeV1

NewOrganizationV1

NewProjectGitRepositoryV1

NewProjectGoalV1

NewProjectV1

NewRegisteredModelReviewResponseV1

NewRegisteredModelReviewReviewersV1

NewRegisteredModelReviewV1

NewRegisteredModelV1

NewRegisteredModelVersionV1

NewSnapshotV1

NewWorkspaceSessionV1

OperationStatusStep

OperationType

OrganizationEnvelopeV1

OrganizationMemberV1

OrganizationRoleV1

OrganizationV1

PaginatedComputeTiers

PaginatedDataSourceEnvelopeV1

PaginatedDatasetRwEnvelopeV1

PaginatedDatasetRwEnvelopeV2

PaginatedEnvironmentEnvelopeV1

PaginatedGitCredentialsAccessorEnvelopeV1

PaginatedGitRepositoriesEnvelopeV1

PaginatedGoalEnvelopeV1

PaginatedHardwareTierEnvelopeV1

PaginatedJobEnvelopeV1

PaginatedMetadataV1

PaginatedOrganizationEnvelopeV1

PaginatedProjectsEnvelopeV1

PaginatedRegisteredModelNamesV1

PaginatedRegisteredModelVersionModelApiEnvelopeV1

PaginatedRegisteredModelVersionOverviewEnvelopeV1

PaginatedRegisteredModelsEnvelopeV1

PaginatedRegisteredModelsForUIEnvelopeV1

PaginatedSelectableComputeTiers

PaginatedSnapshotEnvelopeV1

PaginatedUserEnvelopeV1

PaginationV1

PatchRegisteredModelV1

ProjectCollaboratorEnvelopeV1

ProjectCollaboratorV1

ProjectCopyResultEnvelopeV1

ProjectEnvelopeV1

ProjectGitRepositoryEnvelopeV1

ProjectGitRepositoryV1

ProjectGoalEnvelopeV1

ProjectGoalForUpdateV1

ProjectGoalV1

ProjectGoalsEnvelopeV1

ProjectRepositoryReferenceV1

ProjectResultsSettingsEnvelopeV1

ProjectResultsSettingsV1

ProjectStatusEnvelopeV1

ProjectStatusV1

ProjectTemplateDetailsV1

ProjectV1

ProjectVisibilityV1

ProviderRepoVisibilityV1

ProxyConfigV1

QueuedJobStatusDetailsV1

ReferenceCopyGitRepoSpecV1

RegisteredModelForUIV1

RegisteredModelMetricsV1

RegisteredModelProjectSummaryV1

RegisteredModelRequestingUserAccessV1

RegisteredModelReviewSummaryV1

RegisteredModelReviewUserInfoV1

RegisteredModelStageEnvelopeV1

RegisteredModelStageV1

RegisteredModelTagsV1

RegisteredModelV1

RegisteredModelVersionCustomStageResponseV1

RegisteredModelVersionCustomStageV1

RegisteredModelVersionDataSourceDetailsV1

RegisteredModelVersionDatasetDetailsV1

RegisteredModelVersionDetailsV1

RegisteredModelVersionExperimentRunInfoV1

RegisteredModelVersionExperimentRunMetricV1

RegisteredModelVersionExperimentRunParamV1

RegisteredModelVersionModelApiV1

RegisteredModelVersionOverviewV1

RegisteredModelVersionReviewStageResponseV1

RegisteredModelVersionReviewStagesResponseV1

RegisteredModelVersionStageValidationV1

RegisteredModelVersionStagesResponseV1

RegisteredModelVersionStagesV1

RegisteredModelVersionUiDetailsV1

RemoteMetric

RemoteModelDetail

SchemaDefinition

SchemaDefinitionItem

SchemaValueDataType

SchemaValues

SelectableComputeTier

SharedDatasetRwEntryV1

SharedDatasetsEnvelopeV1

SnapshotDetailsV1

SnapshotEnvelopeV1

StageTimesV1

StreamedResponseDTO

SupportedSource

TagEnvelopeV1

TagToAddV1

TagV1

TargetRangeV1

TokenPaginatedMetadataV1

TokenPaginationV1

UpdateEnvironmentRevisionV1

UpdatedEndpointPermissionsV1

UpdatedEndpointV1

UpdatedRegisteredModelReviewV1

UpdatedRegisteredModelVersionV1

UserEnvelopeV1

UserV1

WorkspaceSessionCreatedEnvelopeV1

WorkspaceSessionCreatedV1