LangWatch Bug Reports API

openapi: 3.2.0
info:
  title: LangWatch Bug Reports API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
- url: https://app.langwatch.ai
security:
- project_api_key: []
tags:
- name: Bug Reports
paths:
  /api/v1/bug-reports:
    post:
      operationId: submitBugReport
      responses:
        '200':
          description: Success
          content:
            application/json: {}
      description: 'released CLI and MCP builds parse the intake''s own bodies: { id } on 201, { error, details } on a rejected report, { error, code } on a named refusal'
      summary: File an issue report from a coding agent
      security:
      - {}
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                source:
                  type: string
                  enum:
                  - cli
                  - mcp
                kind:
                  type: string
                  enum:
                  - summary
                  - full_session
                title:
                  type: string
                  minLength: 1
                  maxLength: 300
                summary:
                  type: string
                  maxLength: 200000
                sessionData:
                  type: string
                  maxLength: 9000000
                sessionTruncated:
                  type: boolean
                agent:
                  type: string
                  maxLength: 100
                contactEmail:
                  type: string
                  maxLength: 320
                cliVersion:
                  type: string
                  maxLength: 50
                metadata:
                  type: object
                  propertyNames:
                    type: string
                    maxLength: 200
                  additionalProperties:
                    anyOf:
                    - type: string
                      maxLength: 2000
                    - type: number
                    - type: boolean
              required:
              - source
              - kind
              - title
      tags:
      - Bug Reports
components:
  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)