Agentic - Agents

Get agent by ID with complete configuration

Retrieve complete information about a specific AI agent including all settings, integrations, and connected resources.

Response Includes:

  • Agent configuration (name, type, system prompt)
  • Phone settings (voice, model, transcription, VoIP connections)
  • Email settings (if configured)
  • Language settings (primary and secondary languages)
  • Connected knowledge bases (full details)
  • Connected workflows (full details)
  • Appointment settings and calendars
  • Integration configurations
  • Dynamic variables
  • Node-based flow configuration (for node-based agents)

Use Cases:

  • View complete agent configuration for editing
  • Export agent settings for backup
  • Clone agent configuration to another agent
  • Audit agent settings and capabilities
  • Verify knowledge base and workflow connections
get/api/v1/agentic/agents/:id

Request

  • Base URL: https://api.voicelogica.ai
  • URL: https://api.voicelogica.ai/api/v1/agentic/agents/:id
  • Auth: API key in header x-api-key

Headers

x-api-keystring required

Your API key for authentication. Required for all endpoints.

x-company-idstring

Optional company ID for resellers. When provided, the API request will operate on behalf of the specified subsidiary company. The API key must have access to the specified company.

Response

Agent retrieved successfully

idstring required

Unique identifier

createdAtstring date-time required

Creation timestamp

activeboolean required

Whether the entity is active

createdBystring required

Name of the user who created the entity

createdByIdstring required

ID of the user who created the entity

modifiedAtstring date-time

ISO 8601 date string

modifiedBystring

Name of the user who last modified the entity

modifiedByIdstring

ID of the user who last modified the entity

companyIdstring required

Company identifier

companyobject

Any valid JSON value

groupIdsstring[]

Linked group IDs

namestring required
agentType'prompt-based' | 'analysis-agent' | 'ai-assistant' | 'node-based'

The type of agent architecture that determines its capabilities and behavior. prompt-based: Standard conversational agent that can answer calls, transfer calls, handle emails, book appointments, and execute workflows. Best for general-purpose use cases. analysis-agent: Specialized agent for call analysis only. Used to analyze calls after they have been transferred to humans. Monitors and extracts insights from ongoing calls. See: https://docs.voicelogica.ai/transfer-calls/introduction ai-assistant: Personal AI assistant/voicemail. Designed ONLY for individual use as your own AI voicemail or personal assistant. Handles calls when you are unavailable. node-based: Advanced agent with visual flow builder. Supports complex branching logic, conditional routing, and multi-step reasoning. Best for sophisticated conversational workflows.

systemPromptstring
language'ar-AE' | 'ar-BH' | 'ar-EG' | 'ar-KW' | 'ar-OM' | 'ar-QA' | 'ar-SA' | 'ar-LB' | 'ar-MA' | 'el-GR' | 'en-US' | 'es-ES' | 'fr-FR' | 'el-CY' | 'en-DK' | 'he-IL' | 'bg-BG' | 'ru-RU' | 'de-DE' | 'it-IT' | 'pt-PT' | 'ru-RU' | 'tr-TR' | 'zh-CN' | 'ja-JP' | 'ko-KR' | 'ja-JP' | 'ar-SA' | 'hi-IN' | 'bn-BD' | 'pa-IN' | 'ta-IN' | 'te-IN' | 'ur-IN' | 'vi-VN' | 'th-TH' | 'id-ID' | 'ms-MY' | 'fil-PH' | 'nl-NL' | 'sv-SE' | 'no-NO' | 'da-DK' | 'fi-FI' | 'is-IS' | 'gl-ES' | 'ca-ES' | 'eu-ES' | 'pt-BR' | 'zh-TW' | 'zh-HK' | 'zh-MO' | 'zh-SG' | 'zh-CH' | 'zh-CHT' | 'zh-CHS' | 'zh-CHT' | 'ro-RO' | 'hu-HU' | 'pl-PL' | 'sr-RS' | 'mk-MK' | 'bg-BG' | 'uk-UA' | 'en-GB' | 'en-AU' | 'en-CA' | 'en-NZ' | 'en-ZA' | 'en-IN' | 'en-IE' | 'en-PH' | 'en-SG' | 'en-HK' | 'en-MO' | 'en-CN' | 'en-TW' | 'en-MY' | 'nl-BE' | 'de-AT' | 'de-CH' | 'sv-SE' | 'no-NO' | 'da-DK' | 'fi-FI' | 'is-IS' | 'gl-ES' | 'ca-ES' | 'eu-ES' | 'pt-BR' | 'zh-TW' | 'zh-HK' | 'cs-CZ' | 'sk-SK' | 'sl-SI' | 'hr-HR' | 'lt-LT' | 'lv-LV' | 'et-EE' | 'mt-MT' | 'lb-LU' | 'sq-AL' | 'bs-BA' | 'ca-AD' | 'fr-MC' | 'it-SM' | 'it-VA' | 'ur-PK'

