Files
sdk/docs/ExperimentsApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

8.8 KiB

ExperimentsApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
mlCreateExperiment POST /v1/ml/experiments Create an experiment
mlGetRunMetrics GET /v1/ml/experiments/{experiment_id}/runs/{run_id}/metrics Get run metrics
mlListExperimentRuns GET /v1/ml/experiments/{experiment_id}/runs List experiment runs
mlListExperiments GET /v1/ml/experiments List experiments
mlLogMetrics POST /v1/ml/experiments/{experiment_id}/runs/{run_id}/metrics Log metrics
mlStartExperimentRun POST /v1/ml/experiments/{experiment_id}/runs Start an experiment run

mlCreateExperiment

MlExperiment mlCreateExperiment(mlCreateExperimentRequest)

Create an experiment

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ExperimentsApi()
val mlCreateExperimentRequest : MlCreateExperimentRequest =  // MlCreateExperimentRequest | 
try {
    val result : MlExperiment = apiInstance.mlCreateExperiment(mlCreateExperimentRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExperimentsApi#mlCreateExperiment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExperimentsApi#mlCreateExperiment")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
mlCreateExperimentRequest MlCreateExperimentRequest

Return type

MlExperiment

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

mlGetRunMetrics

MlGetRunMetrics200Response mlGetRunMetrics(experimentId, runId)

Get run metrics

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ExperimentsApi()
val experimentId : kotlin.String = experimentId_example // kotlin.String | 
val runId : kotlin.String = runId_example // kotlin.String | 
try {
    val result : MlGetRunMetrics200Response = apiInstance.mlGetRunMetrics(experimentId, runId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExperimentsApi#mlGetRunMetrics")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExperimentsApi#mlGetRunMetrics")
    e.printStackTrace()
}

Parameters

| experimentId | kotlin.String| | |

Name Type Description Notes
runId kotlin.String

Return type

MlGetRunMetrics200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

mlListExperimentRuns

MlListExperimentRuns200Response mlListExperimentRuns(experimentId)

List experiment runs

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ExperimentsApi()
val experimentId : kotlin.String = experimentId_example // kotlin.String | 
try {
    val result : MlListExperimentRuns200Response = apiInstance.mlListExperimentRuns(experimentId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExperimentsApi#mlListExperimentRuns")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExperimentsApi#mlListExperimentRuns")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
experimentId kotlin.String

Return type

MlListExperimentRuns200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

mlListExperiments

MlListExperiments200Response mlListExperiments()

List experiments

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ExperimentsApi()
try {
    val result : MlListExperiments200Response = apiInstance.mlListExperiments()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExperimentsApi#mlListExperiments")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExperimentsApi#mlListExperiments")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

MlListExperiments200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

mlLogMetrics

mlLogMetrics(experimentId, runId, requestBody)

Log metrics

Log metrics for a running experiment.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ExperimentsApi()
val experimentId : kotlin.String = experimentId_example // kotlin.String | 
val runId : kotlin.String = runId_example // kotlin.String | 
val requestBody : kotlin.collections.Map<kotlin.String, java.math.BigDecimal> = Object // kotlin.collections.Map<kotlin.String, java.math.BigDecimal> | 
try {
    apiInstance.mlLogMetrics(experimentId, runId, requestBody)
} catch (e: ClientException) {
    println("4xx response calling ExperimentsApi#mlLogMetrics")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExperimentsApi#mlLogMetrics")
    e.printStackTrace()
}

Parameters

| experimentId | kotlin.String| | | | runId | kotlin.String| | |

Name Type Description Notes
requestBody kotlin.collections.Map<kotlin.String, java.math.BigDecimal>

Return type

null (empty response body)

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

mlStartExperimentRun

MlExperimentRun mlStartExperimentRun(experimentId, mlStartExperimentRunRequest)

Start an experiment run

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ExperimentsApi()
val experimentId : kotlin.String = experimentId_example // kotlin.String | 
val mlStartExperimentRunRequest : MlStartExperimentRunRequest =  // MlStartExperimentRunRequest | 
try {
    val result : MlExperimentRun = apiInstance.mlStartExperimentRun(experimentId, mlStartExperimentRunRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExperimentsApi#mlStartExperimentRun")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExperimentsApi#mlStartExperimentRun")
    e.printStackTrace()
}

Parameters

| experimentId | kotlin.String| | |

Name Type Description Notes
mlStartExperimentRunRequest MlStartExperimentRunRequest

Return type

MlExperimentRun

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json