Get | Phonic

from phonic import Phonic
client = Phonic(
    base_url="https://api.phonic.co/v1",
    api_key="YOUR_TOKEN_HERE"
)
client.agents.get(
    name_or_id="nameOrId",
    project="main"
)

{
  "agent": {
    "id": "agent_12cf6e88-c254-4d3e-a149-a7f1bdd22783",
    "name": "support-agent",
    "phone_numbers": [
      "string"
    ],
    "project": {
      "id": "proj_ad0334f1-2487-4155-9df3-abd8129b29ad",
      "name": "customer-support"
    },
    "timezone": "America/Los_Angeles",
    "voice_id": "grant",
    "audio_format": "pcm_44100",
    "audio_speed": 1,
    "background_noise_level": 0,
    "background_noise": null,
    "generate_welcome_message": false,
    "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"
    ],
    "tasks": [
      {
        "name": "Check Availability",
        "description": "Check if the appointment is available"
      },
      {
        "name": "Book Appointment",
        "description": "Book the appointment"
      }
    ],
    "no_input_poke_sec": 30,
    "no_input_poke_text": "Are you still there?",
    "no_input_end_conversation_sec": 180,
    "languages": [
      "en",
      "es"
    ],
    "boosted_keywords": [
      "Load ID",
      "dispatch"
    ],
    "configuration_endpoint": {
      "url": "https://api.example.com/config",
      "headers": {
        "Authorization": "Bearer token123"
      },
      "timeout_ms": 7000
    },
    "phone_number": "+1234567890"
  }
}

Returns an agent by name or ID.

Authentication

AuthorizationBearer

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

Bearer authentication header of the form `Bearer <PHONIC_API_KEY>`. Manage your API keys [here](https://phonic.co/api-keys).

Path parameters

nameOrIdstringRequired

The name or the ID of the agent to get.

Query parameters

projectstringOptionalDefaults to main

The name of the project containing the agent. Only used when nameOrId is a name.

Response

Success response

agentobject

Authentication

Path parameters

Query parameters

Response

Errors