Atualizar assistente

Atualizar a configuração de um assistente de IA existente

PUT https://app.mayahub.ai/api//user/assistant/{id}

Atualizar assistente

cURL

curl --request PUT \
  --url https://app.mayahub.ai/api/user/assistant/{id} \
  --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>"
}
'

200 Success Response

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

Este endpoint permite atualizar a configuração de um assistente de IA existente.
Todos os campos são opcionais – forneça apenas os campos que deseja atualizar.

Parâmetros de caminho

id · integer · required

O identificador único do assistente a ser atualizado

Corpo da requisição

Campos principais

assistant_name · string

O nome do assistente (máx. 255 caracteres)

voice_id · integer

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

language · string

O nome do idioma do assistente (máx. 100 caracteres)

llm_model · string

O nome do modelo LLM a ser usado (máx. 100 caracteres)

calls_direction · string

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

engine_type · string

O tipo de motor a ser usado. Opções: pipeline, multimodal

timezone · string

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

initial_message · string

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

system_prompt · string

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

Optional Configuration

phone_number_id · integer

O ID de um número de telefone a ser atribuído ao assistente (defina como null para desatribuir)

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

Se deve habilitar a avaliação após a chamada

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

Configuração de Webhook

is_webhook_active · boolean

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

webhook_url · string

A URL do webhook para notificações após a chamada (pode ser definida como null para remover)

Configuração de Interrupção

use_min_interrupt_words · boolean

Se deve usar a configuração de palavras mínimas para 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 chave-valor de variáveis personalizadas para o assistente

post_call_schema · array

Definição do esquema para extração de dados após a 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

Chamada Terminada

end_call_tool.description · string

Descrição da funcionalidade da ferramenta de encerramento de chamada (máx. 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 de Chamada

allow_interruptions · boolean

Se deve permitir interrupções do chamador

filler_audios · boolean

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

Se deve encerrar a chamada quando um correio de voz for detectado

noise_cancellation · boolean

Se deve habilitar a redução de ruído

record_call · boolean

Se deve gravar a chamada

who_speaks_first · string

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

Respostas

message · string

Mensagem de sucesso confirmando a atualização do assistente

data · object

Show Propriedades

id · integer

Mensagem de sucesso confirmando a atualização do assistente.

name · string

O nome do assistente

status · string

O status atual do assistente

type · string

O tipo de assistente (inbound ou outbound)

mode · string

O modo do motor (pipeline ou multimodal)

Respostas de erro

404 Not Found

Show Respostas de erro

message · string

Mensagem de erro quando o assistente não é encontrado ou não pertence ao usuário autenticado

422 Validation Error

Show Respostas de erro

message · string

Mensagem de erro indicando falha na validação

errors · object

Erros detalhados de validação para cada campo

500 Internal Server Error

Show Respostas de Erro

message · string

Erros detalhados de validação para cada campo.

200 Success Response

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

Observações

• Apenas os campos fornecidos no corpo da requisição serão atualizados.
• Todas as regras de validação se aplicam da mesma forma que ao criar um assistente.
• Para remover a atribuição de um número de telefone, defina phone_number_id como null.
• Para desabilitar o webhook, defina webhook_url como null ou is_webhook_active como false.
• O assistente deve pertencer ao usuário autenticado para ser atualizado.