Locale code

knowledgeFileIdsstring[]
workflowsIdsstring[]
allowedToCopy'sameCompany' | 'public' | 'publicWithPassword' | 'private'
navigateToNodeToolboolean

Whether the agent can navigate to a specific node tool based on instructions

syncWithContactsboolean
playWaitMusicOnDuringCallToolsboolean
passwordstring
passwordTriesnumber
externalDialnumber
internalDialstring
dataRetentionDaysnumber
dataRetentionPolicy'none' | 'only-phone-number' | 'transcript' | 'all'
archiveRecordingForRetrievalboolean
requirePassingTestsToPublishboolean
coreProvidersOnlyboolean
skipParametersNotUsedInPromptboolean

When true, parameters/variables not explicitly referenced in the prompt will not be appended as additional context

customerInstructionsstring

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "active": true,
  "createdBy": "John Doe",
  "createdById": "123",
  "modifiedAt": "2024-01-15T10:30:00.000Z",
  "modifiedBy": "Jane Doe",
  "modifiedById": "456",
  "companyId": "507f1f77bcf86cd799439012",
  "name": "Customer Support Agent",
  "agentType": "prompt-based",
  "systemPrompt": "You are a helpful customer support assistant. Always be polite and provide accurate information.",
  "dynamicVariables": [
    {
      "name": "company_name",
      "value": "{{company_name}}"
    }
  ],
  "language": "en-US",
  "secondaryLanguages": [
    {
      "language": "es-ES",
      "type": "other_agent",
      "agentId": "agent-123e4567-e89b-12d3-a456-426614174000",
      "enabled": true,
      "defaultContries": [
        "Greece",
        "United States"
      ]
    },
    {
      "language": "fr-FR",
      "type": "other_voice",
      "voiceConfig": {
        "voiceProvider": "elevenlabs",
        "voiceId": "21m00Tcm4TlvDq8ikWAM"
      },
      "enabled": true,
      "defaultContries": [
        "Greece",
        "United States"
      ]
    }
  ],
  "knowledgeFileIds": [
    "kb-123",
    "kb-456"
  ],
  "workflowsIds": [
    "workflow-123",
    "workflow-456"
  ],
  "tools": [
    {
      "enabled": true,
      "name": "send_sms",
      "prompt": "Send an SMS to the user",
      "type": "system"
    }
  ],
  "allowedToCopy": "sameCompany",
  "passwordTries": 3,
  "externalDial": 1234567890,
  "internalDial": "4002",
  "knowledgeFiles": [
    {
      "id": "kb-123",
      "name": "Product Manual",
      "description": "Complete product documentation"
    }
  ],
  "workflows": [
    {
      "id": "workflow-123",
      "name": "Send Email Notification",
      "description": "Automated email notification workflow",
      "triggers": [
        {
          "nodeType": "onCallStart",
          "nodeTitle": "Call Start Trigger",
          "triggerConfig": {
            "enabled": true,
            "triggerType": "onCallStart",
            "description": "Trigger when a new call starts"
          }
        }
      ],
      "nodes": [],
      "files": [],
      "parameters": [
        {
          "name": "company_name",
          "value": "{{company_name}}",
          "type": "string",
          "required": true,
          "aiGenerated": true
        }
      ],
      "dataRetentionDays": 30,
      "dataRetentionPolicy": "all"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.