> ## Documentation Index
> Fetch the complete documentation index at: https://langwatch.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# Get annotations



## OpenAPI

````yaml GET /api/v1/annotations
openapi: 3.1.0
info:
  title: LangWatch API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/v1/annotations:
    get:
      summary: List annotations in the caller’s project
      operationId: getApiAnnotations
      parameters:
        - in: query
          name: anchor
          schema:
            default: all
            type: string
            enum:
              - trace
              - all
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Annotation'
                required:
                  - data
                additionalProperties: false
      security:
        - project_api_key: []
components:
  schemas:
    Annotation:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        projectId:
          type: string
          minLength: 1
        traceId:
          type: string
          minLength: 1
        userId:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
        email:
          type:
            - string
            - 'null'
        comment:
          type:
            - string
            - 'null'
        isThumbsUp:
          type:
            - boolean
            - 'null'
        scoreOptions:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
        expectedOutput:
          type:
            - string
            - 'null'
        anchorKind:
          type:
            - string
            - 'null'
        anchorId:
          type:
            - string
            - 'null'
        anchorPath:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - projectId
        - traceId
        - userId
        - email
        - comment
        - isThumbsUp
        - scoreOptions
        - expectedOutput
        - anchorKind
        - anchorId
        - anchorPath
        - createdAt
        - updatedAt
      additionalProperties: {}
    JsonValue:
      anyOf:
        - type: string
        - type: number
        - type: boolean
        - type: 'null'
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.