Criar um Assistente

Crie um novo assistente de IA com a configuração especificada

POST https://app.mayahub.ai/api//user/assistant

Criar um Assistente

cURL

curl --request POST \
  --url https://app.mayahub.ai/api/user/assistant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_name": "<string>",
  "voice_id": 123,
  "language": "<string>",
  "llm_model": "<string>",
  "calls_direction": "<string>",
  "engine_type": "<string>",
  "timezone": "<string>",
  "initial_message": "<string>",
  "system_prompt": "<string>",
  "phone_number_id": 123,
  "endpoint_type": "<string>",
  "endpoint_sensitivity": 123,
  "interrupt_sensitivity": 123,
  "ambient_sound_volume": 123,
  "post_call_evaluation": true,
  "send_webhook_only_on_completed": true,
  "include_recording_in_webhook": true,
  "is_webhook_active": true,
  "webhook_url": "<string>",
  "use_min_interrupt_words": true,
  "min_interrupt_words": 123,
  "variables": {},
  "post_call_schema": [
    {
      "post_call_schema[].name": "<string>",
      "post_call_schema[].type": "<string>",
      "post_call_schema[].description": "<string>"
    }
  ],
  "end_call_tool.description": "<string>",
  "llm_temperature": 123,
  "voice_stability": 123,
  "voice_similarity": 123,
  "speech_speed": 123,
  "allow_interruptions": true,
  "filler_audios": true,
  "re_engagement_interval": 123,
  "max_call_duration": 123,
  "max_silence_duration": 123,
  "end_call_on_voicemail": true,
  "noise_cancellation": true,
  "record_call": true,
  "who_speaks_first": "<string>"
}
'

201 Success Response

{
  "message": "Assistant created successfully",
  "data": {
    "id": 789,
    "name": "Sales Assistant",
    "status": "active",
    "type": "outbound",
    "mode": "pipeline"
  }
}

Este endpoint permite criar um novo assistente de IA com opções de configuração completas.

Corpo da Requisição

Campos Principais Obrigatórios

assistant_name · string · required

O nome do assistente (máximo de 255 caracteres)

voice_id · integer · required

O ID da voz a ser usada pelo assistente (deve existir nas vozes disponíveis)

language · string · required

O nome do idioma do assistente (máximo de 100 caracteres)

llm_model · string · required

O nome do modelo LLM a ser utilizado (máximo de 100 caracteres)

calls_direction · string · required

O tipo de direção da chamada. Opções: receive (receber), make (realizar)

engine_type · string · required

O tipo de engine a ser utilizado. Opções: pipeline, multimodal

timezone · string · required

O fuso horário do assistente (ex.: “America/New_York”)

initial_message · string · required

A mensagem inicial que o assistente dirá quando a chamada começar

system_prompt · string · required

O system prompt que define o comportamento e a personalidade do assistente

Configuração Opicional

phone_number_id · integer

O ID de um número de telefone a ser atribuído ao assistente (deve existir nos números de telefone do usuário)

endpoint_type · string

Tipo de detecção de atividade de voz. Opções: vad, ai

endpoint_sensitivity · number

Nível de sensibilidade do endpoint (0-5)

interrupt_sensitivity · number

Nível de sensibilidade de interrupção (0-5)

ambient_sound_volume · number

Nível de volume do som ambiente (0-1)

post_call_evaluation · boolean

Indica se a avaliação pós-chamada deve ser ativada

send_webhook_only_on_completed · boolean

Indica se os webhooks devem ser enviados apenas em chamadas concluídas

include_recording_in_webhook · boolean

Indica se o URL da gravação deve ser incluído no payload do webhook

Configuração de Webhook

is_webhook_active · boolean

Indica se as notificações de webhook estão ativadas

webhook_url · string

A URL do webhook para notificações pós-chamada (obrigatória se is_webhook_active for verdadeiro)

Configurações de Interrupção

use_min_interrupt_words · boolean

Indica se deve usar a configuração de palavras mínimas de interrupção

min_interrupt_words · integer

Número mínimo de palavras antes que a interrupção seja permitida (0-10)

Variáveis e Esquema

variables · object

Pares de chave-valor de variáveis personalizadas para o assistente

post_call_schema · array

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

Show Propriedades do post_call_schema

post_call_schema[].name · string · required

O nome do campo do esquema (apenas caracteres alfanuméricos e underscores)

post_call_schema[].type · string · required

O tipo de dado. Opções: string, number, bool

post_call_schema[].description · string · required

Descrição do que este campo representa

Ferramenta de Encerrar Chamada

end_call_tool.description · string

Descrição da funcionalidade da ferramenta de encerramento de chamada (máximo de 500 caracteres)

Configurações de Voz e Fala

llm_temperature · number

Configuração de temperatura do LLM (0-1)

voice_stability · number

Configuração de estabilidade da voz (0-1)

voice_similarity · number

Configuração de similaridade da voz (0-1)

speech_speed · number

Multiplicador de velocidade da fala (0,7-1,2)

Configurações de Comportamento da Chamada

allow_interruptions · boolean

Indica se as interrupções do chamador são permitidas

filler_audios · boolean

Indica se deve usar áudio de preenchimento durante o processamento

re_engagement_interval · integer

Intervalo de reengajamento em segundos (7-600)

max_call_duration · integer

Duração máxima da chamada em segundos (20-1200)

max_silence_duration · integer

Duração máxima de silêncio em segundos (1-120)

end_call_on_voicemail · boolean

Indica se a chamada deve ser encerrada quando um correio de voz for detectado

noise_cancellation · boolean

Indica se a redução de ruído deve ser ativada

record_call · boolean

Indica se a chamada deve ser gravada

who_speaks_first · string

Quem fala primeiro na chamada. Opções: Assistente de IA, Cliente

Resposta

message · string

Mensagem de sucesso confirmando a criação do assistente

data · object

Show Propriedades

id · integer

O identificador único do assistente criado

name · string

O nome do assistente

status · string

O status atual do assistente

type · string

O Tipo do Assistente (inbound or outbound)

mode · string

O modo da engine (pipeline or multimodal)

Respostas de Erro

422 Validation Error

Show Respostas de Erro

message · string

Mensagem de erro indicando falha na validação

errors · object

Erros de validação detalhados para cada campo

500 Internal Server Error

Show Respostas de Erro

message · string

Mensagem de erro indicando falha na criação do assistente

201 Success Response

{
  "message": "Assistant created successfully",
  "data": {
    "id": 789,
    "name": "Sales Assistant",
    "status": "active",
    "type": "outbound",
    "mode": "pipeline"
  }
}

Observações

• Todos os campos obrigatórios devem ser fornecidos para a criação bem-sucedida do assistente.
• O assistente será criado com configurações padrão para quaisquer campos opcionais não especificados.
• A atribuição de número de telefone é opcional, mas o número deve pertencer ao usuário autenticado.
• A URL do webhook é obrigatória apenas quando is_webhook_active estiver configurado como verdadeiro.
• Os identificadores de voz e idioma devem corresponder às opções disponíveis no sistema.