Logo
Platform Guide
API Reference
Platform Updates
Platform updates
Assistants

List assistants

List all assistants for the authenticated user with pagination

GET

/ user / assistants / get

This endpoint allows you to retrieve all AI assistants belonging to the authenticated user.

Query Parameters

per_page integer

Number of assistants per page (1-100, default: 10)

page integer

Page number (default: 1)

Response fields

data array

id integer

The unique identifier of the assistant

user_id integer

The ID of the user who owns this assistant

phone_number_id integer

The ID of the phone number assigned to the assistant

engine_id integer

Engine ID

synthesizer_id integer

Synthesizer ID

transcriber_id integer

Transcriber ID

voice_id integer

The ID of the voice used by the assistant

instance_id integer

The instance ID for the assistant

name string

The name of the assistant

variables object

Custom variables defined for the assistant

post_call_evaluation boolean

Whether post-call evaluation is enabled

fillers integer

Whether filler audio is enabled (1 = enabled, 0 = disabled)

post_call_schema array

Schema definition for post-call data extraction

name string

The name of the schema field

type string

The data type (string, number, bool)

description string

Description of what this field represents

tools array

Array of tools available to the assistant

is_webhook_active boolean

Whether webhook notifications are enabled

webhook_url string

The webhook URL for post-call notifications

inbound_webhook_url string

The webhook URL for inbound call notifications

language string

Language

type string

The type of assistant (inbound or outbound)

status string

The current status of the assistant (active or inactive)

max_duration integer

Maximum call duration in seconds

record boolean

Whether to record calls

initial_message string

The initial message the assistant will speak

system_prompt string

The system prompt that defines the assistant’s behavior

flows_platform_id integer

ID for flows platform integration

timezone string

The timezone setting for the assistant

created_at string

The date and time when the assistant was created

updated_at string

The date and time when the assistant was last updated

max_silence_duration integer

Maximum silence duration in seconds before re-engagement

reengagement_interval integer

Re-engagement interval in seconds

deleted_at string

Soft deletion timestamp (null if not deleted)

end_call_on_voicemail integer

Whether to end call when voicemail is detected (1 = yes, 0 = no)

llm_temperature string

LLM temperature setting as string

voice_stability string

Voice stability setting as string

voice_similarity string

Voice similarity setting as string

allow_interruptions boolean

Whether to allow caller interruptions

enable_noise_cancellation boolean

Whether noise cancellation is enabled

endpoint_sensitivity number

Endpoint sensitivity level

speech_speed string

Speech speed multiplier as string

endpoint_type string

Voice activity detection type (vad or ai)

wait_for_customer boolean

Whether to wait for customer to speak first

mode string

The engine mode (pipeline or multimodal)

language_id integer

The ID of the language used by the assistant

transcriber_provider_id integer

ID of the transcriber provider

synthesizer_provider_id integer

ID of the synthesizer provider

llm_model_id integer

ID of the LLM model used

multimodal_model_id integer

ID of the multimodal model used

ambient_sound string

Ambient sound setting

uuid string

Unique UUID for the assistant

send_webhook_only_on_completed boolean

Whether to send webhooks only on completed calls

include_recording_in_webhook boolean

Whether to include recording URL in webhook payload

interrupt_sensitivity number

Interrupt sensitivity level

filler_config object

Configuration for filler audio responses

neutral array

Array of neutral filler responses

negative array

Array of negative filler responses

positive array

Array of positive filler responses

question array

Array of question filler responses

knowledgebase_id integer

ID of the associated knowledge base

knowledgebase_mode string

Knowledge base mode setting

min_interrupt_words integer

Minimum number of words before interruption is allowed

ambient_sound_volume string

Ambient sound volume level as string

widget_settings object

Settings for web widget integration

current_page integer

The current page number

per_page integer

Number of items per page

total integer

Total number of assistants

last_page integer

The last page number

List assistants
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://call.otonistark.com.br/api/user/assistants/get?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://call.otonistark.com.br/api/user/assistants/get?page=5",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "https://call.otonistark.com.br/api/user/assistants/get?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://call.otonistark.com.br/api/user/assistants/get?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://call.otonistark.com.br/api/user/assistants/get?page=2",
  "path": "https://call.otonistark.com.br/api/user/assistants/get",
  "per_page": 10,
  "prev_page_url": null,
  "to": 10,
  "total": 47
}