Files
sdk/docs/PipelinesApi.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

18 KiB

PipelinesApi

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

Method HTTP request Description
engineCreatePipeline POST /v1/engine/pipelines Create ML pipeline
engineCreatePipelineRun POST /v1/engine/pipelines/{id}/runs Create pipeline run
engineDeletePipeline DELETE /v1/engine/pipelines/{id} Delete pipeline
engineGetPipeline GET /v1/engine/pipelines/{id} Get pipeline
engineGetPipelineRun GET /v1/engine/pipelines/{id}/runs/{run_id} Get pipeline run
engineListPipelineRuns GET /v1/engine/pipelines/{id}/runs List pipeline runs
engineListPipelines GET /v1/engine/pipelines List ML pipelines
mlCreatePipeline POST /v1/ml/pipelines Create a pipeline
mlGetPipeline GET /v1/ml/pipelines/{pipeline_id} Get pipeline details
mlListPipelineRuns GET /v1/ml/pipelines/{pipeline_id}/runs List pipeline runs
mlListPipelines GET /v1/ml/pipelines List pipelines
mlStartPipelineRun POST /v1/ml/pipelines/{pipeline_id}/runs Start a pipeline run

engineCreatePipeline

EnginePipeline engineCreatePipeline(enginePipelineCreate)

Create ML pipeline

Example

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

