Listar assistentes

Listar todos os assistentes do usuário autenticado com paginação List all assistants for the authenticated user with pagination

GET /user/assistants/get

Listar assistentes

cURL

curl --request GET \
  --url https://app.mayahub.ai/api/user/assistants/get \
  --header 'Authorization: Bearer <token>'

200 Response

{
  "current_page": 1,
  "data": [
    {
      "id": 127,
      "user_id": 1,
      "phone_number_id": 45,
      "engine_id": null,
      "synthesizer_id": null,
      "transcriber_id": null,
      "voice_id": 8,
      "instance_id": 1,
      "name": "Sales Outreach Assistant",
      "variables": {
        "company_name": "Your Company",
        "product_line": "Premium Services",
        "rep_name": "Assistant"
      },
      "post_call_evaluation": true,
      "fillers": 1,
      "post_call_schema": [
        {
          "name": "interest_level",
          "type": "string",
          "description": "Customer's level of interest (high, medium, low)"
        },
        {
          "name": "budget_qualified",
          "type": "bool",
          "description": "Whether the prospect has adequate budget"
        },
        {
          "name": "follow_up_date",
          "type": "string",
          "description": "Preferred date for follow-up contact"
        }
      ],
      "tools": [],
      "is_webhook_active": true,
      "webhook_url": "https://yourcompany.com/api/webhooks/sales-calls",
      "inbound_webhook_url": null,
      "language": null,
      "type": "outbound",
      "status": "active",
      "max_duration": 900,
      "record": true,
      "initial_message": "Hi, this is an assistant from Your Company. I hope I'm catching you at a good time. How are you doing today?",
      "system_prompt": "You are a sales representative for Your Company. Be professional, friendly, and focus on qualifying leads for premium services.",
      "flows_platform_id": null,
      "timezone": "America/Los_Angeles",
      "created_at": "2025-07-15T14:32:15.000000Z",
      "updated_at": "2025-08-02T09:18:42.000000Z",
      "max_silence_duration": 25,
      "reengagement_interval": 45,
      "deleted_at": null,
      "end_call_on_voicemail": 1,
      "llm_temperature": "0.35",
      "voice_stability": "0.75",
      "voice_similarity": "0.85",
      "allow_interruptions": true,
      "enable_noise_cancellation": true,
      "endpoint_sensitivity": 1.8,
      "speech_speed": "1.10",
      "endpoint_type": "vad",
      "wait_for_customer": true,
      "mode": "pipeline",
      "language_id": 1,
      "transcriber_provider_id": null,
      "synthesizer_provider_id": null,
      "llm_model_id": 3,
      "multimodal_model_id": null,
      "ambient_sound": "office",
      "uuid": "a7b3c942-5f1e-4d28-8c59-2e4f7a8b9c3d",
      "send_webhook_only_on_completed": true,
      "include_recording_in_webhook": true,
      "interrupt_sensitivity": 1.2,
      "filler_config": {
        "neutral": [
          "I see.",
          "Understood.",
          "Right.",
          "Got it.",
          "Okay."
        ],
        "negative": [
          "I understand.",
          "Hmm.",
          "I see.",
          "Okay."
        ],
        "positive": [
          "Excellent!",
          "That's great!",
          "Wonderful!",
          "Perfect!"
        ],
        "question": [
          "Let me think...",
          "Good question.",
          "Hmm.",
          "Right."
        ]
      },
      "knowledgebase_id": 12,
      "knowledgebase_mode": "hybrid",
      "min_interrupt_words": 3,
      "ambient_sound_volume": "0.30",
      "widget_settings": {
        "theme": "modern",
        "color": "#2563eb",
        "position": "bottom-right"
      }
    }
  ],
  "first_page_url": "https://app.mayahub.ai/api/user/assistants/get?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://app.mayahub.ai/api/user/assistants/get?page=5",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "https://app.mayahub.ai/api/user/assistants/get?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://app.mayahub.ai/api/user/assistants/get?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://app.mayahub.ai/api/user/assistants/get?page=2",
  "path": "https://app.mayahub.ai/api/user/assistants/get",
  "per_page": 10,
  "prev_page_url": null,
  "to": 10,
  "total": 47
}

Este endpoint permite recuperar todos os assistentes de IA pertencentes ao usuário autenticado.

