Jump to

• Request
• Response

(Preview) Create a new experiment run

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/create

(Preview) Creates a new run within an experiment.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  The key of the Workspace

Header Parameters

• dh-user-principal: string
  The DH User Principal Header .
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

Details for the new run.

Root Schema : CreateExperimentRunDetails

Type: object

Details of run to create.

Show Source

• experiment_id: string
  ID of the associated experiment.
• run_name: string
  Name of the run.
• start_time: integer(int64)
  Unix timestamp in milliseconds when the run started.
• tags: array tags
  Tags to log.

{
    "description":"Details of run to create.",
    "type":"object",
    "properties":{
        "run_name":{
            "type":"string",
            "description":"Name of the run."
        },
        "experiment_id":{
            "type":"string",
            "description":"ID of the associated experiment."
        },
        "start_time":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when the run started."
        },
        "tags":{
            "type":"array",
            "description":"Tags to log.",
            "items":{
                "$ref":"#/definitions/ExperimentRunTag"
            }
        }
    }
}

Nested Schema : tags

Type: array

Tags to log.

Show Source

• Array of: object ExperimentRunTag
  Run tag.

{
    "type":"array",
    "description":"Tags to log.",
    "items":{
        "$ref":"#/definitions/ExperimentRunTag"
    }
}

Nested Schema : ExperimentRunTag

Type: object

Run tag.

Show Source

• key: string
  Key of the run tag.
• value: string
  Value of the run tag.

