find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/langwatch:langwatch-annotations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: LangWatch Annotations API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
- url: https://app.langwatch.ai
security:
- project_api_key: []
tags:
- name: Annotations
paths:
  /api/v1/annotations:
    get:
      operationId: getApiAnnotations
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Annotation'
                required:
                - data
                additionalProperties: false
      summary: List annotations in the caller’s project
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - annotations:view
      parameters:
      - in: query
        name: anchor
        schema:
          default: all
          type: string
          enum:
          - trace
          - all
      tags:
      - Annotations
  /api/v1/annotations/{id}:
    get:
      operationId: getApiAnnotationsId
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Annotation'
                required:
                - data
                additionalProperties: false
      summary: Get an annotation in the caller’s project
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - annotations:view
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
      tags:
      - Annotations
    patch:
      operationId: patchApiAnnotationsId
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Annotation'
                required:
                - data
                additionalProperties: false
      summary: Update an annotation in the caller’s project
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - annotations:manage
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  minLength: 1
                isThumbsUp:
                  type: boolean
                email:
                  type:
                  - string
                  - 'null'
              required:
              - comment
              - isThumbsUp
      tags:
      - Annotations
    delete:
      operationId: deleteApiAnnotationsId
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
                required:
                - status
                - message
                additionalProperties: false
      summary: Delete an annotation in the caller’s project
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - annotations:manage
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
      tags:
      - Annotations
  /api/v1/annotations/trace/{id}:
    get:
      operationId: getApiAnnotationsTraceId
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Annotation'
                required:
                - data
                additionalProperties: false
      summary: List annotations on a trace in the caller’s project
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - annotations:view
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
      - in: query
        name: anchor
        schema:
          default: all
          type: string
          enum:
          - trace
          - all
      tags:
      - Annotations
    post:
      operationId: postApiAnnotationsTraceId
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Annotation'
                required:
                - data
                additionalProperties: false
      summary: Create an unattributed annotation on a trace
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - annotations:create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  minLength: 1
                isThumbsUp:
                  type: boolean
                email:
                  type:
                  - string
                  - 'null'
              required:
              - comment
              - isThumbsUp
      tags:
      - Annotations
components:
  schemas:
    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'
    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: {}
  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.'
    admin_api_key:
      type: http
      scheme: bearer
      description: 'Admin API key for organization-level operations (managing projects, API keys). Create one in Settings > API Keys or via POST /api/api-keys. Format: sk-lw-{id}_{secret}.'
    scim_bearer:
      type: http
      scheme: bearer
      description: SCIM token for one organization's directory connection, created with POST /api/scim-tokens or in Settings > SCIM. It authenticates provisioning calls only, and stops working if the organization's Enterprise plan lapses.
    cli_access_token:
      type: http
      scheme: bearer
      description: The device session the LangWatch CLI holds after `langwatch login`. It acts as the person who signed in, in the organization they chose, and expires unless the CLI refreshes it.
    instance_admin_key:
      type: http
      scheme: bearer
      description: Instance administrator key, set as LANGWATCH_INSTANCE_ADMIN_API_KEY on a self-hosted deployment. It exists to create the first organization, before any organization key does; every other management API takes an organization key instead.
    internal_secret:
      type: http
      scheme: bearer
      description: The deployment's own shared secret, presented by another LangWatch service rather than by a customer. The families behind it are ingress-blocked; they are described so a self-hosted operator can see what the deployment talks to itself about.
x-provenance:
  method: harvested
  publisher: LangWatch
  source: https://app.langwatch.ai/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)