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

# List Annotations

> Query annotations with optional filters.



## OpenAPI

````yaml post /v1/annotations/list
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/annotations/list:
    post:
      tags:
        - Annotations
      summary: List Annotations
      description: Query annotations with optional filters.
      operationId: list_annotations_v1_annotations_list_post
      parameters:
        - name: skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            title: Skip
            default: 0
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            default: 50
            title: Limit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAnnotationsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAnnotationsResponse'
        '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'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ListAnnotationsRequest:
      properties:
        document_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Document Id
          description: Filter by document.
        collection_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Collection Id
          description: Filter by collection.
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
          description: Filter by label.
        actor_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Actor Id
          description: Filter by who annotated.
        retriever_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Retriever Id
          description: Filter by retriever.
      type: object
      title: ListAnnotationsRequest
      description: Query parameters for listing annotations.
    ListAnnotationsResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/AnnotationResponse'
          type: array
          title: Results
        total_count:
          type: integer
          title: Total Count
          default: 0
      type: object
      title: ListAnnotationsResponse
      description: Paginated annotation list.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AnnotationResponse:
      properties:
        annotation_id:
          type: string
          title: Annotation Id
          description: Unique annotation identifier.
        document_id:
          type: string
          title: Document Id
          description: The document this annotation is attached to.
        collection_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Collection Id
          description: Collection the document belongs to.
        namespace_id:
          type: string
          title: Namespace Id
          description: Namespace scope.
        label:
          type: string
          maxLength: 100
          minLength: 1
          title: Label
          description: >-
            Human decision label. Domain-specific — e.g. 'approved', 'rejected',
            'deferred', 'infringement', 'safe', 'confirmed_dupe'.
        confidence:
          anyOf:
            - type: number
              maximum: 1
              minimum: 0
            - type: 'null'
          title: Confidence
          description: Human confidence in this decision (0.0–1.0).
        reasoning:
          anyOf:
            - type: string
              maxLength: 5000
            - type: 'null'
          title: Reasoning
          description: Why this decision was made. Stored for audit trail.
        payload:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Payload
          description: >-
            Use-case-specific structured data. E.g. {'codes_approved':
            ['E11.40'], 'raf_impact': 0.302}
        retriever_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Retriever Id
          description: Retriever that produced the document being annotated.
        execution_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Execution Id
          description: Retriever execution ID.
        stage_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Stage Name
          description: Stage that produced the result (e.g. 'llm_enrich').
        actor_id:
          type: string
          title: Actor Id
          description: Who made the annotation (user ID or API key ID).
          default: system
        actor_type:
          type: string
          title: Actor Type
          description: 'Actor type: ''user'', ''api_key'', or ''system''.'
          default: system
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - document_id
        - namespace_id
        - label
      title: AnnotationResponse
      description: Single annotation response.
      examples:
        - actor_id: user_eric
          actor_type: user
          annotation_id: ann_abc123def4567890
          collection_id: col_notes
          confidence: 0.95
          document_id: doc_xyz
          label: approved
          namespace_id: ns_vitae
          payload:
            codes_approved:
              - E11.40
              - E11.65
            raf_impact: 0.42
          reasoning: Note clearly documents peripheral neuropathy.
          retriever_id: ret_hcc_review
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````