{
    "type":"object",
    "description":"Run tag.",
    "properties":{
        "key":{
            "description":"Key of the run tag.",
            "type":"string"
        },
        "value":{
            "description":"Value of the run tag.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Run is created within an experiment.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : CreateExperimentRunResponseDetails

Type: object

Details of created run.

Show Source

• run(required): object ExperimentRun
  Details of an experiment run.

{
    "description":"Details of created run.",
    "type":"object",
    "required":[
        "run"
    ],
    "properties":{
        "run":{
            "$ref":"#/definitions/ExperimentRun"
        }
    }
}

Nested Schema : ExperimentRun

Type: object

Details of an experiment run.

Show Source

• data: object ExperimentRunData
  Run data.
• info: object ExperimentRunInfo
  Run metadata.
• inputs: object ExperimentRunInputs
  Run inputs.
• outputs: object ExperimentRunOutputs
  Run outputs.

{
    "description":"Details of an experiment run.",
    "type":"object",
    "properties":{
        "info":{
            "$ref":"#/definitions/ExperimentRunInfo"
        },
        "data":{
            "$ref":"#/definitions/ExperimentRunData"
        },
        "inputs":{
            "$ref":"#/definitions/ExperimentRunInputs"
        },
        "outputs":{
            "$ref":"#/definitions/ExperimentRunOutputs"
        }
    }
}

Nested Schema : ExperimentRunData

Type: object

Run data.

Show Source

• metrics: array metrics
  Metrics logged for the run.
• params: array params
  Parameters logged for the run.
• tags: array tags
  Tags to log.

{
    "description":"Run data.",
    "type":"object",
    "properties":{
        "metrics":{
            "type":"array",
            "description":"Metrics logged for the run.",
            "items":{
                "$ref":"#/definitions/ExperimentRunMetric"
            }
        },
        "params":{
            "type":"array",
            "description":"Parameters logged for the run.",
            "items":{
                "$ref":"#/definitions/ExperimentRunParam"
            }
        },
        "tags":{
            "type":"array",
            "description":"Tags to log.",
            "items":{
                "$ref":"#/definitions/ExperimentRunTag"
            }
        }
    }
}

Nested Schema : ExperimentRunInfo

Type: object

Run metadata.

Show Source

• artifact_uri: string
  Artifact URI of the run.
• end_time: integer(int64)
  Unix timestamp in milliseconds when the run ended.
• experiment_id: string
  ID of the associated experiment.
• lifecycle_stage: string
  Lifecycle stage of the experiment, e.g., 'active' or 'deleted'.
• run_id: string
  Unique identifier for the run.
• run_name: string
  Name of the run.
• run_uuid: string
  UUID of the run.
• start_time: integer(int64)
  Unix timestamp in milliseconds when the run started.
• status: string
  Allowed Values: [ "RUNNING", "SCHEDULED", "FINISHED", "FAILED", "KILLED", "INTERNAL_ERROR" ]

  Status of the run.
• user_id: string
  User ID that created the run.

{
    "description":"Run metadata.",
    "type":"object",
    "properties":{
        "run_id":{
            "type":"string",
            "description":"Unique identifier for the run."
        },
        "run_name":{
            "type":"string",
            "description":"Name of the run."
        },
        "experiment_id":{
            "type":"string",
            "description":"ID of the associated experiment."
        },
        "status":{
            "description":"Status of the run.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ExperimentRunStatus",
            "enum":[
                "RUNNING",
                "SCHEDULED",
                "FINISHED",
                "FAILED",
                "KILLED",
                "INTERNAL_ERROR"
            ]
        },
        "start_time":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when the run started."
        },
        "end_time":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when the run ended."
        },
        "artifact_uri":{
            "type":"string",
            "description":"Artifact URI of the run."
        },
        "lifecycle_stage":{
            "type":"string",
            "description":"Lifecycle stage of the experiment, e.g., 'active' or 'deleted'."
        },
        "run_uuid":{
            "type":"string",
            "description":"UUID of the run."
        },
        "user_id":{
            "type":"string",
            "description":"User ID that created the run."
        }
    }
}

Nested Schema : ExperimentRunInputs

Type: object

Run inputs.

Show Source

• dataset_inputs: array dataset_inputs
  Dataset inputs for the run.
• model_inputs: array model_inputs
  Model inputs for the run.

{
    "description":"Run inputs.",
    "type":"object",
    "properties":{
        "dataset_inputs":{
            "type":"array",
            "description":"Dataset inputs for the run.",
            "items":{
                "$ref":"#/definitions/DatasetInput"
            }
        },
        "model_inputs":{
            "type":"array",
            "description":"Model inputs for the run.",
            "items":{
                "$ref":"#/definitions/ModelInput"
            }
        }
    }
}

Nested Schema : ExperimentRunOutputs

Type: object

Run outputs.

Show Source

• model_outputs: array model_outputs
  Model outputs for the run.

{
    "description":"Run outputs.",
    "type":"object",
    "properties":{
        "model_outputs":{
            "type":"array",
            "description":"Model outputs for the run.",
            "items":{
                "$ref":"#/definitions/ModelOutput"
            }
        }
    }
}

Nested Schema : metrics

Type: array

Metrics logged for the run.

Show Source

• Array of: object ExperimentRunMetric
  Run metric.

{
    "type":"array",
    "description":"Metrics logged for the run.",
    "items":{
        "$ref":"#/definitions/ExperimentRunMetric"
    }
}

Nested Schema : params

Type: array

Parameters logged for the run.

Show Source

• Array of: object ExperimentRunParam
  Run param.

{
    "type":"array",
    "description":"Parameters logged for the run.",
    "items":{
        "$ref":"#/definitions/ExperimentRunParam"
    }
}

Nested Schema : tags

Type: array

Tags to log.

Show Source

• Array of: object ExperimentRunTag
  Run tag.

{
    "type":"array",
    "description":"Tags to log.",
    "items":{
        "$ref":"#/definitions/ExperimentRunTag"
    }
}

Nested Schema : ExperimentRunMetric

Type: object

Run metric.

Show Source

• key: string
  Name of the metric.
• step: integer(int64)
  Step at which to log the metric.
• timestamp: integer(int64)
  Unix timestamp in milliseconds when this metric was recorded.
• value: number(double)
  Value of the metric.

{
    "type":"object",
    "description":"Run metric.",
    "properties":{
        "key":{
            "description":"Name of the metric.",
            "type":"string"
        },
        "value":{
            "description":"Value of the metric.",
            "type":"number",
            "format":"double"
        },
        "timestamp":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when this metric was recorded."
        },
        "step":{
            "type":"integer",
            "format":"int64",
            "description":"Step at which to log the metric."
        }
    }
}

Nested Schema : ExperimentRunParam

Type: object

Run param.

Show Source

• key: string
  Key of the parameter.
• value: string
  Value of the parameter.

{
    "type":"object",
    "description":"Run param.",
    "properties":{
        "key":{
            "description":"Key of the parameter.",
            "type":"string"
        },
        "value":{
            "description":"Value of the parameter.",
            "type":"string"
        }
    }
}

Nested Schema : ExperimentRunTag

Type: object

Run tag.

Show Source

• key: string
  Key of the run tag.
