Retrieves detailed information about a specific assistant by its ID.
cURL
curl --request GET \ --url https://prod-api.ringg.ai/ca/api/v0/agent/{agent_id} \ --header 'X-API-KEY: <x-api-key>'
{ "agents": { "id": "830f767a-397e-4b39-82ff-235cd344e2f9", "agent_display_name": "Sales Assistant", "agent_type": "outbound", "whitelisted_domains": [ "https://www.ringg.ai", "https://example.com" ], "language": "en-US", "form_fields": [ { "key": "company_name", "value": "Ringg AI" }, { "key": "product", "value": "AI calling platform" } ], "voice": { "id": "3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d", "name": "Sarah", "voice_preview": "https://example.com/voice-preview.mp3" }, "agent_config": { "custom_variables": { "callee_name": "string", "mobile_number": "string" }, "agent_prompt": "You are a helpful sales assistant.", "intro_message": "Hello! I'm calling from Ringg AI." }, "knowledge_base_id": "7a9c2d5e-4f6b-1a2b-3c4d-5e6f7a8b9c0d", "knowledge_base_name": "Product FAQ", "template_name": "sales", "template_label": "Sales Agent", "template_icon": "💼", "created_at": "2024-12-16T13:03:29.947147+00:00", "updated_at": "2024-12-16T14:15:32.123456+00:00", "tools": [], "secondary_language": "hi-IN", "secondary_voice_id": "4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e", "template_type": "outbound" } }
(Required) Your Ringg AI API key.
(Required) ID of the assistant to retrieve.
Successful Response: Detailed information about the assistant.
The response is of type object.
object