VoxLink.ai

API Reference

List assistants

List all assistants for the authenticated user with pagination

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

Query Parameters

per_pageinteger

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

pageinteger

Page number (default: 1)

Response fields

dataarray

idinteger

  The unique identifier of the assistant

user_idinteger

  The ID of the user who owns this assistant

phone_number_idinteger

  The ID of the phone number assigned to the assistant

engine_idinteger

  Engine ID

synthesizer_idinteger

  Synthesizer ID

transcriber_idinteger

  Transcriber ID

voice_idinteger

  The ID of the voice used by the assistant

instance_idinteger

  The instance ID for the assistant

namestring

  The name of the assistant

variablesobject

  Custom variables defined for the assistant

post_call_evaluationboolean

  Whether post-call evaluation is enabled

fillersinteger

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

post_call_schemaarray

  Schema definition for post-call data extraction

namestring

      The name of the schema field

typestring

      The data type (string, number, bool)

descriptionstring

      Description of what this field represents

toolsarray

  Array of tools available to the assistant

is_webhook_activeboolean

  Whether webhook notifications are enabled

webhook_urlstring

  The webhook URL for post-call notifications

inbound_webhook_urlstring

  The webhook URL for inbound call notifications

languagestring

  Language

typestring

  The type of assistant (inbound or outbound)

statusstring

  The current status of the assistant (active or inactive)

max_durationinteger

  Maximum call duration in seconds

recordboolean

  Whether to record calls

initial_messagestring

  The initial message the assistant will speak

system_promptstring

  The system prompt that defines the assistant's behavior

flows_platform_idinteger

  ID for flows platform integration

timezonestring

  The timezone setting for the assistant

created_atstring

  The date and time when the assistant was created

updated_atstring

  The date and time when the assistant was last updated

max_silence_durationinteger

  Maximum silence duration in seconds before re-engagement

reengagement_intervalinteger

  Re-engagement interval in seconds

deleted_atstring

  Soft deletion timestamp (null if not deleted)

end_call_on_voicemailinteger

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

llm_temperaturestring

  LLM temperature setting as string

voice_stabilitystring

  Voice stability setting as string

voice_similaritystring

  Voice similarity setting as string

allow_interruptionsboolean

  Whether to allow caller interruptions

enable_noise_cancellationboolean

  Whether noise cancellation is enabled

endpoint_sensitivitynumber

  Endpoint sensitivity level

speech_speedstring

  Speech speed multiplier as string

endpoint_typestring

  Voice activity detection type (vad or ai)

wait_for_customerboolean

  Whether to wait for customer to speak first

modestring

  The engine mode (pipeline or multimodal)

language_idinteger

  The ID of the language used by the assistant

transcriber_provider_idinteger

  ID of the transcriber provider

synthesizer_provider_idinteger

  ID of the synthesizer provider

llm_model_idinteger

  ID of the LLM model used

multimodal_model_idinteger

  ID of the multimodal model used

ambient_soundstring

  Ambient sound setting

uuidstring

  Unique UUID for the assistant

send_webhook_only_on_completedboolean

  Whether to send webhooks only on completed calls

include_recording_in_webhookboolean

  Whether to include recording URL in webhook payload

interrupt_sensitivitynumber

  Interrupt sensitivity level

filler_configobject

  Configuration for filler audio responses

neutralarray

      Array of neutral filler responses

negativearray

      Array of negative filler responses

positivearray

      Array of positive filler responses

questionarray

      Array of question filler responses

knowledgebase_idinteger

  ID of the associated knowledge base

knowledgebase_modestring

  Knowledge base mode setting

min_interrupt_wordsinteger

  Minimum number of words before interruption is allowed

ambient_sound_volumestring

  Ambient sound volume level as string

widget_settingsobject

  Settings for web widget integration

current_pageinteger

The current page number

per_pageinteger

Number of items per page

totalinteger

Total number of assistants

last_pageinteger

The last page number

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

Related guides