List

GET

https://api.phonic.ai/v1/agents

GET

/v1/agents

from phonic import Phonic
client = Phonic(
    api_key="YOUR_TOKEN_HERE",
)
client.agents.list()

{
  "agents": [
    {
      "id": "agent_12cf6e88-c254-4d3e-a149-a7f1bdd22783",
      "name": "support-agent",
      "phone_numbers": [
        "+1234567890"
      ],
      "project": {
        "id": "proj_ad0334f1-2487-4155-9df3-abd8129b29ad",
        "name": "customer-support"
      },
      "timezone": "America/Los_Angeles",
      "voice_id": "sabrina",
      "audio_format": "pcm_44100",
      "audio_speed": 1,
      "background_noise_level": 0,
      "background_noise": null,
      "generate_welcome_message": false,
      "is_welcome_message_interruptible": true,
      "listen_only_inbound_enabled": false,
      "listen_only_inbound_message": null,
      "welcome_message": "Hi {{customer_name}}. How can I help you today?",
      "system_prompt": "You are an expert in {{subject}}. Be friendly, helpful and concise.",
      "template_variables": {
        "customer_name": {
          "default_value": "Sean"
        },
        "subject": {
          "default_value": "Chess"
        }
      },
      "tools": [
        "keypad_input"
      ],
      "built_in_tool_configs": {
        "tool_natural_conversation_ending": {
          "speech_before_tool_call": "suppressed"
        },
        "tool_choose_not_to_respond": {
          "respond_after_sec": 5
        }
      },
      "tasks": [
        {
          "name": "Check Availability",
          "description": "Check if the appointment is available"
        },
        {
          "name": "Book Appointment",
          "description": "Book the appointment"
        }
      ],
      "generate_no_input_poke_text": false,
      "no_input_poke_sec": 30,
      "no_input_poke_text": "Are you still there?",
      "no_input_end_conversation_sec": 180,
      "default_language": "en",
      "additional_languages": [
        "es"
      ],
      "multilingual_mode": "request",
      "push_to_talk": false,
      "intelligence_level": "standard",
      "boosted_keywords": [
        "Load ID",
        "dispatch"
      ],
      "pronunciation_dictionary": [
        {
          "word": "Phuket",
          "pronunciation": "Poo-ket"
        }
      ],
      "min_words_to_interrupt": 1,
      "configuration_endpoint": {
        "url": "https://api.example.com/config",
        "headers": {
          "Authorization": "Bearer token123"
        },
        "timeout_ms": 7000
      },
      "is_disabled": true,
      "phone_number": "+1234567890"
    }
  ]
}

Returns all agents in a project.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Query parameters

projectstringOptionalDefaults to main

The name of the project to list agents for.

Response

Success response

agentslist of objects

Errors

404

Not Found Error

500

Internal Server Error