> 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.

# List Annotations

GET /apis/intake/v2/workspaces/{workspace}/annotations

Reference: https://docs.nvidia.com/nemo-helix/v0.5.1/documentation/reference/api-reference/annotations/list-annotations-apis-intake-v-2-workspaces-workspace-annotations-get

## Request

### Path parameters

- `workspace` (string, required)

### Query parameters

- `page` (integer, optional, default: 1) — Page number.
- `page_size` (integer, optional, default: 10) — Page size.
- `sort` (enum, optional, default: -created_at)
  - Allowed values: `created_at`, `-created_at`
- `filter` (AnnotationFilter, optional) — Filter annotations by span_id, session_id, kind, name, created_by, and created_at range.

## Response

### 200

Successful Response

- `data` (list of Annotation, required)
- `pagination` (PaginationData, optional) — Pagination information.
- `sort` (string, optional) — The field on which the results are sorted.
- `filter` (map from string to any, optional) — Filtering information.

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### AnnotationFilter

- `span_id` (string, optional) — Return only annotations attached to this span.
- `session_id` (string, optional) — Return only annotations attached to this session.
- `kind` (enum, optional) — Return only annotations of this kind (`feedback`, `note`, `label`, or `metadata`).
  - Allowed values: `feedback`, `label`, `note`, `metadata`
- `name` (string, optional) — Return only `label` annotations with this `name` (e.g., `severity`, `helpfulness`).
- `value_text` (string, optional) — Return only annotations with this text value. For `feedback` annotations this is `positive` or `negative`; for `label` annotations with `value_type=text` this is the label's value.
- `value_numeric` (NumericFilter, optional) — Return only `label` annotations whose numeric value falls within the given range. Applies to labels with `value_type=numeric`.
- `created_by` (string, optional) — Return only annotations created by this user.
- `created_at` (DatetimeFilter, optional) — Return only annotations created within the given time range.

### Annotation

Discriminated annotation read response. The shape varies by `kind`.

- `kind`: `feedback` (FeedbackAnnotation)
  - `annotation_id` (string, required)
  - `created_at` (datetime, required)
  - `ingested_at` (datetime, required)
  - `session_id` (string, required)
  - `value` (enum, required) — Sentiment of the feedback.
    - Allowed values: `positive`, `negative`
  - `workspace` (string, required)
  - `created_by` (string, optional)
  - `span_id` (string, optional) — Id of the span this annotation applies to, or omitted for session-level annotations.
- `kind`: `label` (LabelAnnotation)
  - `annotation_id` (string, required)
  - `created_at` (datetime, required)
  - `ingested_at` (datetime, required)
  - `session_id` (string, required)
  - `value` (LabelAnnotationValue, required) — The label's value. A string when `value_type=text`, a number when `value_type=numeric`.
  - `value_type` (enum, required) — Whether `value` is a text label (`text`) or a number (`numeric`).
    - Allowed values: `text`, `numeric`
  - `workspace` (string, required)
  - `created_by` (string, optional)
  - `name` (string, optional) — Name identifying what the label measures, when set.
  - `span_id` (string, optional) — Id of the span this annotation applies to, or omitted for session-level annotations.
- `kind`: `metadata` (MetadataAnnotation)
  - `annotation_id` (string, required)
  - `created_at` (datetime, required)
  - `ingested_at` (datetime, required)
  - `metadata` (map from string to any, required) — The metadata key/value pairs.
  - `session_id` (string, required)
  - `workspace` (string, required)
  - `created_by` (string, optional)
  - `span_id` (string, optional) — Id of the span this annotation applies to, or omitted for session-level annotations.
- `kind`: `note` (NoteAnnotation)
  - `annotation_id` (string, required)
  - `created_at` (datetime, required)
  - `ingested_at` (datetime, required)
  - `session_id` (string, required)
  - `text` (string, required) — The note content.
  - `workspace` (string, required)
  - `created_by` (string, optional)
  - `span_id` (string, optional) — Id of the span this annotation applies to, or omitted for session-level annotations.

### PaginationData

- `page` (integer, required) — The current page number.
- `page_size` (integer, required) — The page size used for the query.
- `current_page_size` (integer, required) — The size for the current page.
- `total_pages` (integer, required) — The total number of pages.
- `total_results` (integer, required) — The total number of results.

### ValidationError

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

### NumericFilter

Range filter for numeric annotation values. At least one of `$gte` or `$lte` must be supplied — an empty `{}` is not a meaningful filter and is rejected.

- `$gte` (double, optional) — Include only values greater than or equal to this number.
- `$lte` (double, optional) — Include only values less than or equal to this number.

### DatetimeFilter

- `$gte` (datetime, optional) — Filter for results greater than or equal to this datetime.
- `$lte` (datetime, optional) — Filter for results less than or equal to this datetime.

### LabelAnnotationValue

The label's value. A string when `value_type=text`, a number when `value_type=numeric`.

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "data": [
    {
      "annotation_id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "string",
      "ingested_at": "2024-01-15T09:30:00Z",
      "kind": "string",
      "session_id": "string",
      "span_id": "string",
      "value": "positive",
      "workspace": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "current_page_size": 1,
    "total_pages": 1,
    "total_results": 1
  },
  "sort": "string",
  "filter": {}
}
```

**SDK Code**

```python
import requests

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

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.example.com/apis/intake/v2/workspaces/workspace/annotations';
const options = {method: 'GET'};

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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	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/annotations")

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

request = Net::HTTP::Get.new(url)

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.get("https://api.example.com/apis/intake/v2/workspaces/workspace/annotations")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/apis/intake/v2/workspaces/workspace/annotations');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/apis/intake/v2/workspaces/workspace/annotations");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/apis/intake/v2/workspaces/workspace/annotations")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```