API Reference

Optimize

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get async optimization result

client.optimize.retrieve(stringjobID, RequestOptionsoptions?): OptimizeJobStatus { status, error, result }

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

jobID: string

ReturnsExpand Collapse

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 | null

Error message when failed

result?: unknown

Optimization result when completed

Get async optimization result

TypeScript

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

import Plaza from '@plazafyi/sdk';

const client = new Plaza({
  apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted
});

const optimizeJobStatus = await client.optimize.retrieve('job_id');

console.log(optimizeJobStatus.status);

200 example

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

Returns Examples

200 example

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