API Reference

Optimize

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get async optimization result

$ plaza optimize retrieve

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

--job-id: string

ReturnsExpand Collapse

optimize_job_status: object { status, error, result }

Status of an async optimization job

status: "completed" or "processing" or "failed"

Job status

"completed"

"processing"

"failed"

error: optional string

Error message when failed

result: optional unknown

Optimization result when completed

Get async optimization result

CLI Tool

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

plaza optimize retrieve \
  --api-key 'My API Key' \
  --job-id job_id

200 example

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

Returns Examples

200 example

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