Parâmetros de consulta

per_page · integer

Número de assistentes por página (1-100, padrão: 10)

page · integer

Número da página (padrão: 1)

Campos de resposta

data · array

Show Propriedades

id · integer

O identificador único do assistente

user_id · integer

O ID do usuário que possui este assistente

phone_number_id · integer

O ID do número de telefone atribuído ao assistente

engine_id · integer

ID do motor (Engine ID)

synthesizer_id · integer

ID do sintetizador (Synthesizer ID)

transcriber_id · integer

ID do transcritor (Transcriber ID)

voice_id · integer

O ID da voz usada pelo assistente

instance_id · integer

O ID da voz usada pelo assistente

name · string

O nome do assistente

variables · object

Variáveis personalizadas definidas para o assistente

post_call_evaluation · boolean

Se a avaliação pós-chamada está habilitada

fillers · integer

Se o áudio de preenchimento está habilitado (1 = habilitado, 0 = desabilitado)

post_call_schema · array

Definição do esquema para extração de dados pós-chamada

Show Propriedades do `post_call_schema`

name · string

O nome do campo do esquema

type · string

O tipo de dado (string, number, bool)

description · string

Descrição do que este campo representa

tools · array

Array de ferramentas disponíveis para o assistente

is_webhook_active · boolean

Se as notificações do webhook estão habilitadas

webhook_url · string

A URL do webhook para notificações pós-chamada

inbound_webhook_url · string

A URL do webhook para notificações de chamadas recebidas

language · string

Linguagem

type · string

O tipo de assistente (recebimento ou envio)

status · string

O status atual do assistente (ativo ou inativo)

max_duration · integer

Duração máxima da chamada em segundos

record · boolean

Se as chamadas devem ser gravadas

initial_message · string

A mensagem inicial que o assistente irá falar

system_prompt · string

O prompt do sistema que define o comportamento do assistente

flows_platform_id · integer

ID para integração com a plataforma Flows

timezone · string

A configuração de fuso horário do assistente

created_at · string

A data e hora em que o assistente foi criado

updated_at · string

A data e hora da última atualização do assistente

max_silence_duration · integer

Duração máxima de silêncio em segundos antes do reengajamento

reengagement_interval · integer

Intervalo de reengajamento em segundos

deleted_at · string

Data e hora da exclusão suave (null se não excluído)

end_call_on_voicemail · integer

Se a chamada deve ser encerrada quando um correio de voz for detectado (1 = sim, 0 = não)

llm_temperature · string

Configuração de temperatura do LLM como string

voice_stability · string

Configuração de estabilidade da voz como string

voice_similarity · string

Configuração de similaridade da voz como string

allow_interruptions · boolean

Se deve permitir interrupções do chamador

enable_noise_cancellation · boolean

Se a redução de ruído está habilitada

endpoint_sensitivity · number

Nível de sensibilidade do endpoint

speech_speed · string

Multiplicador de velocidade da fala como string

endpoint_type · string

Tipo de detecção de atividade vocal (VAD ou AI)

wait_for_customer · boolean

Se deve esperar o cliente falar primeiro

mode · string

O modo do motor (pipeline ou multimodal)

language_id · integer

O ID do idioma usado pelo assistente

transcriber_provider_id · integer

ID do provedor de transcrição

synthesizer_provider_id · integer

ID do provedor de sintetizador

llm_model_id · integer

ID do modelo LLM utilizado

multimodal_model_id · integer

ID do modelo multimodal utilizado

ambient_sound · string

Configuração de som ambiente

uuid · string

UUID único do assistente

send_webhook_only_on_completed · boolean

Se deve enviar webhooks apenas em chamadas concluídas

include_recording_in_webhook · boolean

Se deve incluir a URL da gravação no payload do webhook

interrupt_sensitivity · number

Nível de sensibilidade a interrupções

filler_config · object

Configuração para respostas de áudio de preenchimento

Show Propriedades do `filler_config`

neutral · array

Array de respostas de preenchimento neutras

negative · array

Array de respostas de preenchimento negativas

positive · array

Array de respostas de preenchimento positivas

question · array

Array de respostas de preenchimento em forma de pergunta

knowledgebase_id · integer

ID da base de conhecimento associada

knowledgebase_mode · string

