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(strjob_id) -> OptimizeJobStatus

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

job_id: str

ReturnsExpand Collapse

class OptimizeJobStatus: …

Status of an async optimization job

status: Literal["completed", "processing", "failed"]

Job status

One of the following:

"completed"

"processing"

"failed"

error: Optional[str]

Error message when failed

result: Optional[object]

Optimization result when completed

Get async optimization result

Python

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

import os
from plaza import Plaza

client = Plaza(
    api_key=os.environ.get("PLAZA_API_KEY"),  # This is the default and can be omitted
)
optimize_job_status = client.optimize.retrieve(
    "job_id",
)
print(optimize_job_status.status)

200 example

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

Returns Examples

200 example

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