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

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

Headers

xi-api-keystringOptional

Query parameters

page_sizeintegerOptional1-100Defaults to 30

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

searchstring or nullOptional

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

archivedboolean or nullOptionalDefaults to false

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

show_only_owned_agentsbooleanOptionalDefaults to falseDeprecated
true पर सेट होने पर, endpoint किसी और द्वारा आपके साथ शेयर किए गए एजेंट को छोड़ देगा और केवल आपके स्वामित्व वाले एजेंट शामिल करेगा। अप्रचलित: इसके बजाय created_by_user_id इस्तेमाल करें।
created_by_user_idstring or nullOptional
एजेंट को क्रिएटर यूज़र ID के आधार पर फ़िल्टर करें। सेट होने पर, केवल इस यूज़र द्वारा बनाए गए एजेंट लौटाए जाते हैं। यह show_only_owned_agents पर प्राथमिकता रखता है। प्रमाणित यूज़र के लिए '@me' इस्तेमाल करें।
tagslist of strings or nullOptional

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

sort_directionenumOptional

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

Allowed values:
sort_byenum or nullOptional

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

Allowed values:
cursorstring or nullOptional

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

Response

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

agentslist of objects

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

has_moreboolean

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

next_cursorstring or nullOptional

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

Errors

422
Unprocessable Entity Error