API Reference
DashboardGet API keyAPI key

Getting started

  • Introduction
  • Authentication
  • Errors & rate limits

Voice agents

    • Overview
    • GETList agents
    • GETGet agent
    • POSTCreate agent
    • PATCHUpdate agent
    • DELDelete agent

WhatsApp agents

Workspace

Voice agentsAgents

List agents

Returns every agent in your workspace.

GET/v2/agents

Authorization

  • Authorizationstringheaderrequired

    Bearer authentication header of the form Bearer <api_key>, where <api_key> is a key from Account Settings → API keys in your dashboard.

Response

An array of agent objects. Each item is described in the agent object.

Request
curl --request GET \
  --url 'https://api.tarangnow.com/v2/agents' \
  --header 'Authorization: Bearer <api_key>'
Response
[
  {
    "id": "3f6c2b1e-8a4d-4c5e-9b2a-1d7e6f8a9b0c",
    "tenant_id": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
    "number_id": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
    "whatsapp_account_id": null,
    "system_prompt": "#SECTION 1: IDENTITY AND DEMEANOUR\n\nAgent Name: Priya\nGender: Female\n\nPriya is a loan advisor on behalf of Acme Finance in the banking industry...",
    "description": "Qualify inbound home-loan leads and book a callback with an advisor.",
    "agent_name": "Priya",
    "industry": "Banking",
    "designation": "Loan advisor",
    "company_name": "Acme Finance",
    "llm_provider": "openai",
    "llm_model": "gpt-4o-mini",
    "llm_temperature": 0.7,
    "llm_max_token": 350,
    "llm_credential_id": null,
    "whatsapp_llm_provider": "openai",
    "whatsapp_llm_model": "gpt-4o-mini",
    "whatsapp_llm_temperature": 0.7,
    "whatsapp_llm_max_token": 350,
    "stt_provider": "deepgram",
    "stt_model": "nova-3",
    "stt_credential_id": null,
    "tts_provider": "elevenlabs",
    "tts_voice": "21m00Tcm4TlvDq8ikWAM",
    "tts_model": "eleven_flash_v2_5",
    "tts_language": "en",
    "tts_credential_id": null,
    "tone": "Warm & professional",
    "greeting_message": "Hi, this is Priya from Acme Finance. How can I help you today?",
    "outbound_greeting_message": "",
    "guardrails": "Never quote final interest rates. Never ask for OTPs or passwords.",
    "conversation_flow": [
      "Greet and confirm the caller's name",
      "Ask about the loan amount and city",
      "Offer a callback slot"
    ],
    "closing_message": "Thanks for calling Acme Finance. Have a great day!",
    "hangup_prompt": null,
    "background_sound": "none",
    "set_inbound_number": "+918031234567",
    "set_inbound_whatsapp_number": null,
    "post_call_whatsapp_template_name": null,
    "post_call_whatsapp_template_language": null,
    "post_call_whatsapp_template_params": [],
    "language": "english",
    "stt_lang_code": "en-IN",
    "is_active": true,
    "created_at": "2026-10-20T09:15:42.120Z",
    "updated_at": "2026-10-24T14:03:11.508Z"
  }
]
PreviousAgents overviewNextGet agent