नेविगेशन पर जाएँ

एजेंट की सूची दें

आपके एजेंट और उनके मेटाडेटा की सूची लौटाता है।

हेडर

xi-api-keystringवैकल्पिक

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

page_sizeintegerवैकल्पिक1-100डिफ़ॉल्ट: 30

ज़्यादा से ज़्यादा कितने एजेंट लौटाने हैं। 100 से ज़्यादा नहीं हो सकते, डिफ़ॉल्ट 30 है।

searchstringवैकल्पिक

agent के नाम से खोजें।

archivedbooleanवैकल्पिक

एजेंट को archived स्टेटस के आधार पर फ़िल्टर करें

show_only_owned_agentsbooleanवैकल्पिकडिफ़ॉल्ट: falseDeprecated

true पर सेट होने पर, endpoint किसी और द्वारा आपके साथ शेयर किए गए एजेंट को छोड़ देगा और केवल आपके स्वामित्व वाले एजेंट शामिल करेगा। अप्रचलित: इसके बजाय created_by_user_id इस्तेमाल करें।

created_by_user_idstringवैकल्पिक

एजेंट को क्रिएटर यूज़र ID के आधार पर फ़िल्टर करें। सेट होने पर, केवल इस यूज़र द्वारा बनाए गए एजेंट लौटाए जाते हैं। यह show_only_owned_agents पर प्राथमिकता रखता है। प्रमाणित यूज़र के लिए ‘@me’ इस्तेमाल करें।

tagsstringवैकल्पिक

एजेंट को टैग के आधार पर फ़िल्टर करें। कई टैग में से किसी से मिलान के लिए पैरामीटर दोहराएं।

sort_directionenumवैकल्पिक

नतीजों को सॉर्ट करने की दिशा

अनुमत मान:
sort_byenumवैकल्पिक

नतीजों को सॉर्ट करने के लिए फ़ील्ड

अनुमत मान:
cursorstringवैकल्पिक

अगला पेज फ़ेच करने के लिए इस्तेमाल होता है। रिस्पॉन्स में cursor लौटाया जाता है।

रिस्पॉन्स

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

agentslist of objects

एजेंट और उनके मेटाडेटा की सूची।

has_moreboolean

क्या पेजिनेशन में और एजेंट हैं

next_cursorstringवैकल्पिक

एजेंट को paginate करने के लिए अगला cursor

त्रुटियाँ

422
Agents List Request Unprocessable Entity Error