---
title: "Get Or Initialize"
method: POST
path: "/method/nimbus/get-or-initialize"
---

# Get Or Initialize

`POST /method/nimbus/get-or-initialize`

Get the latest NIMBUS state if it exists, or initialize a new one if it doesn't.

## Request body

- NIMBUSInitializationRequest — Model of the request to the nimbus method.
  - `problem_id` integer, required
  - `session_id` integer, nullable
  - `parent_state_id` integer, nullable
  - `starting_point` union
    - ReferencePoint — Model for representing a reference point type of preference.
      - `preference_type` 'reference_point'
      - `aspiration_levels` object, required
    - SolutionInfo — Used when we wish to reference a solution in some `StateDB` stored in the database.
      - `state_id` integer, required
      - `solution_index` integer, required
      - `name` string, nullable — Name to be given to the solution. Optional.
  - `scalarization_options` object, nullable
  - `solver` string, nullable
  - `solver_options` object, nullable

## Response `200`

Successful Response

- union
  - NIMBUSInitializationResponse — The response from NIMBUS classification endpoint.
    - `state_id` integer, nullable, required — The newly created state id
    - `current_solutions` SolutionReferenceResponse[], required — The solutions from the current interation of nimbus.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required
    - `saved_solutions` SolutionReferenceResponse[], required — The best candidate solutions saved by the decision maker.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required
    - `all_solutions` SolutionReferenceResponse[], required — All solutions generated by NIMBUS in all iterations.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required
  - NIMBUSClassificationResponse — The response from NIMBUS classification endpoint.
    - `state_id` integer, nullable, required — The newly created state id
    - `previous_preference` ReferencePoint, required — Model for representing a reference point type of preference.
      - `preference_type` 'reference_point'
      - `aspiration_levels` object, required
    - `previous_objectives` object, required — The previous solutions objectives used for iteration.
    - `current_solutions` SolutionReferenceResponse[], required — The solutions from the current iteration of nimbus.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required
    - `saved_solutions` SolutionReferenceResponse[], required — The best candidate solutions saved by the decision maker.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required
    - `all_solutions` SolutionReferenceResponse[], required — All solutions generated by NIMBUS in all iterations.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required
  - NIMBUSIntermediateSolutionResponse — The response from NIMBUS classification endpoint.
    - `state_id` integer, nullable, required — The newly created state id
    - `reference_solution_1` object, required — The first solution used when computing intermediate points.
    - `reference_solution_2` object, required — The second solution used when computing intermediate points.
    - `current_solutions` SolutionReferenceResponse[], required — The solutions from the current iteration of NIMBUS.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required
    - `saved_solutions` SolutionReferenceResponse[], required — The best candidate solutions saved by the decision maker.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required
    - `all_solutions` SolutionReferenceResponse[], required — All solutions generated by NIMBUS in all iterations.
      - `name` string, nullable, required
      - `solution_index` integer, nullable, required
      - `state_id` integer, required
      - `objective_values` object, nullable, required
      - `variable_values` object, nullable, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/industrial-optimization-group/apis/desdeo-fast-api.md) · [All operations](https://skmtc.net/industrial-optimization-group/apis/desdeo-fast-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/industrial-optimization-group/desdeo-fast-api/versions/c24fa4e23380/schema)