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.Get(ctx, jobID) (*OptimizeJobStatus, error)

GET/api/v1/optimize/{job_id}

Get async optimization result

ParametersExpand Collapse

jobID string

ReturnsExpand Collapse

type OptimizeJobStatus struct{…}

Status of an async optimization job

Status OptimizeJobStatusStatus

Job status

One of the following:

const OptimizeJobStatusStatusCompleted OptimizeJobStatusStatus = "completed"

const OptimizeJobStatusStatusProcessing OptimizeJobStatusStatus = "processing"

const OptimizeJobStatusStatusFailed OptimizeJobStatusStatus = "failed"

Error stringoptional

Error message when failed

Result unknownoptional

Optimization result when completed

Get async optimization result

Go

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package main

import (
  "context"
  "fmt"

  "github.com/plazafyi/plaza-go"
  "github.com/plazafyi/plaza-go/option"
)

func main() {
  client := githubcomplazafyiplazago.NewClient(
    option.WithAPIKey("My API Key"),
  )
  optimizeJobStatus, err := client.Optimize.Get(context.TODO(), "job_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", optimizeJobStatus.Status)
}

200 example

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

Returns Examples

200 example

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