VberAI API, VberAI की AI क्षमताओं (आज: AI सुपर मैटिंग) को आपके ऐप्स, गेम्स और ऑटोमेशन पाइपलाइनों में एम्बेड करने के लिए एक RESTful HTTP API है। ऑथेंटिकेशन हस्ताक्षर-आधारित अनुरोधों के साथ API कुंजियों का उपयोग करता है; सामान्य त्रुटि कोड मानकीकृत हैं; प्रति-कॉल बिलिंग VberAI क्रेडिट में भुगतान की जाती है।
API v1
स्थिर
API दस्तावेज़
HTTP पर सीधे images जनरेट करें, backgrounds हटाएँ, और VberAI की AI pipelines चलाएँ — personal या enterprise API keys के साथ।
किसी image से background हटाएँ और एक पारदर्शी-background कटआउट लौटाएँ। असमकालिक — सबमिट करें, फिर पोल करें या webhook की प्रतीक्षा करें।
मूल्य-निर्धारण
प्रति image एक निश्चित शुल्क। सटीक राशि के लिए /cost endpoint कॉल करें।
पैरामीटर
पैरामीटर
प्रकार
आवश्यक
विवरण
imageUrl
string
हाँ
प्रोसेस की जाने वाली image का सार्वजनिक http(s) URL। यह सेवा का एकमात्र input है — यह base64 या कोई source_type स्वीकार नहीं करती।
width
number
नहीं
वैकल्पिक। केवल तब बिलिंग-क्षेत्र fallback के रूप में उपयोग होता है जब स्रोत रिज़ॉल्यूशन का पता न लगाया जा सके; यह आउटपुट को नहीं बदलता।
height
number
नहीं
वैकल्पिक। केवल तब बिलिंग-क्षेत्र fallback के रूप में उपयोग होता है जब स्रोत रिज़ॉल्यूशन का पता न लगाया जा सके; यह आउटपुट को नहीं बदलता।
पोलिंग और परिणाम
असमकालिक jobs एक taskId लौटाते हैं। task को तब तक पोल करें जब तक उसका status किसी टर्मिनल मान तक न पहुँच जाए, फिर परिणाम पढ़ें। आप कौन-सा route पोल करते हैं, यह आपके key प्रकार पर निर्भर करता है — इसे सही करना सबसे महत्वपूर्ण बात है।
क्रिया
व्यक्तिगत key
एंटरप्राइज़ key
task status पोल करें
GET /ai/tasks/{taskId}
GET /ai/org-services/tasks/{taskId}
नए download URLs को पुनः साइन करें
status प्रतिक्रिया से पढ़ें
GET /ai/org-services/tasks/{taskId}/outputs
एंटरप्राइज़ keys को /ai/org-services route पोल करना ही चाहिए
किसी personal /ai/tasks route पर भेजी गई एंटरप्राइज़ key (vber_org_sk_) 401 INVALID_API_KEY लौटाती है — personal routes केवल personal keys स्वीकार करते हैं। एंटरप्राइज़ jobs को हमेशा /ai/org-services/tasks/{taskId} पर पोल करें। Cancel और batch-status केवल personal-key के लिए हैं।
एक task इन मानों से होकर गुजरता है। किसी टर्मिनल status तक पहुँचते ही पोलिंग बंद कर दें: completed, failed, cancelled या timeout।
जब status completed होता है, तो result.assets आउटपुट images रखता है। हर asset में एक url (एक pre-signed download लिंक जो समाप्त हो जाता है), एक mimeType और एक index होता है; width, height, size और expiresAt उपलब्ध होने पर दिखते हैं। URLs को तुरंत fetch करें — एंटरप्राइज़ keys /outputs endpoint से नए लिंक फिर से अनुरोध कर सकती हैं।
पूरा होने पर, result.assets पारदर्शी-background कटआउट image रखता है।
job सबमिट करते समय एक सार्वजनिक HTTPS webhookUrl (और एक वैकल्पिक webhookSecret) पास करें। एंटरप्राइज़ keys इन्हें body के शीर्ष स्तर से पढ़ती हैं; व्यक्तिगत keys इन्हें options से पढ़ती हैं।
यदि आप कोई webhookSecret सेट करते हैं, तो हर delivery में एक X-Webhook-Signature header होता है — कच्चे JSON payload का HMAC-SHA256, hex-encoded रूप में। payload पर भरोसा करने से पहले इसे अपने secret के साथ पुनः गणना करें और तुलना करें। Deliveries में एक X-Idempotency-Key (taskId + status) भी होता है ताकि आप डुप्लिकेट्स को अनदेखा कर सकें।