Agents

Get agent details

Retrieve details of a specific agent including configuration settings

get/agents/{agentId}

Request

  • Base URL: https://api.telvana.com
  • URL: https://api.telvana.com/agents/{agentId}
  • Auth: API key in header x-api-key

Path parameters

agentIdstring required
Example:jm1u1cawc7dka1x84mrjvb4y

Unique identifier for the agent

Response

Agent retrieved successfully

Example response

{
  "data": {
    "id": "jm1u1cawc7dka1x84mrjvb4y",
    "name": "Customer Service Agent",
    "description": "Handles customer inquiries",
    "isActive": true,
    "inboundPrompt": "You are a helpful customer service agent...",
    "hasCallTransfer": true,
    "hasEndCall": true,
    "hasAutoInboundTransfer": false,
    "inboundTransferNumber": null,
    "isMultilingual": false,
    "hasBargeIn": true,
    "hasPostConversationWebhook": false,
    "postConversationWebhookUrl": null,
    "hasHints": false,
    "hints": null,
    "hasLanguage": true,
    "language": "en-US",
    "voiceId": "pNInz6obpgDQGcFmaJgB",
    "integrationIds": [],
    "phoneNumberId": "ph_abc123",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-15T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.