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

# List Assistants



## OpenAPI

````yaml /openapi.json get /api/assistants
openapi: 3.1.0
info:
  description: >-
    Build and run voice assistants: configure an assistant, give it tools,
    knowledge and playbooks, place and read calls, and manage contacts,
    campaigns and analytics.


    Authenticate every request with an API key as a bearer token. See the API
    introduction for the response envelope, pagination and error shapes.
  title: Qall API
  version: 0.1.0
servers:
  - description: Production
    url: https://qall.io
security: []
paths:
  /api/assistants:
    get:
      tags:
        - assistants
      summary: List Assistants
      operationId: list_assistants_api_assistants_get
      parameters:
        - in: query
          name: page
          required: false
          schema:
            default: 1
            minimum: 1
            title: Page
            type: integer
        - in: query
          name: per_page
          required: false
          schema:
            default: 24
            maximum: 200
            minimum: 1
            title: Per Page
            type: integer
        - in: query
          name: search
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Search
        - description: active | inactive
          in: query
          name: status
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: active | inactive
            title: Status
        - description: name | created_at
          in: query
          name: sort_by
          required: false
          schema:
            default: name
            description: name | created_at
            title: Sort By
            type: string
        - description: asc | desc
          in: query
          name: sort_order
          required: false
          schema:
            default: asc
            description: asc | desc
            title: Sort Order
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_AssistantResponse_'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    PaginatedResponse_AssistantResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AssistantResponse'
          title: Items
          type: array
        page:
          title: Page
          type: integer
        pages:
          title: Pages
          type: integer
        per_page:
          title: Per Page
          type: integer
        total:
          title: Total
          type: integer
      required:
        - items
        - total
        - page
        - per_page
        - pages
      title: PaginatedResponse[AssistantResponse]
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AssistantResponse:
      description: Schema for assistant response.
      properties:
        assigned_documents:
          description: Assigned document IDs (sync list)
          items:
            type: integer
          title: Assigned Documents
          type: array
        assigned_tools:
          description: Assigned tool IDs (enabled).
          items:
            type: integer
          title: Assigned Tools
          type: array
        created_at:
          format: date-time
          title: Created At
          type: string
        custom_settings:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Custom Settings
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          title: Id
          type: integer
        idle_message:
          anyOf:
            - type: string
            - type: 'null'
          default: Are you still there? I'm here to help if you need anything.
          title: Idle Message
        idle_timeout:
          anyOf:
            - type: integer
            - type: 'null'
          title: Idle Timeout
        interruption_settings:
          $ref: '#/components/schemas/InterruptionSettings'
        is_active:
          anyOf:
            - type: boolean
            - type: 'null'
          default: true
          title: Is Active
        llm_fallback_providers:
          $ref: '#/components/schemas/LLMFallbackSettings'
        llm_provider:
          anyOf:
            - type: string
            - type: 'null'
          default: openai
          description: 'LLM provider: openai, anthropic, gemini, xai, groq, custom'
          title: Llm Provider
        llm_provider_config:
          $ref: '#/components/schemas/LLMProviderConfig'
          description: Configuration for the selected LLM provider.
        llm_settings:
          $ref: '#/components/schemas/LLMSettings'
        max_idle_messages:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Idle Messages
        name:
          title: Name
          type: string
        organization_id:
          title: Organization Id
          type: integer
        playbook_ids:
          anyOf:
            - items:
                type: integer
              type: array
            - type: 'null'
          title: Playbook Ids
        rag_settings:
          $ref: '#/components/schemas/RAGSettings'
        recording_settings:
          $ref: '#/components/schemas/RecordingSettings'
        stt_settings:
          $ref: '#/components/schemas/STTSettings'
        tts_settings:
          $ref: '#/components/schemas/TTSSettings'
        updated_at:
          format: date-time
          title: Updated At
          type: string
        user_id:
          title: User Id
          type: integer
      required:
        - name
        - id
        - organization_id
        - user_id
        - created_at
        - updated_at
      title: AssistantResponse
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    InterruptionSettings:
      description: Settings for call interruption behavior.
      properties:
        allow_interruptions:
          default: true
          title: Allow Interruptions
          type: boolean
        allow_welcome_interruption:
          default: true
          title: Allow Welcome Interruption
          type: boolean
        false_interruption_timeout:
          default: 2
          title: False Interruption Timeout
          type: number
        min_interruption_duration:
          default: 0.5
          title: Min Interruption Duration
          type: number
        min_interruption_words:
          default: 1
          title: Min Interruption Words
          type: integer
        resume_false_interruption:
          default: true
          title: Resume False Interruption
          type: boolean
      title: InterruptionSettings
      type: object
    LLMFallbackSettings:
      description: Settings for LLM fallback providers.
      properties:
        enabled:
          default: false
          title: Enabled
          type: boolean
        fallbacks:
          items:
            $ref: '#/components/schemas/LLMFallbackProvider'
          title: Fallbacks
          type: array
      title: LLMFallbackSettings
      type: object
    LLMProviderConfig:
      description: Configuration for the LLM provider.
      properties:
        base_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Url
        custom_config:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Custom Config
        model:
          anyOf:
            - type: string
            - type: 'null'
          default: gpt-4o-mini
          title: Model
      title: LLMProviderConfig
      type: object
    LLMSettings:
      description: Settings for the Large Language Model.
      properties:
        frequency_penalty:
          default: 0
          title: Frequency Penalty
          type: number
        max_tokens:
          default: 1000
          title: Max Tokens
          type: integer
        presence_penalty:
          default: 0
          title: Presence Penalty
          type: number
        stop_sequences:
          items:
            type: string
          title: Stop Sequences
          type: array
        system_prompt:
          anyOf:
            - type: string
            - type: 'null'
          default: >-
            You are a helpful assistant that can answer questions and help with
            tasks.
          title: System Prompt
        temperature:
          default: 0.5
          title: Temperature
          type: number
        top_p:
          default: 1
          title: Top P
          type: number
        welcome_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Welcome Message
      title: LLMSettings
      type: object
    RAGSettings:
      description: Settings for Retrieval-Augmented Generation (RAG).
      properties:
        auto_process:
          default: true
          title: Auto Process
          type: boolean
        chunk_overlap:
          default: 200
          title: Chunk Overlap
          type: integer
        chunk_size:
          default: 1000
          title: Chunk Size
          type: integer
        chunking_strategy:
          default: recursive
          title: Chunking Strategy
          type: string
        context_budget:
          default: 8000
          title: Context Budget
          type: integer
        context_window_tokens:
          default: 4000
          title: Context Window Tokens
          type: integer
        embedding_model:
          default: text-embedding-3-small
          title: Embedding Model
          type: string
        enabled:
          default: false
          title: Enabled
          type: boolean
        history_strategy:
          default: sliding_window
          title: History Strategy
          type: string
        include_metadata:
          default: true
          title: Include Metadata
          type: boolean
        max_history_turns:
          default: 20
          title: Max History Turns
          type: integer
        max_prompt_doc_tokens:
          default: 2000
          title: Max Prompt Doc Tokens
          type: integer
        search_limit:
          default: 3
          title: Search Limit
          type: integer
        similarity_threshold:
          default: 0.7
          title: Similarity Threshold
          type: number
      title: RAGSettings
      type: object
    RecordingSettings:
      description: 'Recording Settings '
      properties:
        consent_prompt:
          default: ''
          title: Consent Prompt
          type: string
        consent_required:
          default: false
          title: Consent Required
          type: boolean
        record_assistant_audio:
          default: true
          title: Record Assistant Audio
          type: boolean
        record_mixed_audio:
          default: true
          title: Record Mixed Audio
          type: boolean
        record_user_audio:
          default: true
          title: Record User Audio
          type: boolean
        recording_enabled:
          default: true
          title: Recording Enabled
          type: boolean
        recording_format:
          default: mp3
          title: Recording Format
          type: string
      title: RecordingSettings
      type: object
    STTSettings:
      description: Settings for Speech-to-Text (STT) service.
      properties:
        endpoint_latency_adjustment_level:
          anyOf:
            - maximum: 3
              minimum: 0
              type: integer
            - type: 'null'
          title: Endpoint Latency Adjustment Level
        endpoint_sensitivity:
          anyOf:
            - maximum: 1
              minimum: -1
              type: number
            - type: 'null'
          title: Endpoint Sensitivity
        keyterms:
          items:
            type: string
          title: Keyterms
          type: array
        language:
          default: en
          title: Language
          type: string
        language_hints:
          items:
            type: string
          title: Language Hints
          type: array
        model:
          anyOf:
            - type: string
            - type: 'null'
          default: nova-3
          title: Model
        provider:
          default: deepgram
          enum:
            - deepgram
            - soniox
            - openai
          title: Provider
          type: string
        punctuate:
          default: true
          title: Punctuate
          type: boolean
        smart_format:
          default: true
          title: Smart Format
          type: boolean
        turn_detection:
          $ref: '#/components/schemas/TurnDetectionSettings'
      title: STTSettings
      type: object
    TTSSettings:
      description: Settings for Text-to-Speech (TTS) service.
      properties:
        model_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Model Id
        provider:
          default: elevenlabs
          enum:
            - elevenlabs
            - cartesia
            - soniox
          title: Provider
          type: string
        provider_config:
          additionalProperties: true
          title: Provider Config
          type: object
        voice_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Voice Id
      title: TTSSettings
      type: object
    LLMFallbackProvider:
      description: Configuration for a single LLM fallback provider.
      properties:
        api_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Api Key
        base_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Url
        model:
          anyOf:
            - type: string
            - type: 'null'
          title: Model
        provider:
          title: Provider
          type: string
      required:
        - provider
      title: LLMFallbackProvider
      type: object
    TurnDetectionSettings:
      description: How end-of-turn is decided during a conversation.
      properties:
        max_endpointing_delay:
          default: 2.5
          title: Max Endpointing Delay
          type: number
        min_endpointing_delay:
          default: 0.3
          title: Min Endpointing Delay
          type: number
        mode:
          default: turn_detector
          enum:
            - turn_detector
            - text_turn_detector
          title: Mode
          type: string
      title: TurnDetectionSettings
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http

````

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