> This page is for version 0.5.1.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo-helix/latest/llms.txt
> - 0.7.0: https://docs.nvidia.com/nemo-helix/v0.7.0/llms.txt
> - 0.6.0: https://docs.nvidia.com/nemo-helix/v0.6.0/llms.txt
> - 0.5.1: https://docs.nvidia.com/nemo-helix/v0.5.1/llms.txt
> - 0.5.0: https://docs.nvidia.com/nemo-helix/v0.5.0/llms.txt
> - 0.4.0: https://docs.nvidia.com/nemo-helix/v0.4.0/llms.txt
> - 0.3.0: https://docs.nvidia.com/nemo-helix/v0.3.0/llms.txt
> - 0.2.0: https://docs.nvidia.com/nemo-helix/v0.2.0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo-helix/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo-helix/_mcp/server.

# Update Experiment

PUT /apis/intake/v2/workspaces/{workspace}/experiments/{name}
Content-Type: application/json

Reference: https://docs.nvidia.com/nemo-helix/v0.5.1/documentation/reference/api-reference/experiments/update-experiment-apis-intake-v-2-workspaces-workspace-experiments-name-put

## Request

### Path parameters

- `workspace` (string, required)
- `name` (string, required)

### Body (application/json)

This endpoint expects an ExperimentUpdateRequest.

- `name` (string, required) — Workspace-unique experiment name.
- `description` (string, optional) — Human-readable purpose of the experiment.
- `insight_id` (string, optional) — Reference to an external insight that seeded this experiment, if any.
- `summary` (string, optional) — Human- or agent-authored summary of the experiment's findings.
- `metadata` (map from string to string, optional) — Free-form producer metadata for the experiment.
- `default_sort` (string, optional, default: -created_at) — Default sort for this experiment's evaluations list, as a `sort`-param string: a comma-separated, ordered list of fields where the first is the primary sort and the rest break ties (leading '-' on a field = descending), e.g. '-evaluators.reward.mean,cost_usd.mean'. Defaults to '-created_at'. Accepts any field the evaluations list `sort` param does; clients apply it as the list `sort` param.
- `pareto` (ParetoConfig, optional) — Default X/Y metrics for the experiment's Pareto view. Omit to preserve the existing value on update; on create, defaults to cost vs. latency.
- `column_layout` (ColumnLayout, optional) — Saved column order and column visibility for the experiment's evaluations table. Omit to leave the saved layout unchanged; on create that means no layout is saved. An empty order and hidden pair is itself a saved layout — one that shows every column — and is distinct from having none.
- `is_favorite` (boolean, optional, default: false) — Whether this Experiment is marked as a favorite. Defaults to false on create; omit on update to preserve the existing value.
- `show_evaluations_over_time` (boolean, optional, default: false) — Whether Studio should display this Experiment's Evaluation results over time. Defaults to false on create; omit on update to preserve the existing value.
- `baseline_evaluation_name` (string, optional, nullable) — Name of this Experiment's baseline Evaluation. The Evaluation must already be a live member of the Experiment. Set null to clear the selected baseline.

## Response

### 200

Successful Response

- `id` (string, required)
- `name` (string, required)
- `workspace` (string, required)
- `default_sort` (string, required)
- `description` (string, optional)
- `insight_id` (string, optional)
- `summary` (string, optional)
- `metadata` (map from string to string, optional)
- `pareto` (ParetoConfig, optional) — Default X/Y metrics for a group's cost-vs-accuracy Pareto view. Metric ids use the same vocabulary as the evaluations list sort/filter fields — `cost_usd`, `latency_ms`, `tokens`, or `evaluators.<name>`. Defaults to cost (x) vs latency (y): both exist for every group, so the chart always has something to render before anyone customizes it.
- `column_layout` (ColumnLayout, optional, nullable) — Saved column order and column visibility for the experiment's evaluations table. Null when no layout has been saved, which is distinct from a saved layout that hides nothing.
- `is_favorite` (boolean, optional, default: false) — Whether this Experiment is marked as a favorite.
- `show_evaluations_over_time` (boolean, optional, default: false) — Whether Studio should display this Experiment's Evaluation results over time.
- `baseline_evaluation_name` (string, optional) — Name of this Experiment's selected baseline Evaluation, if any.
- `created_at` (datetime, optional)
- `updated_at` (datetime, optional)
- `evaluation_count` (integer, optional, default: 0) — Number of live (non-soft-deleted) evaluations in this experiment.

## Errors

### 400 Bad Request Error

The baseline Evaluation does not exist or is not a live member

- `any`

### 404 Not Found Error

Experiment not found

- `any`

### 409 Conflict Error

Attempt to rename the experiment

- `any`

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### ParetoConfig

Default X/Y metrics for a group's cost-vs-accuracy Pareto view. Metric ids use the same vocabulary as the evaluations list sort/filter fields — `cost_usd`, `latency_ms`, `tokens`, or `evaluators.<name>`. Defaults to cost (x) vs latency (y): both exist for every group, so the chart always has something to render before anyone customizes it.

- `x_metric` (string, optional, default: cost_usd) — Metric plotted on the Pareto X axis.
- `y_metric` (string, optional, default: latency_ms) — Metric plotted on the Pareto Y axis.

### ColumnLayout

A saved table layout for a group's evaluations list: column order and which columns are hidden. Column ids are Studio's and cannot be enumerated here — the table builds a column per evaluator and metadata key found in the rows — so ids are stored and echoed back unvalidated. Visibility is stored as the *hidden* ids rather than a map over every column, so a column that appears later (a new evaluator, a new metadata key) shows up by default.

- `order` (list of string, optional) — Column ids in display order. Empty means no saved order: the table falls back to its natural column order.
- `hidden` (list of string, optional) — Column ids hidden from the table. Any column not listed is shown.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (map from string to any, optional)

### ValidationErrorLocItems

## Examples

**Request**

```json
{
  "name": "string"
}
```

**Response**

```json
{
  "id": "string",
  "name": "string",
  "workspace": "string",
  "default_sort": "string",
  "description": "string",
  "insight_id": "string",
  "summary": "string",
  "metadata": {},
  "pareto": {
    "x_metric": "cost_usd",
    "y_metric": "latency_ms"
  },
  "column_layout": {
    "order": [
      "string"
    ],
    "hidden": [
      "string"
    ]
  },
  "is_favorite": false,
  "show_evaluations_over_time": false,
  "baseline_evaluation_name": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "evaluation_count": 0
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/apis/intake/v2/workspaces/workspace/experiments/name"

payload = { "name": "string" }
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/apis/intake/v2/workspaces/workspace/experiments/name';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/apis/intake/v2/workspaces/workspace/experiments/name"

	payload := strings.NewReader("{\n  \"name\": \"string\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/apis/intake/v2/workspaces/workspace/experiments/name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.example.com/apis/intake/v2/workspaces/workspace/experiments/name")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.example.com/apis/intake/v2/workspaces/workspace/experiments/name', [
  'body' => '{
  "name": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/apis/intake/v2/workspaces/workspace/experiments/name");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["name": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/apis/intake/v2/workspaces/workspace/experiments/name")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```