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

# List uploaded conversation comments

> Read transcript comments for this conversation, including conversation-level comments (message_index -1) and threaded replies. These are separate from metric review annotations and reviewer_notes. Results are ordered by create_time then id. Follow next_page_token until null. Pages form a live traversal: newly inserted comments can appear and deleted comments disappear; the export is not a frozen snapshot. Requires comments:read. The authenticated workspace must have access to the conversation and its comments.



## OpenAPI

````yaml /api-reference/v1/conversations-v1.yaml get /conversations/uploaded/{conversation_id}/comments
openapi: 3.0.3
info:
  title: Coval Uploaded Conversations API
  version: 1.0.0
  description: |

    Submit and manage conversation evaluations.
  contact:
    name: Coval API Support
    email: support@coval.dev
    url: https://docs.coval.ai
  license:
    name: Proprietary
    url: https://coval.dev/terms
servers:
  - url: https://api.coval.dev/v1
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Uploaded Conversations
    description: Submit and manage uploaded conversation evaluations
  - name: Audio
    description: Upload audio for evaluation and access conversation audio files
  - name: Conversation Comments
    description: Read saved transcript comments belonging to this conversation.
paths:
  /conversations/uploaded/{conversation_id}/comments:
    get:
      tags:
        - Conversation Comments
      summary: List uploaded conversation comments
      description: >-
        Read transcript comments for this conversation, including
        conversation-level comments (message_index -1) and threaded replies.
        These are separate from metric review annotations and reviewer_notes.
        Results are ordered by create_time then id. Follow next_page_token until
        null. Pages form a live traversal: newly inserted comments can appear
        and deleted comments disappear; the export is not a frozen snapshot.
        Requires comments:read. The authenticated workspace must have access to
        the conversation and its comments.
      operationId: listUploadedConversationComments
      parameters:
        - name: X-Coval-Workspace-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            Workspace ID. When omitted, the API resolves the default workspace.
            Only the default workspace includes legacy comments without
            workspace attribution.
        - name: conversation_id
          in: path
          required: true
          schema:
            type: string
          description: ID of the uploaded conversation.
        - name: page_size
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Maximum comments per page.
        - name: page_token
          in: query
          schema:
            type: string
            minLength: 1
            maxLength: 4096
          description: >-
            Opaque next_page_token from the previous response. Keep the same
            conversation and workspace.
      responses:
        '200':
          description: >-
            Comments retrieved. An accessible conversation with no comments
            returns an empty list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConversationCommentsResponse'
        '400':
          description: Invalid query, pagination token or path parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Missing comments:read permission or workspace context.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Conversation or comment not found or inaccessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            Database routing unavailable or the read exceeded its database time
            budget. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ListConversationCommentsResponse:
      properties:
        comments:
          items:
            $ref: '#/components/schemas/TranscriptCommentResource'
          type: array
        next_page_token:
          description: Token for the next page, or null when the traversal is complete.
          type: string
          nullable: true
      required:
        - comments
        - next_page_token
      type: object
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Error code
              enum:
                - INVALID_ARGUMENT
                - UNAUTHENTICATED
                - NOT_FOUND
                - ALREADY_EXISTS
                - PAYLOAD_TOO_LARGE
                - INTERNAL_ERROR
              example: INVALID_ARGUMENT
            message:
              type: string
              description: Human-readable error message
              example: Missing required input data
            details:
              type: array
              items:
                $ref: '#/components/schemas/ErrorDetail'
              description: Additional error details
              default: []
    TranscriptCommentResource:
      properties:
        name:
          description: 'Resource name: conversations/{type}/{conversation_id}/comments/{id}.'
          type: string
        id:
          description: Stable comment ID.
          type: string
        conversation_id:
          description: ID of the simulated or uploaded conversation.
          type: string
        content:
          description: Saved comment text.
          type: string
        message_index:
          description: >-
            Zero-based transcript message index; -1 denotes a conversation-level
            comment.
          type: integer
        selected_text:
          description: Selected transcript text, or null when no text is selected.
          type: string
          nullable: true
        text_start_offset:
          description: >-
            Start character offset in the selected message, or null when
            unanchored.
          type: integer
          nullable: true
        text_end_offset:
          description: Exclusive end character offset, or null when unanchored.
          type: integer
          nullable: true
        created_by:
          description: Stored author attribution.
          type: string
        created_by_name:
          description: Stored author display name, or null when unavailable.
          type: string
          nullable: true
        create_time:
          description: Time the comment was created.
          format: date-time
          type: string
        update_time:
          description: Time the comment was last saved.
          format: date-time
          type: string
        parent_comment_id:
          description: Parent comment ID for a reply, or null for a root comment.
          type: string
          nullable: true
      required:
        - name
        - id
        - conversation_id
        - content
        - message_index
        - selected_text
        - text_start_offset
        - text_end_offset
        - created_by
        - created_by_name
        - create_time
        - update_time
        - parent_comment_id
      type: object
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
          description: Field that caused the error
          example: transcript
        description:
          type: string
          description: Detailed description of the error
          example: At least one of transcript, audio, or audio_url must be provided
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        API key for authentication.

````

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