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

# Pin Experiment

POST https://host.com/apis/intake/v2/workspaces/{workspace}/experiments/{name}/pin

Pin an experiment to the top of the list (workspace-shared).

Re-pinning an already-pinned experiment refreshes ``pinned_at`` to the current timestamp,
which is intentional (most-recently-pinned sorts first).

Reference: https://docs.nvidia.com/nemo-platform/nemo-platform/documentation/reference/api-reference/experiments/pin-experiment-apis-intake-v-2-workspaces-workspace-experiments-name-pin-post

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: Nemo Platform API
  version: 1.0.0
paths:
  /apis/intake/v2/workspaces/{workspace}/experiments/{name}/pin:
    post:
      operationId: >-
        pin-experiment-apis-intake-v-2-workspaces-workspace-experiments-name-pin-post
      summary: Pin Experiment
      description: >-
        Pin an experiment to the top of the list (workspace-shared).


        Re-pinning an already-pinned experiment refreshes ``pinned_at`` to the
        current timestamp,

        which is intentional (most-recently-pinned sorts first).
      tags:
        - subpackage_experiments
      parameters:
        - name: workspace
          in: path
          required: true
          schema:
            type: string
        - name: name
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperimentResponse'
        '404':
          description: Experiment not found
          content:
            application/json:
              schema:
                description: Any type
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
servers:
  - url: https://host.com
    description: Default
components:
  schemas:
    EvaluatorAggregate:
      type: object
      properties:
        sum:
          type: number
          format: double
        mean:
          type: number
          format: double
        median:
          type: number
          format: double
        p90:
          type: number
          format: double
        p95:
          type: number
          format: double
        p99:
          type: number
          format: double
        count:
          type: integer
          default: 0
      description: >-
        Aggregate statistics over evaluator scores or session-level metric
        values.
      title: EvaluatorAggregate
    ExperimentResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        workspace:
          type: string
        experiment_group_id:
          type: string
          description: >-
            Entity id of the owning ExperimentGroup. Required for every
            Experiment.
        dataset_name:
          type: string
        dataset_version:
          type: string
        source_link:
          type: string
          format: uri
        metadata:
          type: object
          additionalProperties:
            description: Any type
        description:
          type: string
        summary:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        pinned_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Timestamp at which the experiment was pinned, or null if unpinned.
            Managed via POST/DELETE /experiments/{name}/pin.
        evaluator_names:
          type: array
          items:
            type: string
        model_names:
          type: array
          items:
            type: string
          description: >-
            Distinct model names observed across ingested sessions for this
            experiment.
        agent_names:
          type: array
          items:
            type: string
          description: >-
            Distinct agent names observed across ingested sessions for this
            experiment.
        agent_versions:
          type: array
          items:
            type: string
          description: >-
            Distinct agent versions observed across ingested sessions for this
            experiment.
        aggregate_scores:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/EvaluatorAggregate'
        run_count:
          type: integer
          default: 0
          description: >-
            Number of distinct ingested experiment sessions; one session is
            treated as one run.
        cost_usd:
          $ref: '#/components/schemas/EvaluatorAggregate'
        latency_ms:
          $ref: '#/components/schemas/EvaluatorAggregate'
      required:
        - id
        - name
        - workspace
        - experiment_group_id
        - dataset_name
      description: Experiment as served by the API, including ClickHouse-hydrated rollups.
      title: ExperimentResponse
    ValidationErrorLocItems:
      oneOf:
        - type: string
        - type: integer
      title: ValidationErrorLocItems
    ValidationError:
      type: object
      properties:
        loc:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
        input:
          description: Any type
        ctx:
          type: object
          additionalProperties:
            description: Any type
      required:
        - loc
        - msg
        - type
      title: ValidationError
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      title: HTTPValidationError

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "id": "exp-9f8b7c6d-1234-4a56-b789-0cdef1234567",
  "name": "Image Classification Experiment",
  "workspace": "vision-team",
  "experiment_group_id": "grp-4a5b6c7d-8901-4e23-b456-7fghijklmno8",
  "dataset_name": "ImageNet",
  "dataset_version": "2023.2",
  "source_link": "https://github.com/vision-team/image-classification",
  "metadata": {
    "framework": "PyTorch",
    "hardware": "NVIDIA A100",
    "notes": "Initial run with augmented data"
  },
  "description": "Experiment to evaluate ResNet50 on ImageNet with data augmentation.",
  "summary": "Achieved 76.5% top-1 accuracy with standard augmentation.",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "pinned_at": "2024-01-15T09:30:00Z",
  "evaluator_names": [
    "accuracy",
    "f1_score"
  ],
  "model_names": [
    "ResNet50"
  ],
  "agent_names": [
    "training-agent-v1"
  ],
  "agent_versions": [
    "1.3.0"
  ],
  "aggregate_scores": {
    "accuracy": {
      "sum": 7650,
      "mean": 0.765,
      "median": 0.766,
      "p90": 0.78,
      "p95": 0.79,
      "p99": 0.8,
      "count": 10000
    },
    "f1_score": {
      "sum": 7400,
      "mean": 0.74,
      "median": 0.742,
      "p90": 0.75,
      "p95": 0.76,
      "p99": 0.77,
      "count": 10000
    }
  },
  "run_count": 15,
  "cost_usd": {
    "sum": 120.5,
    "mean": 8.03,
    "median": 7.95,
    "p90": 10,
    "p95": 11,
    "p99": 12.5,
    "count": 15
  },
  "latency_ms": {
    "sum": 450000,
    "mean": 30000,
    "median": 29500,
    "p90": 35000,
    "p95": 36000,
    "p99": 40000,
    "count": 15
  }
}
```

**SDK Code**

```python
import requests

url = "https://host.com/apis/intake/v2/workspaces/workspace/experiments/name/pin"

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

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

print(response.json())
```

```javascript
const url = 'https://host.com/apis/intake/v2/workspaces/workspace/experiments/name/pin';
const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{}'};

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://host.com/apis/intake/v2/workspaces/workspace/experiments/name/pin"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", 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://host.com/apis/intake/v2/workspaces/workspace/experiments/name/pin")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

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.post("https://host.com/apis/intake/v2/workspaces/workspace/experiments/name/pin")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://host.com/apis/intake/v2/workspaces/workspace/experiments/name/pin")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```