---
title: "Set Optimizer"
method: PUT
path: "/optimisation/optimizer"
tags: ["optimisation"]
---

# Set Optimizer

`PUT /optimisation/optimizer`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/optimisation/optimizer`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Opt the workspace into OS3's optimizer agent, or out again: an owner or admin. Switched
off, its work on the workspace's tasks stops before its next step.

## Request body

- OptimizerIn
  - `workspace_id` string, uuid, required
  - `enabled` boolean, required

## Response `200`

Successful Response

- OptimizerSetting: OS3's optimizer agent in a workspace, a preview you opt into (off unless switched on): for each task it plans and runs bounded training experiments within the task's mandate, and hands its best candidate to the same independent evaluation and release checks as every other candidate; it never sees the held-out cases that decide a release. `available`: whether the preview runs for your organisation yet; until it does, your choice is kept and nothing runs.
  - `workspace_id` string, uuid, required
  - `enabled` boolean, required
  - `available` boolean, required
  - `set_by` string, nullable, required
  - `set_at` string, date-time, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/os3robotics/apis/os3-api.md) - [All operations](https://skmtc.dev/os3robotics/apis/os3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/os3robotics/apis/os3-api/revisions/af32cd4f14bb?raw)