• value: string
  Value of the run tag.

{
    "type":"object",
    "description":"Run tag.",
    "properties":{
        "key":{
            "description":"Key of the run tag.",
            "type":"string"
        },
        "value":{
            "description":"Value of the run tag.",
            "type":"string"
        }
    }
}

Nested Schema : dataset_inputs

Type: array

Dataset inputs for the run.

Show Source

• Array of: object DatasetInput
  DatasetInput

{
    "type":"array",
    "description":"Dataset inputs for the run.",
    "items":{
        "$ref":"#/definitions/DatasetInput"
    }
}

Nested Schema : model_inputs

Type: array

Model inputs for the run.

Show Source

• Array of: object ModelInput
  Model input.

{
    "type":"array",
    "description":"Model inputs for the run.",
    "items":{
        "$ref":"#/definitions/ModelInput"
    }
}

Nested Schema : DatasetInput

Type: object

DatasetInput

Show Source

• dataset(required): object Dataset
  Dataset. Represents a reference to data used for training, testing, or evaluation during the model development process.
• tags: array tags
  Tags for the dataset input.

{
    "description":"DatasetInput",
    "type":"object",
    "required":[
        "dataset"
    ],
    "properties":{
        "dataset":{
            "$ref":"#/definitions/Dataset"
        },
        "tags":{
            "type":"array",
            "description":"Tags for the dataset input.",
            "items":{
                "$ref":"#/definitions/InputTag"
            }
        }
    }
}

Nested Schema : Dataset

Type: object

Dataset. Represents a reference to data used for training, testing, or evaluation during the model development process.

Show Source

• digest(required): string
  Digest (hash) of the dataset.
• name(required): string
  Name of the dataset.
• profile: string
  Profile of the dataset.
• schema: string
  Schema of the dataset.
• source(required): string
  URI or path to the dataset source.
• source_type(required): string
  Type of the dataset source.

{
    "type":"object",
    "description":"Dataset. Represents a reference to data used for training, testing, or evaluation during the model development process.",
    "required":[
        "name",
        "digest",
        "source_type",
        "source"
    ],
    "properties":{
        "name":{
            "description":"Name of the dataset.",
            "type":"string"
        },
        "digest":{
            "description":"Digest (hash) of the dataset.",
            "type":"string"
        },
        "source_type":{
            "description":"Type of the dataset source.",
            "type":"string"
        },
        "source":{
            "description":"URI or path to the dataset source.",
            "type":"string"
        },
        "schema":{
            "description":"Schema of the dataset.",
            "type":"string"
        },
        "profile":{
            "description":"Profile of the dataset.",
            "type":"string"
        }
    }
}

Nested Schema : tags

Type: array

Tags for the dataset input.

Show Source

• Array of: object InputTag
  Run tag.

{
    "type":"array",
    "description":"Tags for the dataset input.",
    "items":{
        "$ref":"#/definitions/InputTag"
    }
}

Nested Schema : InputTag

Type: object

Run tag.

Show Source

• key(required): string
  Key of the tag.
• value(required): string
  Value of the tag.

{
    "type":"object",
    "description":"Run tag.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "description":"Key of the tag.",
            "type":"string"
        },
        "value":{
            "description":"Value of the tag.",
            "type":"string"
        }
    }
}

Nested Schema : ModelInput

Type: object

Model input.

Show Source

• model_id(required): string
  ID of the model input.

{
    "type":"object",
    "description":"Model input.",
    "required":[
        "model_id"
    ],
    "properties":{
        "model_id":{
            "description":"ID of the model input.",
            "type":"string"
        }
    }
}

Nested Schema : model_outputs

Type: array

Model outputs for the run.

Show Source

• Array of: object ModelOutput
  Model output.

{
    "type":"array",
    "description":"Model outputs for the run.",
    "items":{
        "$ref":"#/definitions/ModelOutput"
    }
}

Nested Schema : ModelOutput

Type: object

Model output.

Show Source

• model_id(required): string
  ID of the model input.
• step: integer(int64)
  Step at which the model was produced.

{
    "type":"object",
    "description":"Model output.",
    "required":[
        "model_id"
    ],
    "properties":{
        "model_id":{
            "description":"ID of the model input.",
            "type":"string"
        },
        "step":{
            "type":"integer",
            "format":"int64",
            "description":"Step at which the model was produced."
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top