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

# Create a new issue

> Creates a new issue for tracking problems or improvements.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/avido/openapi.documented.yml post /v0/issues
openapi: 3.1.1
info:
  title: Avido API
  description: >-
    Avido's API for LLM usage events, tool calls, trace management, webhook
    validation, and more. See each endpoint's request/response schema for
    details.
  version: 0.1.0
  contact:
    name: Avido Support
    email: support@avidoai.com
    url: https://avidoai.com/support
servers:
  - url: https://api.avidoai.com
    description: Production API
security:
  - ApiKey: []
    ApplicationId: []
paths:
  /v0/issues:
    post:
      tags:
        - Issues
      summary: Create a new issue
      description: Creates a new issue for tracking problems or improvements.
      operationId: createIssue
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIssueRequest'
            examples:
              basic:
                summary: Basic issue creation
                value:
                  title: Response quality degradation
                  summary: The chatbot is providing incomplete responses
                  source: TEST
                  priority: HIGH
                  type: BUG
              withAssignment:
                summary: Create and assign issue
                value:
                  title: Critical performance issue
                  summary: System response time exceeds 5 seconds
                  source: MONITORING
                  priority: HIGH
                  type: BUG
                  status: OPEN
                  assignedTo: user_789012
                  traceId: trace_xyz789
      responses:
        '204':
          description: Successfully created issue
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Avido from 'avido';

            const client = new Avido({
              apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
              applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
            });

            await client.issues.create({
              source: 'TEST',
              title: 'Response quality degradation',
              priority: 'HIGH',
              type: 'BUG',
            });
        - lang: Python
          source: |-
            import os
            from avido import Avido

            client = Avido(
                api_key=os.environ.get("AVIDO_API_KEY"),  # This is the default and can be omitted
                application_id=os.environ.get("AVIDO_APPLICATION_ID"),  # This is the default and can be omitted
            )
            client.issues.create(
                source="TEST",
                title="Response quality degradation",
                priority="HIGH",
                type="BUG",
            )
components:
  schemas:
    CreateIssueRequest:
      type: object
      properties:
        title:
          type: string
          description: Title of the issue
          example: Response quality degradation
        description:
          description: Detailed description of the issue
          example: The chatbot is providing incomplete responses to user queries
          nullable: true
          type: string
        source:
          $ref: '#/components/schemas/IssueSource'
          description: Where the issue originated from
        priority:
          $ref: '#/components/schemas/IssuePriority'
          default: MEDIUM
          description: Priority level of the issue
          example: HIGH
        type:
          $ref: '#/components/schemas/IssueType'
          default: BUG
          description: Type/category of the issue
        topicId:
          description: Associated topic ID if issue came from a topic
          example: 789e4567-e89b-12d3-a456-426614174000
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        taskId:
          description: Associated task ID if issue came from a task
          example: 789e4567-e89b-12d3-a456-426614174000
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        testId:
          description: Associated test ID if issue came from a test
          example: 789e4567-e89b-12d3-a456-426614174000
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        evalDefinitionId:
          description: Associated evaluation definition ID if issue came from an evaluation
          example: 789e4567-e89b-12d3-a456-426614174000
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        annotationId:
          description: Associated annotation ID if related to an annotation
          example: 890e5678-e89b-12d3-a456-426614174000
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        traceId:
          description: Associated trace ID for monitoring/debugging
          example: trace_abc123
          type: string
        experimentId:
          description: Associated experiment ID to link issue to an experiment
          example: 789e4567-e89b-12d3-a456-426614174000
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        parentId:
          description: Parent issue ID for creating sub-issues
          example: 123e4567-e89b-12d3-a456-426614174000
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      required:
        - title
        - source
      additionalProperties: false
      title: CreateIssueRequest
      description: Request body for creating a new issue
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message explaining the error.
          example: Resource not found
      required:
        - message
      additionalProperties: false
      title: ErrorResponse
      description: Standard error format for failed API operations.
    ValidationErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message indicating what went wrong.
          example: Invalid request data
        issues:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              path:
                type: array
                items:
                  type: string
            required:
              - code
              - message
              - path
            additionalProperties: false
          description: Array of detailed validation error objects.
          example:
            - code: invalid_string
              message: Invalid UUID
              path:
                - id
      required:
        - message
        - issues
      additionalProperties: false
      title: ValidationErrorResponse
      description: Details about validation errors in incoming requests.
    IssueSource:
      type: string
      enum:
        - TEST
        - TASK
        - TOPIC
        - SYSTEM
        - MONITORING
        - API
        - HUMAN_ANNOTATION
      description: The source where the issue was created from
      example: TEST
    IssuePriority:
      type: string
      enum:
        - LOW
        - MEDIUM
        - HIGH
      description: The priority level of the issue
      example: MEDIUM
    IssueType:
      type: string
      enum:
        - BUG
        - HUMAN_ANNOTATION
        - SUGGESTED_TASK
        - USER_SIGNAL
      description: The type/category of the issue
      example: BUG
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your unique Avido API key
    ApplicationId:
      type: apiKey
      in: header
      name: x-application-id
      description: Your unique Avido Application ID

````