API Reference

Optimize

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get async optimization result

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

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

OptimizeRetrieveParams params

Optional<String> jobId

ReturnsExpand Collapse

class OptimizeJobStatus:

Status of an async optimization job

Status status

Job status

One of the following:

COMPLETED("completed")

PROCESSING("processing")

FAILED("failed")

Optional<String> error

Error message when failed

Optional<JsonValue> result

Optimization result when completed

Get async optimization result

Java

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;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        PlazaClient client = PlazaOkHttpClient.fromEnv();

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

200 example

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

Returns Examples

200 example

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