एजेंट पाएं

GET

/v1/convai/agents/:agent_id

GET

/v1/convai/agents/:agent_id

curl -G https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz \
     -d branch_id=agtbranch_0901k4aafjxxfxt93gd841r7tv5t \
     -d version_id=agtvrsn_8901k4t9z5defmb8vh3e9361y7nj

{
  "agent_id": "agent_7101k5zvyjhmfg983brhmhkd98n6",
  "name": "My Agent",
  "conversation_config": {
    "asr": {
      "quality": "high",
      "provider": "scribe_realtime",
      "user_input_audio_format": "pcm_16000",
      "keywords": [
        "hello",
        "world"
      ]
    },
    "turn": {
      "turn_timeout": 7,
      "silence_end_call_timeout": -1,
      "turn_eagerness": "normal",
      "spelling_patience": "auto",
      "speculative_turn": false,
      "retranscribe_on_turn_timeout": false,
      "turn_model": "turn_v3",
      "interruption_ignore_terms": [],
      "interruption_ignore_term_languages": [],
      "merge_with_default_ignore_terms": false,
      "transcribe_on_disabled_interruptions": false,
      "soft_timeout_config": {
        "timeout_seconds": -1,
        "message": "Hhmmmm...yeah."
      },
      "mode": "turn"
    },
    "tts": {
      "model_id": "eleven_turbo_v2",
      "voice_id": "cjVigY5qzO86Huf0OWal",
      "agent_output_audio_format": "pcm_16000",
      "stability": 0.5,
      "speed": 1,
      "similarity_boost": 0.8,
      "pronunciation_dictionary_locators": [],
      "optimize_streaming_latency": 3
    },
    "conversation": {
      "max_duration_seconds": 600,
      "client_events": [
        "audio",
        "interruption"
      ]
    },
    "language_presets": {},
    "vad": {
      "background_voice_detection": false
    },
    "agent": {
      "first_message": "Hello, how can I help you today?",
      "language": "en",
      "disable_first_message_interruptions": false
    }
  },
  "metadata": {
    "created_at_unix_secs": 1,
    "updated_at_unix_secs": 1
  },
  "workflow": {
    "edges": {
      "entry_to_tool_a": {
        "source": "entry_node",
        "target": "tool_node_a",
        "forward_condition": {
          "type": "llm",
          "condition": "Tool A condition"
        }
      },
      "start_to_entry": {
        "source": "start_node",
        "target": "entry_node",
        "forward_condition": {
          "type": "unconditional"
        }
      },
      "tool_a_to_failure": {
        "source": "tool_node_a",
        "target": "failure_node",
        "forward_condition": {
          "type": "result",
          "successful": false
        }
      },
      "tool_a_to_tool_b": {
        "source": "tool_node_a",
        "target": "tool_node_b",
        "forward_condition": {
          "type": "result",
          "successful": true
        }
      },
      "tool_b_to_agent_transfer": {
        "source": "tool_node_b",
        "target": "success_transfer",
        "forward_condition": {
          "type": "unconditional"
        }
      },
      "tool_b_to_conversation": {
        "source": "tool_node_b",
        "target": "success_conversation",
        "forward_condition": {
          "type": "llm",
          "condition": "Conversation condition"
        }
      },
      "tool_b_to_end": {
        "source": "tool_node_b",
        "target": "success_end",
        "forward_condition": {
          "type": "llm",
          "condition": "End condition"
        }
      },
      "tool_b_to_phone": {
        "source": "tool_node_b",
        "target": "success_phone",
        "forward_condition": {
          "type": "expression",
          "expression": {
            "type": "or_operator",
            "children": [
              {
                "type": "dynamic_variable",
                "name": "force_phone_transfer"
              },
              {
                "type": "llm",
                "value_schema": {
                  "type": "boolean",
                  "description": "Phone condition"
                },
                "prompt": "Phone condition"
              },
              {
                "type": "eq_operator",
                "left": {
                  "type": "dynamic_variable",
                  "name": "mode"
                },
                "right": {
                  "type": "string_literal",
                  "value": "dev"
                }
              }
            ]
          }
        }
      }
    },
    "nodes": {
      "entry_node": {
        "type": "override_agent",
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "conversation_config": {},
        "edge_order": [
          "entry_to_tool_a"
        ],
        "entry_behavior": "auto",
        "label": "Entry",
        "position": {
          "x": 0,
          "y": 0
        }
      },
      "failure_node": {
        "type": "override_agent",
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "conversation_config": {},
        "edge_order": [],
        "entry_behavior": "auto",
        "label": "Failure",
        "position": {
          "x": 0,
          "y": 0
        }
      },
      "start_node": {
        "type": "start",
        "edge_order": [
          "start_to_entry"
        ],
        "position": {
          "x": 0,
          "y": 0
        }
      },
      "success_conversation": {
        "type": "override_agent",
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "conversation_config": {},
        "edge_order": [],
        "entry_behavior": "auto",
        "label": "Success A",
        "position": {
          "x": 0,
          "y": 0
        }
      },
      "success_end": {
        "type": "end",
        "edge_order": [],
        "outcome": "success",
        "position": {
          "x": 0,
          "y": 0
        }
      },
      "success_phone": {
        "type": "phone_number",
        "custom_sip_headers": [],
        "edge_order": [],
        "position": {
          "x": 0,
          "y": 0
        },
        "sip_refer_play_dialtone": true,
        "transfer_destination": {
          "type": "phone",
          "phone_number": "+1234567890"
        },
        "transfer_type": "conference",
        "require_acceptance": false
      },
      "success_transfer": {
        "type": "standalone_agent",
        "agent_id": "success_transfer_agent",
        "delay_ms": 0,
        "edge_order": [],
        "enable_transferred_agent_first_message": false,
        "position": {
          "x": 0,
          "y": 0
        },
        "preserve_client_tts_overrides": false,
        "preserve_voice_settings": false,
        "drop_history": false,
        "isolate_history": false
      },
      "tool_node_a": {
        "type": "tool",
        "edge_order": [
          "tool_a_to_failure",
          "tool_a_to_tool_b"
        ],
        "position": {
          "x": 0,
          "y": 0
        },
        "tools": [
          {
            "tool_id": "tool_a"
          },
          {
            "tool_id": "tool_b"
          }
        ]
      },
      "tool_node_b": {
        "type": "tool",
        "edge_order": [
          "tool_b_to_conversation",
          "tool_b_to_end",
          "tool_b_to_phone",
          "tool_b_to_agent_transfer"
        ],
        "position": {
          "x": 0,
          "y": 0
        },
        "tools": [
          {
            "tool_id": "tool_a"
          }
        ]
      }
    },
    "prevent_subagent_loops": false,
    "subgraphs": {}
  }
}

