Listar assistentes

curl --request GET \
  --url https://api.example.com/user/assistants/get

import requests

url = "https://api.example.com/user/assistants/get"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/user/assistants/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/user/assistants/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/user/assistants/get"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/user/assistants/get")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/user/assistants/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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": "Assistente de Prospecção de Vendas",
      "variables": {
        "company_name": "Sua Empresa",
        "product_line": "Serviços Premium",
        "rep_name": "Assistente"
      },
      "post_call_evaluation": true,
      "fillers": 1,
      "post_call_schema": [
        {
          "name": "interest_level",
          "type": "string",
          "description": "Nível de interesse do cliente (alto, médio, baixo)"
        },
        {
          "name": "budget_qualified",
          "type": "bool",
          "description": "Indica se o prospect possui orçamento adequado"
        },
        {
          "name": "follow_up_date",
          "type": "string",
          "description": "Data preferencial para contato de follow-up"
        }
      ],
      "tools": [],
      "is_webhook_active": true,
      "webhook_url": "https://omnitechsolucoes.com.br/api/webhooks/sales-calls",
      "inbound_webhook_url": null,
      "language": null,
      "type": "outbound",
      "status": "active",
      "max_duration": 900,
      "record": true,
      "initial_message": "Olá, aqui é um assistente da Sua Empresa. Espero estar falando em um bom momento. Como você está hoje?",
      "system_prompt": "Você é um representante de vendas da Sua Empresa. Seja profissional, cordial e foque na qualificação de leads para serviços premium.",
      "flows_platform_id": null,
      "timezone": "America/Sao_Paulo",
      "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": [
          "Entendo.",
          "Compreendido.",
          "Certo.",
          "Ok.",
          "Perfeito."
        ],
        "negative": [
          "Entendo.",
          "Hmm.",
          "Certo.",
          "Ok."
        ],
        "positive": [
          "Excelente!",
          "Isso é ótimo!",
          "Maravilha!",
          "Perfeito!"
        ],
        "question": [
          "Deixe-me pensar...",
          "Boa pergunta.",
          "Hmm.",
          "Certo."
        ]
      },
      "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.omnitechsolucoes.com.br/api/user/assistants/get?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=5",
  "links": [
    {
      "url": null,
      "label": "&laquo; Anterior",
      "active": false
    },
    {
      "url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=2",
  "path": "https://app.omnitechsolucoes.com.br/api/user/assistants/get",
  "per_page": 10,
  "prev_page_url": null,
  "to": 10,
  "total": 47
}

GET

user

assistants

get

Listar assistentes

curl --request GET \
  --url https://api.example.com/user/assistants/get

import requests

url = "https://api.example.com/user/assistants/get"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/user/assistants/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/user/assistants/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/user/assistants/get"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/user/assistants/get")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/user/assistants/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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": "Assistente de Prospecção de Vendas",
      "variables": {
        "company_name": "Sua Empresa",
        "product_line": "Serviços Premium",
        "rep_name": "Assistente"
      },
      "post_call_evaluation": true,
      "fillers": 1,
      "post_call_schema": [
        {
          "name": "interest_level",
          "type": "string",
          "description": "Nível de interesse do cliente (alto, médio, baixo)"
        },
        {
          "name": "budget_qualified",
          "type": "bool",
          "description": "Indica se o prospect possui orçamento adequado"
        },
        {
          "name": "follow_up_date",
          "type": "string",
          "description": "Data preferencial para contato de follow-up"
        }
      ],
      "tools": [],
      "is_webhook_active": true,
      "webhook_url": "https://omnitechsolucoes.com.br/api/webhooks/sales-calls",
      "inbound_webhook_url": null,
      "language": null,
      "type": "outbound",
      "status": "active",
      "max_duration": 900,
      "record": true,
      "initial_message": "Olá, aqui é um assistente da Sua Empresa. Espero estar falando em um bom momento. Como você está hoje?",
      "system_prompt": "Você é um representante de vendas da Sua Empresa. Seja profissional, cordial e foque na qualificação de leads para serviços premium.",
      "flows_platform_id": null,
      "timezone": "America/Sao_Paulo",
      "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": [
          "Entendo.",
          "Compreendido.",
          "Certo.",
          "Ok.",
          "Perfeito."
        ],
        "negative": [
          "Entendo.",
          "Hmm.",
          "Certo.",
          "Ok."
        ],
        "positive": [
          "Excelente!",
          "Isso é ótimo!",
          "Maravilha!",
          "Perfeito!"
        ],
        "question": [
          "Deixe-me pensar...",
          "Boa pergunta.",
          "Hmm.",
          "Certo."
        ]
      },
      "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.omnitechsolucoes.com.br/api/user/assistants/get?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=5",
  "links": [
    {
      "url": null,
      "label": "&laquo; Anterior",
      "active": false
    },
    {
      "url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=2",
  "path": "https://app.omnitechsolucoes.com.br/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 da Resposta

data

array

Show propriedades

integer

Identificador único do assistente

user_id

integer

ID do usuário proprietário do assistente

phone_number_id

integer

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

engine_id

integer

ID da engine

synthesizer_id

integer

ID do sintetizador

transcriber_id

integer

ID do transcritor

voice_id

integer

ID da voz utilizada pelo assistente

instance_id

integer

ID da instância do assistente

name

string

Nome do assistente

variables

object

Variáveis personalizadas definidas para o assistente

post_call_evaluation

boolean

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

fillers

integer

Indica 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

Nome do campo do esquema

type

string

Tipo de dado (string, number, bool)

description

string

Descrição do que este campo representa

tools

array

Lista de ferramentas disponíveis para o assistente

is_webhook_active

boolean

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

webhook_url

string

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

inbound_webhook_url

string

URL do webhook para notificações de chamadas inbound

language

string

Idioma

type

string

Tipo do assistente (inbound ou outbound)

status

string

Status atual do assistente (active ou inactive)

max_duration

integer

Duração máxima da chamada em segundos

record

boolean

Indica se as chamadas serão gravadas

initial_message

string

Mensagem inicial que o assistente irá falar

system_prompt

string

Prompt de sistema que define o comportamento do assistente

flows_platform_id

integer

ID para integração com a plataforma de fluxos

timezone

string

Configuração de fuso horário do assistente

created_at

string

Data e hora de criação do assistente

updated_at

string

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

Timestamp de exclusão lógica (null se não excluído)

end_call_on_voicemail

integer

Indica se a chamada será encerrada ao detectar caixa postal (1 = sim, 0 = não)

llm_temperature

string

Configuração de temperatura do LLM em formato string

voice_stability

string

Configuração de estabilidade da voz em formato string

voice_similarity

string

Configuração de similaridade da voz em formato string

allow_interruptions

boolean

Indica se o chamador pode interromper

enable_noise_cancellation

boolean

Indica se o cancelamento de ruído está habilitado

endpoint_sensitivity

number

Nível de sensibilidade do endpoint

speech_speed

string

Multiplicador da velocidade da fala em formato string

endpoint_type

string

Tipo de detecção de atividade de voz (vad ou ai)

wait_for_customer

boolean

Indica se o assistente aguarda o cliente falar primeiro

mode

string

Modo da engine (pipeline ou multimodal)

language_id

integer

ID do idioma utilizado pelo assistente

transcriber_provider_id

integer

ID do provedor de transcrição

synthesizer_provider_id

integer

ID do provedor de sintetização

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

Indica se os webhooks serão enviados apenas para chamadas concluídas

include_recording_in_webhook

boolean

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

interrupt_sensitivity

number

Nível de sensibilidade de interrupção

filler_config

object

Configuração dos áudios de preenchimento

Show propriedades do filler_config

neutral

array

Lista de respostas de preenchimento neutras

negative

array

Lista de respostas de preenchimento negativas

positive

array

Lista de respostas de preenchimento positivas

question

array

Lista de respostas de preenchimento para perguntas

knowledgebase_id

integer

ID da base de conhecimento associada

knowledgebase_mode

string

Modo de operação da base de conhecimento

min_interrupt_words

integer

Número mínimo de palavras antes que a interrupção seja permitida

ambient_sound_volume

string

Nível de volume do som ambiente em formato string

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

current_page

integer

Número da página atual

per_page

integer

Quantidade de itens por página

total

integer

Número total de assistentes

last_page

integer

Número da última página

{
  "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": "Assistente de Prospecção de Vendas",
      "variables": {
        "company_name": "Sua Empresa",
        "product_line": "Serviços Premium",
        "rep_name": "Assistente"
      },
      "post_call_evaluation": true,
      "fillers": 1,
      "post_call_schema": [
        {
          "name": "interest_level",
          "type": "string",
          "description": "Nível de interesse do cliente (alto, médio, baixo)"
        },
        {
          "name": "budget_qualified",
          "type": "bool",
          "description": "Indica se o prospect possui orçamento adequado"
        },
        {
          "name": "follow_up_date",
          "type": "string",
          "description": "Data preferencial para contato de follow-up"
        }
      ],
      "tools": [],
      "is_webhook_active": true,
      "webhook_url": "https://omnitechsolucoes.com.br/api/webhooks/sales-calls",
      "inbound_webhook_url": null,
      "language": null,
      "type": "outbound",
      "status": "active",
      "max_duration": 900,
      "record": true,
      "initial_message": "Olá, aqui é um assistente da Sua Empresa. Espero estar falando em um bom momento. Como você está hoje?",
      "system_prompt": "Você é um representante de vendas da Sua Empresa. Seja profissional, cordial e foque na qualificação de leads para serviços premium.",
      "flows_platform_id": null,
      "timezone": "America/Sao_Paulo",
      "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": [
          "Entendo.",
          "Compreendido.",
          "Certo.",
          "Ok.",
          "Perfeito."
        ],
        "negative": [
          "Entendo.",
          "Hmm.",
          "Certo.",
          "Ok."
        ],
        "positive": [
          "Excelente!",
          "Isso é ótimo!",
          "Maravilha!",
          "Perfeito!"
        ],
        "question": [
          "Deixe-me pensar...",
          "Boa pergunta.",
          "Hmm.",
          "Certo."
        ]
      },
      "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.omnitechsolucoes.com.br/api/user/assistants/get?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=5",
  "links": [
    {
      "url": null,
      "label": "&laquo; Anterior",
      "active": false
    },
    {
      "url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://app.omnitechsolucoes.com.br/api/user/assistants/get?page=2",
  "path": "https://app.omnitechsolucoes.com.br/api/user/assistants/get",
  "per_page": 10,
  "prev_page_url": null,
  "to": 10,
  "total": 47
}

Autenticação

Obter assistentes outbound

Referência da API

Assistants

Calls

Mid Call Tools

Leads

Campaigns

SMS

Webhooks

Listar assistentes

Parâmetros de Consulta

Campos da Resposta

​Parâmetros de Consulta

​Campos da Resposta

Parâmetros de Consulta

Campos da Resposta