ElevenCreativeImage & VideoFlowsTemplatesRuns

टेम्पलेट रन बनाएं

फ़्लोज़ टेम्प्लेट का रन शुरू करें। किसी स्नैपशॉट को पिन करने के लिए `version_id` दें या नवीनतम प्रकाशित वर्शन चलाने के लिए इसे छोड़ दें / `latest` दें। इनपुट पोर्ट ID के आधार पर `inputs` में इनपुट वैल्यू सेट करें। रिस्पॉन्स में रन अपनी शुरुआती स्थिति में होगा और हर आउटपुट पहले से `outputs` में उसकी पोर्ट ID के अंतर्गत सूचीबद्ध होगा। रन पूरा होने पर, जब उसका `status` `completed` या `failed` हो, तब `flows_template_run` इवेंट पाने के लिए `webhook` शामिल करें; इंतज़ार करने का यही सुझाया गया तरीका है। इसके बिना, `status` टर्मिनल होने तक सामान्य अंतराल पर `GET /v1/flows/templates/{template_id}/runs/{run_id}` फ़ेच करें।

Path parameters

template_idstringRequired

टेम्प्लेट की ID, जैसा ElevenLabs ऐप में या GET /v1/flows/templates द्वारा दिखाया गया है।

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
inputsmap from strings to strings or booleans or integers or doubles or objects or lists of TemplateRunInputRequired

इनपुट port id के अनुसार इनपुट मान। चलाए जा रहे वर्ज़न का हर इनपुट port देना ज़रूरी है; अनुपस्थित या अज्ञात id अस्वीकार कर दी जाती है। बिना इनपुट वाले टेम्पलेट के लिए {} दें।

version_idstring or nullOptional>=1 character

चलाने के लिए टेम्पलेट स्नैपशॉट। उस स्नैपशॉट को पिन करने के लिए कोई विशेष वर्ज़न id दें, या टेम्पलेट का सबसे हाल में प्रकाशित वर्ज़न चलाने के लिए latest दें (छोड़े जाने पर डिफ़ॉल्ट)। केवल प्रकाशित वर्ज़न पिन किए जा सकते हैं, सिवाय टेम्पलेट के मालिक के, जो प्रकाशित करने से पहले आज़माने के लिए किसी अप्रकाशित सेव किए गए स्नैपशॉट को भी पिन कर सकता है। लाइव ड्राफ़्ट कभी भी इस API के ज़रिए नहीं चलाया जाता।

webhookobject or nullOptional

जब run का status completed या failed हो जाए, तो उसका परिणाम workspace के कॉन्फ़िगर किए गए flows webhooks पर भेजने के लिए शामिल करें। पूरे run के लिए एक इवेंट: flows_template_run इवेंट का data, GET /v1/flows/templates/{template_id}/runs/{run_id} के अंतिम रिस्पॉन्स से मेल खाता है।

Response

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

idstring

रन का यूनीक आइडेंटिफ़ायर।

template_idstring

वह टेम्पलेट जिसे इस रन ने चलाया, ताकि कई टेम्पलेट चलाने वाला वेबहुक कंज़्यूमर रन-टू-टेम्पलेट मैप रखे बिना उनके रनों में अंतर कर सके।

version_idstring

वह टेम्पलेट वर्ज़न जिसे इस रन ने चलाया। रन बनते समय इसका समाधान हो जाता है, इसलिए latest से शुरू किया गया रन उस वास्तविक वर्ज़न को रिकॉर्ड करता है जो उसने चलाया।

statusenum

रन का स्टेटस, जो उसके आउटपुट्स से समेकित होता है: आउटपुट शुरू होने तक pending, कोई आउटपुट अधूरा होने तक generating, सभी आउटपुट पूरे होने पर completed, और सभी आउटपुट समाप्त होने व कम से कम एक के विफल होने पर failed। completed और failed अंतिम स्टेटस हैं: रन के इनमें से किसी एक तक पहुंचने पर flows_template_run वेबहुक ट्रिगर होता है।

Allowed values:
outputsmap from strings to objects

The run’s outputs, keyed by output port id. Each is a TemplateOutput discriminated on type, the type of its port’s content_schema.

Errors

422
Unprocessable Entity Error