Get annotations

Returns all annotations for project

GET /api/annotations

Python

Python

import requests

url = "https://app.langwatch.ai/api/annotations"

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

[
  {
    "id": "<string>",
    "projectId": "<string>",
    "traceId": "<string>",
    "comment": "<string>",
    "isThumbsUp": true,
    "userId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "email": "<string>"
  }
]

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Query Parameters

anchor · enum<string>

Which comments to return. Omitted returns every comment, including the ones left on a span, a field, an attribute or a message; "trace" returns only the comments about whole traces.

Available options: trace, all

Response

200

application/json

Annotation response

id · string

The ID of the annotation

projectId · string

The ID of the project

traceId · string

The ID of the trace

comment · string

The comment of the annotation

isThumbsUp · boolean

The thumbs up status of the annotation

userId · string

The ID of the user

createdAt · string

The created at of the annotation

updatedAt · string

The updated at of the annotation

email · string

The email of the user