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(job_id) -> OptimizeJobStatus { status, error, result }

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

job_id: String

ReturnsExpand Collapse

class OptimizeJobStatus { status, error, result }

Status of an async optimization job

status: :completed | :processing | :failed

Job status

One of the following:

:completed

:processing

:failed

error: String

Error message when failed

result: untyped

Optimization result when completed

Get async optimization result

Ruby

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

require "plaza"

plaza = Plaza::Client.new(
  api_key: "My API Key",
  environment: "local" # defaults to "production"
)

optimize_job_status = plaza.optimize.retrieve("job_id")

puts(optimize_job_status)

200 example

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

Returns Examples

200 example

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