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

# List Equos Characters.



## OpenAPI

````yaml https://api.equos.ai/docs/v3-json get /v3/characters
openapi: 3.0.0
info:
  title: Equos.ai API
  description: API documentation for Equos.ai live platform.
  version: '3.0'
  contact: {}
servers:
  - url: https://api.equos.ai
security: []
tags: []
paths:
  /v3/characters:
    get:
      tags:
        - Character
      summary: List Equos Characters.
      operationId: listCharacters
      parameters:
        - name: take
          required: false
          in: query
          schema:
            maximum: 50
            default: 20
            type: number
        - name: skip
          required: false
          in: query
          schema:
            minimum: 0
            default: 0
            type: number
        - name: client
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEquosCharactersResponse'
      security:
        - x-api-key: []
components:
  schemas:
    ListEquosCharactersResponse:
      type: object
      properties:
        skip:
          type: number
        take:
          type: number
        total:
          type: number
        characters:
          type: array
          items:
            $ref: '#/components/schemas/EquosCharacter'
      required:
        - skip
        - take
        - total
        - characters
    EquosCharacter:
      type: object
      properties:
        id:
          type: string
        organizationId:
          type: string
        client:
          type: string
          nullable: true
        name:
          type: string
        livekitIdentity:
          type: string
        search:
          type: boolean
        elevenlabsAgentId:
          type: string
          nullable: true
        faceId:
          type: string
          nullable: true
        voiceId:
          type: string
          nullable: true
        brainId:
          type: string
          nullable: true
        knowledgeBaseId:
          type: string
          nullable: true
        face:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EquosFace'
        voice:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EquosVoice'
        brain:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EquosBrain'
        knowledgeBase:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EquosKnowledgeBase'
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - organizationId
        - name
        - livekitIdentity
        - search
        - createdAt
        - updatedAt
    EquosFace:
      type: object
      properties:
        id:
          type: string
        identity:
          type: string
          enum:
            - tommy
        organizationId:
          type: string
        client:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        thumbnailUrl:
          type: string
          nullable: true
        referenceImgUrl:
          type: string
          nullable: true
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - identity
        - organizationId
        - createdAt
        - updatedAt
    EquosVoice:
      type: object
      properties:
        id:
          type: string
        organizationId:
          type: string
        client:
          type: string
          nullable: true
        identity:
          type: string
          enum:
            - Puck
            - Charon
            - Kore
            - Fenrir
            - Aoede
            - Leda
            - Orus
            - Zephyr
            - Sulafat
            - Sadachbia
            - Sadaltager
            - Vindemiatrix
            - Zubenelgenubi
            - Achird
            - Pulcherrima
            - Gacrux
            - Schedar
            - Alnilam
            - Achernar
            - Laomedeia
            - Rasalgethi
            - Algenib
            - Erinome
            - Despina
            - Algieba
            - Umbriel
            - Iapetus
            - Enceladus
            - Autonoe
            - Callirrhoe
        instructions:
          type: string
          nullable: true
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - organizationId
        - identity
        - createdAt
        - updatedAt
    EquosBrain:
      type: object
      properties:
        id:
          type: string
        organizationId:
          type: string
        client:
          type: string
          nullable: true
        instructions:
          type: string
        greetingMessage:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - organizationId
        - instructions
        - greetingMessage
        - createdAt
        - updatedAt
    EquosKnowledgeBase:
      type: object
      properties:
        id:
          type: string
        organizationId:
          type: string
        name:
          type: string
        description:
          type: string
        client:
          type: string
        documents:
          type: array
          items:
            $ref: '#/components/schemas/EquosDocument'
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - organizationId
        - name
        - description
        - documents
        - createdAt
        - updatedAt
    EquosDocument:
      type: object
      properties:
        id:
          type: string
        knowledgeBaseId:
          type: string
        name:
          type: string
        description:
          type: string
        size:
          type: number
        status:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - knowledgeBaseId
        - name
        - description
        - size
        - status
        - createdAt
        - updatedAt
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````