किसी एजेंट का कॉन्फ़िगरेशन पाएं

पाथ पैरामीटर

agent_idstringआवश्यक

एजेंट की id। यह एजेंट बनाते समय लौटाई जाती है।

क्वेरी पैरामीटर

version_idstring or nullवैकल्पिक

उपयोग करने के लिए एजेंट वर्ज़न की ID

branch_idstring or nullवैकल्पिक

उपयोग करने के लिए ब्रांच की ID

include_procedure_generated_workflow_elementsbooleanवैकल्पिकडिफ़ॉल्ट: true

संरचित प्रक्रियाओं से जनरेट किए गए workflow नोड और एज शामिल करने हैं या नहीं। false होने पर workflow में सिर्फ़ लिखे गए एलिमेंट शामिल होते हैं।

रिस्पॉन्स

सफल रिस्पॉन्स

agent_idstring

एजेंट की ID

namestring

एजेंट का नाम

conversation_configobject

एजेंट का बातचीत कॉन्फ़िगरेशन

metadataobject

एजेंट का मेटाडेटा

platform_settingsobjectवैकल्पिक

एजेंट की प्लेटफ़ॉर्म सेटिंग्स

phone_numberslist of objectsवैकल्पिक

एजेंट के फ़ोन नंबर

whatsapp_accountslist of objectsवैकल्पिक

एजेंट को असाइन किए गए WhatsApp अकाउंट्स

workflowobjectवैकल्पिक

एजेंट का वर्कफ़्लो

access_infoobject or nullवैकल्पिक

यूज़र के लिए एजेंट की एक्सेस जानकारी

tagslist of stringsवैकल्पिक

एजेंट को श्रेणियों में बाँटने के लिए इस्तेमाल होने वाले टैग

version_idstring or nullवैकल्पिक

एजेंट जिस वर्शन पर है उसका ID

branch_idstring or nullवैकल्पिक

उस ब्रांच की ID जिस पर एजेंट है

main_branch_idstring or nullवैकल्पिक

इस एजेंट की मुख्य ब्रांच की ID

proceduresmap from strings to objectsवैकल्पिक

procedure_id से keyed procedures।

default_hold_audio_urlstringवैकल्पिकडिफ़ॉल्ट: https://eleven-public-cdn-common.elevenlabs.io/convai/ambient-audio-assets/elevator1.mp3

जब कोई कस्टम hold audio अपलोड नहीं किया जाता, तो कतार में मौजूद कॉलर्स के लिए बजने वाले डिफ़ॉल्ट hold tone का URL, ताकि डैशबोर्ड उसका प्रीव्यू दिखा सके।

त्रुटियाँ

422

Unprocessable Entity Error

पाथ पैरामीटर

हेडर

क्वेरी पैरामीटर

रिस्पॉन्स

त्रुटियाँ