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

# List Messages

> Retrieve a list of messages with optional filtering



## OpenAPI

````yaml GET /messages/list
openapi: 3.1.0
info:
  title: duohub Retriever API
  description: >-
    Retrieve assisted or non-assisted memory from a duohub knowledge graph. For
    best performance, use the official `duohub` Python package.
  version: 1.0.0
servers:
  - url: https://api.duohub.ai
security:
  - APIKeyHeader: []
paths:
  /messages/list:
    get:
      tags:
        - Messages
      summary: List Messages
      description: Retrieve a list of messages with optional filtering
      operationId: listMessages
      parameters:
        - name: sessionID
          in: query
          required: false
          description: Filter messages by session ID
          schema:
            type: string
        - name: customerUserID
          in: query
          required: false
          description: Filter messages by customer user ID
          schema:
            type: string
        - name: role
          in: query
          required: false
          description: Filter messages by role
          schema:
            type: string
            enum:
              - norole
              - system
              - assistant
              - user
              - function
              - tool
        - name: limit
          in: query
          required: false
          description: Maximum number of messages to return
          schema:
            type: integer
            default: 10
        - name: nextToken
          in: query
          required: false
          description: Token for getting the next page of results
          schema:
            type: string
        - name: previousToken
          in: query
          required: false
          description: Token for getting the previous page of results
          schema:
            type: string
      responses:
        '200':
          description: Messages retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  messages:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Message unique identifier
                        sessionID:
                          type: string
                          description: Session ID
                        role:
                          type: string
                          enum:
                            - norole
                            - system
                            - assistant
                            - user
                            - function
                            - tool
                          description: Message role
                        content:
                          type: string
                          description: Message content
                        userID:
                          type: string
                          description: User ID
                        customerUserID:
                          type: string
                          description: Customer user ID
                          nullable: true
                        createdAt:
                          type: string
                          format: date-time
                          description: Creation timestamp
                        updatedAt:
                          type: string
                          format: date-time
                          description: Last update timestamp
                  nextToken:
                    type: string
                    description: Token for the next page of results
                    nullable: true
                  previousToken:
                    type: string
                    description: Token for the previous page of results
                    nullable: true
                  count:
                    type: integer
                    description: Number of messages in the current page
              example:
                messages:
                  - id: 123e4567-e89b-12d3-a456-426614174000
                    sessionID: 987fcdeb-51a2-43b7-91fa-987654321000
                    role: user
                    content: Hello, how can I help you today?
                    userID: d99e7428-40e1-7073-aa50-94cee086b518
                    customerUserID: cust-123
                    createdAt: '2024-01-01T00:00:00.000Z'
                    updatedAt: '2024-01-01T00:00:00.000Z'
                nextToken: >-
                  eyJpZCI6eyJTIjoiNDU2In0sInVwZGF0ZWRBdCI6eyJTIjoiMjAyNC0wMS0wMlQwMDowMDowMFoifX0=
                previousToken: null
                count: 1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                  status:
                    type: string
                    enum:
                      - bad_request
                required:
                  - error
                  - status
                example:
                  error: Invalid request format
                  status: bad_request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                  status:
                    type: string
                    enum:
                      - unauthorized
                required:
                  - error
                  - status
                example:
                  error: API key is required
                  status: unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                  status:
                    type: string
                    enum:
                      - forbidden
                required:
                  - error
                  - status
                example:
                  error: Invalid API key
                  status: forbidden
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                  status:
                    type: string
                    enum:
                      - internal server error
                required:
                  - error
                  - status
                example:
                  error: An error occurred while listing messages
                  status: internal server error
components:
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Your duohub API key. Type: str'

````