Edit

Share via

Items - Create ML Experiment

Service:
MLExperiment
API Version:
v1

Creates a machine learning experiment in the specified workspace.
This API supports long running operations (LRO).

This API does not support create an machine learning experiment with definition.

Permissions

The caller must have a contributor workspace role.

Required Delegated Scopes

MLExperiment.ReadWrite.All or Item.ReadWrite.All

Limitations

  • To create a machine learning experiment the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mlExperiments

URI Parameters

Name In Required Type Description
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Required Type Description
displayName True

string

The machine learning experiment display name. The display name must follow naming rules according to item type.
description

string

The machine learning experiment description. Maximum length is 256 characters.
folderId

string (uuid)

The folder ID. If not specified or null, the machine learning experiment is created with the workspace as its folder.

Responses

Name Type Description
201 Created

MLExperiment

Successfully created
202 Accepted

Request accepted, machine learning experiment provisioning in progress.

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • InvalidItemType - Item type is invalid.

  • ItemDisplayNameAlreadyInUse - Item display name is already used.

  • CorruptedPayload - The provided payload is corrupted.

  • WorkspaceItemsLimitExceeded - Workspace item limit exceeded.

Examples

Create a machine learning experiment example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/mlExperiments

{
  "displayName": "MLExperiment_1",
  "description": "A machine learning experiment description"
}

Sample response

Status code:
201 
{
  "displayName": "MLExperiment_1",
  "description": "A machine learning experiment description",
  "type": "MLExperiment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitions

Name Description
CreateMLExperimentRequest

Create machine learning experiment request payload.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
ItemTag

Represents a tag applied on an item.
ItemType

The type of the item. Additional item types may be added over time.
MLExperiment

A machine learning experiment object.
MLExperimentProperties

The machine learning experiment properties.

CreateMLExperimentRequest

Object

Create machine learning experiment request payload.

Name Type Description
description

string

The machine learning experiment description. Maximum length is 256 characters.
displayName

string

The machine learning experiment display name. The display name must follow naming rules according to item type.
folderId

string (uuid)

The folder ID. If not specified or null, the machine learning experiment is created with the workspace as its folder.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

ItemTag

Object

Represents a tag applied on an item.

Name Type Description
displayName

string

The name of the tag.
id

string (uuid)

The tag ID.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value Description
Dashboard

PowerBI dashboard.
Report

PowerBI report.
SemanticModel

PowerBI semantic model.
PaginatedReport

PowerBI paginated report.
Datamart

PowerBI datamart.
Lakehouse

A lakehouse.
Eventhouse

An eventhouse.
Environment

An environment.
KQLDatabase

A KQL database.
KQLQueryset

A KQL queryset.
KQLDashboard

A KQL dashboard.
DataPipeline

A data pipeline.
Notebook

A notebook.
SparkJobDefinition

A spark job definition.
MLExperiment

A machine learning experiment.
MLModel

A machine learning model.
Warehouse

A warehouse.
Eventstream

An eventstream.
SQLEndpoint

An SQL endpoint.
MirroredWarehouse

A mirrored warehouse.
MirroredDatabase

A mirrored database.
Reflex

A Reflex.
GraphQLApi

An API for GraphQL item.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

A Copy job.
VariableLibrary

A VariableLibrary.
Dataflow

A Dataflow.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

A Warehouse snapshot.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

A mirrored azure databricks catalog.

MLExperiment

Object

A machine learning experiment object.

Name Type Description
description

string

The item description.
displayName

string

The item display name.
folderId

string (uuid)

The folder ID.
id

string (uuid)

The item ID.
properties

MLExperimentProperties

The machine learning experiment properties.
tags

ItemTag[]

List of applied tags.
type

ItemType

The item type.
workspaceId

string (uuid)

The workspace ID.

MLExperimentProperties

Object

The machine learning experiment properties.

Name Type Description
mlFlowExperimentId

string (uuid)

The internal machine learning flow experiment ID.