Configuração do modo da base de conhecimento

min_interrupt_words · integer

Número mínimo de palavras antes de permitir interrupção

ambient_sound_volume · string

Nível de volume do som ambiente como string

widget_settings · object

Configurações para integração com widget web

current_page · integer

Número da página atual

per_page · integer

Número de itens por página

total · integer

Número total de assistentes

last_page · integer

Número da última página

200 Response

{
  "current_page": 1,
  "data": [
    {
      "id": 127,
      "user_id": 1,
      "phone_number_id": 45,
      "engine_id": null,
      "synthesizer_id": null,
      "transcriber_id": null,
      "voice_id": 8,
      "instance_id": 1,
      "name": "Sales Outreach Assistant",
      "variables": {
        "company_name": "Your Company",
        "product_line": "Premium Services",
        "rep_name": "Assistant"
      },
      "post_call_evaluation": true,
      "fillers": 1,
      "post_call_schema": [
        {
          "name": "interest_level",
          "type": "string",
          "description": "Customer's level of interest (high, medium, low)"
        },
        {
          "name": "budget_qualified",
          "type": "bool",
          "description": "Whether the prospect has adequate budget"
        },
        {
          "name": "follow_up_date",
          "type": "string",
          "description": "Preferred date for follow-up contact"
        }
      ],
      "tools": [],
      "is_webhook_active": true,
      "webhook_url": "https://yourcompany.com/api/webhooks/sales-calls",
      "inbound_webhook_url": null,
      "language": null,
      "type": "outbound",
      "status": "active",
      "max_duration": 900,
      "record": true,
      "initial_message": "Hi, this is an assistant from Your Company. I hope I'm catching you at a good time. How are you doing today?",
      "system_prompt": "You are a sales representative for Your Company. Be professional, friendly, and focus on qualifying leads for premium services.",
      "flows_platform_id": null,
      "timezone": "America/Los_Angeles",
      "created_at": "2025-07-15T14:32:15.000000Z",
      "updated_at": "2025-08-02T09:18:42.000000Z",
      "max_silence_duration": 25,
      "reengagement_interval": 45,
      "deleted_at": null,
      "end_call_on_voicemail": 1,
      "llm_temperature": "0.35",
      "voice_stability": "0.75",
      "voice_similarity": "0.85",
      "allow_interruptions": true,
      "enable_noise_cancellation": true,
      "endpoint_sensitivity": 1.8,
      "speech_speed": "1.10",
      "endpoint_type": "vad",
      "wait_for_customer": true,
      "mode": "pipeline",
      "language_id": 1,
      "transcriber_provider_id": null,
      "synthesizer_provider_id": null,
      "llm_model_id": 3,
      "multimodal_model_id": null,
      "ambient_sound": "office",
      "uuid": "a7b3c942-5f1e-4d28-8c59-2e4f7a8b9c3d",
      "send_webhook_only_on_completed": true,
      "include_recording_in_webhook": true,
      "interrupt_sensitivity": 1.2,
      "filler_config": {
        "neutral": [
          "I see.",
          "Understood.",
          "Right.",
          "Got it.",
          "Okay."
        ],
        "negative": [
          "I understand.",
          "Hmm.",
          "I see.",
          "Okay."
        ],
        "positive": [
          "Excellent!",
          "That's great!",
          "Wonderful!",
          "Perfect!"
        ],
        "question": [
          "Let me think...",
          "Good question.",
          "Hmm.",
          "Right."
        ]
      },
      "knowledgebase_id": 12,
      "knowledgebase_mode": "hybrid",
      "min_interrupt_words": 3,
      "ambient_sound_volume": "0.30",
      "widget_settings": {
        "theme": "modern",
        "color": "#2563eb",
        "position": "bottom-right"
      }
    }
  ],
  "first_page_url": "https://app.mayahub.ai/api/user/assistants/get?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://app.mayahub.ai/api/user/assistants/get?page=5",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "https://app.mayahub.ai/api/user/assistants/get?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://app.mayahub.ai/api/user/assistants/get?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://app.mayahub.ai/api/user/assistants/get?page=2",
  "path": "https://app.mayahub.ai/api/user/assistants/get",
  "per_page": 10,
  "prev_page_url": null,
  "to": 10,
  "total": 47
}