val apiInstance = PipelinesApi()
val enginePipelineCreate : EnginePipelineCreate =  // EnginePipelineCreate | 
try {
    val result : EnginePipeline = apiInstance.engineCreatePipeline(enginePipelineCreate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#engineCreatePipeline")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#engineCreatePipeline")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
enginePipelineCreate EnginePipelineCreate

Return type

EnginePipeline

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

engineCreatePipelineRun

EnginePipelineRun engineCreatePipelineRun(id, enginePipelineRunCreate)

Create pipeline run

Example

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

val apiInstance = PipelinesApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val enginePipelineRunCreate : EnginePipelineRunCreate =  // EnginePipelineRunCreate | 
try {
    val result : EnginePipelineRun = apiInstance.engineCreatePipelineRun(id, enginePipelineRunCreate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#engineCreatePipelineRun")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#engineCreatePipelineRun")
    e.printStackTrace()
}

Parameters

| id | java.util.UUID| | |

Name Type Description Notes
enginePipelineRunCreate EnginePipelineRunCreate [optional]

Return type

EnginePipelineRun

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

engineDeletePipeline

kotlin.Any engineDeletePipeline(id)

Delete pipeline

Example

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

val apiInstance = PipelinesApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : kotlin.Any = apiInstance.engineDeletePipeline(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#engineDeletePipeline")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#engineDeletePipeline")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.util.UUID

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

engineGetPipeline

EnginePipeline engineGetPipeline(id)

Get pipeline

Example

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

val apiInstance = PipelinesApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : EnginePipeline = apiInstance.engineGetPipeline(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#engineGetPipeline")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#engineGetPipeline")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.util.UUID

Return type

EnginePipeline

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

engineGetPipelineRun

EnginePipelineRun engineGetPipelineRun(id, runId)

Get pipeline run

Example

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

val apiInstance = PipelinesApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val runId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : EnginePipelineRun = apiInstance.engineGetPipelineRun(id, runId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#engineGetPipelineRun")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#engineGetPipelineRun")
    e.printStackTrace()
}

Parameters

| id | java.util.UUID| | |

Name Type Description Notes
runId java.util.UUID

Return type

EnginePipelineRun

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

engineListPipelineRuns

EngineListPipelineRuns200Response engineListPipelineRuns(id, status, page, pageSize)

List pipeline runs

Example

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

val apiInstance = PipelinesApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val status : kotlin.String = status_example // kotlin.String | 
val page : kotlin.Int = 56 // kotlin.Int | 
val pageSize : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EngineListPipelineRuns200Response = apiInstance.engineListPipelineRuns(id, status, page, pageSize)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#engineListPipelineRuns")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#engineListPipelineRuns")
    e.printStackTrace()
}

Parameters

| id | java.util.UUID| | | | status | kotlin.String| | [optional] [enum: pending, running, succeeded, failed, cancelled] | | page | kotlin.Int| | [optional] [default to 1] |

Name Type Description Notes
pageSize kotlin.Int [optional] [default to 20]

Return type

EngineListPipelineRuns200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

engineListPipelines

EngineListPipelines200Response engineListPipelines(page, pageSize)

List ML pipelines

Example

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

val apiInstance = PipelinesApi()
val page : kotlin.Int = 56 // kotlin.Int | 
val pageSize : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EngineListPipelines200Response = apiInstance.engineListPipelines(page, pageSize)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#engineListPipelines")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#engineListPipelines")
    e.printStackTrace()
}

Parameters

| page | kotlin.Int| | [optional] [default to 1] |

Name Type Description Notes
pageSize kotlin.Int [optional] [default to 20]

Return type

EngineListPipelines200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

mlCreatePipeline

MlPipeline mlCreatePipeline(mlCreatePipelineRequest)

Create a pipeline

Create and optionally start a training pipeline.

Example

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

val apiInstance = PipelinesApi()
val mlCreatePipelineRequest : MlCreatePipelineRequest = {"name":"hanzo-finetune","parameters":{"base_model":"meta-llama/Llama-3.1-8B","dataset":"s3://hanzo-data/training/v2","epochs":"3","learning_rate":2.0E-5},"auto_start":true} // MlCreatePipelineRequest | 
try {
    val result : MlPipeline = apiInstance.mlCreatePipeline(mlCreatePipelineRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#mlCreatePipeline")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#mlCreatePipeline")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
mlCreatePipelineRequest MlCreatePipelineRequest

Return type

MlPipeline

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

mlGetPipeline

MlPipeline mlGetPipeline(pipelineId)

Get pipeline details

Example

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

val apiInstance = PipelinesApi()
val pipelineId : kotlin.String = pipelineId_example // kotlin.String | 
try {
    val result : MlPipeline = apiInstance.mlGetPipeline(pipelineId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#mlGetPipeline")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#mlGetPipeline")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pipelineId kotlin.String

Return type

MlPipeline

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

mlListPipelineRuns

MlListPipelineRuns200Response mlListPipelineRuns(pipelineId)

List pipeline runs

Example

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

val apiInstance = PipelinesApi()
val pipelineId : kotlin.String = pipelineId_example // kotlin.String | 
try {
    val result : MlListPipelineRuns200Response = apiInstance.mlListPipelineRuns(pipelineId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#mlListPipelineRuns")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#mlListPipelineRuns")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pipelineId kotlin.String

Return type

MlListPipelineRuns200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

mlListPipelines

MlListPipelines200Response mlListPipelines(status, limit)

List pipelines

Example

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

val apiInstance = PipelinesApi()
val status : kotlin.String = status_example // kotlin.String | 
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : MlListPipelines200Response = apiInstance.mlListPipelines(status, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#mlListPipelines")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#mlListPipelines")
    e.printStackTrace()
}

Parameters

| status | kotlin.String| | [optional] [enum: pending, running, succeeded, failed, cancelled] |

Name Type Description Notes
limit kotlin.Int [optional] [default to 50]

Return type

MlListPipelines200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

mlStartPipelineRun

MlPipelineRun mlStartPipelineRun(pipelineId, mlStartPipelineRunRequest)

Start a pipeline run

Example

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

val apiInstance = PipelinesApi()
val pipelineId : kotlin.String = pipelineId_example // kotlin.String | 
val mlStartPipelineRunRequest : MlStartPipelineRunRequest =  // MlStartPipelineRunRequest | 
try {
    val result : MlPipelineRun = apiInstance.mlStartPipelineRun(pipelineId, mlStartPipelineRunRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PipelinesApi#mlStartPipelineRun")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PipelinesApi#mlStartPipelineRun")
    e.printStackTrace()
}

Parameters

| pipelineId | kotlin.String| | |

Name Type Description Notes
mlStartPipelineRunRequest MlStartPipelineRunRequest [optional]

Return type

MlPipelineRun

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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