API Reference

Optimize

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get async optimization result

OptimizeJobStatus Optimize.Retrieve(OptimizeRetrieveParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

OptimizeRetrieveParams parameters

required string jobID

ReturnsExpand Collapse

class OptimizeJobStatus:

Status of an async optimization job

required Status Status

Job status

One of the following:

"completed"Completed

"processing"Processing

"failed"Failed

string? Error

Error message when failed

JsonElement? Result

Optimization result when completed

Get async optimization result

C#

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

OptimizeRetrieveParams parameters = new() { JobID = "job_id" };

var optimizeJobStatus = await client.Optimize.Retrieve(parameters);

Console.WriteLine(optimizeJobStatus);

200 example

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

Returns Examples

200 example

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