API Reference

Optimize

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get async optimization result

GET/api/v1/optimize/{job_id}

Get async optimization result

Path ParametersExpand Collapse

job_id: string

ReturnsExpand Collapse

OptimizeJobStatus = object { status, error, result }

Status of an async optimization job

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

Job status

One of the following:

"completed"

"processing"

"failed"

error: optional string

Error message when failed

result: optional unknown

Optimization result when completed

Get async optimization result

HTTP

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

curl https://plaza.fyi/api/v1/optimize/$JOB_ID \
    -H "Authorization: Bearer $PLAZA_API_KEY"

200 example

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

Returns Examples

200 example

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