Skip to main content
Cancel Optimization

Path Parameters

id
string
required

Response

Successful Response

Frontend-facing view of an optimization.

Replaces the job-centric {optimization, job} payload: the linked job is collapsed into a flat status plus result metrics and error fields, so clients never see the underlying job. Heavy config and metadata blobs are served by dedicated sub-resource endpoints rather than inlined here.

id
string
required

Canonical optimization identifier.

project_id
string
required
organization_id
string
required
name
string | null
description
string | null
status
enum<string> | null

Lifecycle status derived from the optimization run.

Available options:
queued,
running,
succeeded,
failed,
canceled
kind
string | null

Optimization kind discriminator (e.g. 'optimize', 'datafit'); determines how the config is interpreted.

created_at
string<date-time> | null
created_by_email
string | null
cell_spec_id
string | null
parameterized_model_id
string | null
parameterized_model_name
string | null

Display name of the parameterized model.

cell_name
string | null

Display name of the cell specification.

optimization_template_id
string | null
metrics
Metrics · object | null

Result metrics of the optimization, when complete.

objectives
Objectives · object | null

Objectives/constraints from the config, for list display. Populated on list responses only.

error
string | null

Error message if the run failed.

error_code
string | null

Machine-readable error code.

run_count
integer
default:0

Number of multistart runs.