एपीआई दस्तावेज़ीकरण

प्रमाणीकरण

सभी एपीआई अनुरोधों के लिए प्रमाणीकरण की आवश्यकता होती है। आपको Authorization हेडर में अपने एपीआई कुंजी को Bearer टोकन के रूप में शामिल करना होगा।

Authorization: Bearer आपकी_एपीआई_कुंजी

अपनी कुंजियों को सुरक्षित रखें। उन्हें कभी भी क्लाइंट साइड कोड में उजागर न करें।

एजेंट एपीआई

अपने आईए एजेंटों का प्रबंधन करें। आप नए बना सकते हैं, सिस्टम प्रॉम्प्ट असाइन कर सकते हैं और प्रविष्टियों को कॉन्फ़िगर कर सकते हैं।

एजेंट सूची

GET /v1/agents

आपके खाते से जुड़े सभी एजेंटों की पृष्ठबद्ध सूची लौटाता है।

एजेंट बनाएं

POST /v1/agents

एक नया आईए एजेंट बनाएं। JSON शरीर में name और systemPrompt की आवश्यकता होती है।

कॉल एपीआई

डायनामिक रूप से आउटबाउंड कॉल शुरू करें और प्रबंधित करें।

आउटबाउंड कॉल शुरू करें

POST /v1/calls/outbound

एक निर्दिष्ट एजेंट आईडी का उपयोग करके एक विशिष्ट नंबर पर तुरंत कॉल शुरू करें।

कॉल विश्लेषण पुनर्प्राप्त करें

GET /v1/calls/{call_id}/analytics

एक समाप्त बातचीत के लिए पूर्ण ट्रांसक्रिप्शन, अवधि और भावना विश्लेषण लौटाता है।

वेबहुक

वास्तविक समय में घटनाओं को सुनें। कॉल समाप्त होने पर या संपर्क प्राप्त होने पर HTTP POST पेलोड प्राप्त करने के लिए डैशबोर्ड में वेबहुक एंडपॉइंट कॉन्फ़िगर करें।