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(string jobID): OptimizeJobStatus

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

jobID: string

ReturnsExpand Collapse

OptimizeJobStatus

Status status

Job status

?string error

Error message when failed

?mixed result

Optimization result when completed

Get async optimization result

PHP

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'local');

$optimizeJobStatus = $client->optimize->retrieve('job_id');

var_dump($optimizeJobStatus);

200 example

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

Returns Examples

200 example

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