API Reference

Optimize

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get async optimization result

optimize().retrieve(OptimizeRetrieveParamsparams = OptimizeRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : OptimizeJobStatus

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

params: OptimizeRetrieveParams

jobId: Optional<String>

ReturnsExpand Collapse

class OptimizeJobStatus:

Status of an async optimization job

status: Status

Job status

One of the following:

COMPLETED("completed")

PROCESSING("processing")

FAILED("failed")

error: Optional<String>

Error message when failed

result: Optional<JsonValue>

Optimization result when completed

Get async optimization result

Kotlin

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package com.plazafyi.example

import com.plazafyi.client.PlazaClient
import com.plazafyi.client.okhttp.PlazaOkHttpClient
import com.plazafyi.models.optimize.OptimizeJobStatus
import com.plazafyi.models.optimize.OptimizeRetrieveParams

fun main() {
    val client: PlazaClient = PlazaOkHttpClient.fromEnv()

    val optimizeJobStatus: OptimizeJobStatus = client.optimize().retrieve("job_id")
}

200 example

{
  "status": "completed",
  "error": "error",
  "result": {}
}

Returns Examples

200 example

{
  "status": "completed",
  "error": "error",
  "result": {}
}