VberAI API — डेवलपर्स के लिए RESTful रेफ़रेंस

VberAI API, VberAI की AI क्षमताओं (आज: AI सुपर मैटिंग) को आपके ऐप्स, गेम्स और ऑटोमेशन पाइपलाइनों में एम्बेड करने के लिए एक RESTful HTTP API है। ऑथेंटिकेशन हस्ताक्षर-आधारित अनुरोधों के साथ API कुंजियों का उपयोग करता है; सामान्य त्रुटि कोड मानकीकृत हैं; प्रति-कॉल बिलिंग VberAI क्रेडिट में भुगतान की जाती है।

API v1
स्थिर

API दस्तावेज़

HTTP पर सीधे images जनरेट करें, backgrounds हटाएँ, और VberAI की AI pipelines चलाएँ — personal या enterprise API keys के साथ।

बैकग्राउंड हटाना

ai-image-bg-remove

किसी image से background हटाएँ और एक पारदर्शी-background कटआउट लौटाएँ। असमकालिक — सबमिट करें, फिर पोल करें या webhook की प्रतीक्षा करें।

मूल्य-निर्धारण

प्रति image एक निश्चित शुल्क। सटीक राशि के लिए /cost endpoint कॉल करें।

पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
imageUrlstringहाँप्रोसेस की जाने वाली image का सार्वजनिक http(s) URL। यह सेवा का एकमात्र input है — यह base64 या कोई source_type स्वीकार नहीं करती।
widthnumberनहींवैकल्पिक। केवल तब बिलिंग-क्षेत्र fallback के रूप में उपयोग होता है जब स्रोत रिज़ॉल्यूशन का पता न लगाया जा सके; यह आउटपुट को नहीं बदलता।
heightnumberनहींवैकल्पिक। केवल तब बिलिंग-क्षेत्र 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।

createdqueueddispatchingsubmittedprocessingcompletedfailedcancelledtimeout

जब 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 रखता है।

पूर्ण हुआ task

json
{
  "success": true,
  "data": {
    "taskId": "6a97e277a148c970dd545f40",
    "serviceCode": "ai-image-bg-remove",
    "status": "completed",
    "creditsEstimated": 10,
    "creditsActual": 10,
    "outputCount": 1,
    "result": {
      "type": "images",
      "assets": [
        {
          "index": 0,
          "url": "https://assets.vberai.org/tmp/user-assets/.../0.png?signature=...",
          "mimeType": "image/png",
          "expiresAt": "2026-01-22T10:30:12.000Z"
        }
      ]
    },
    "completedAt": "2026-01-15T10:30:12.000Z"
  }
}

Webhooks

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) भी होता है ताकि आप डुप्लिकेट्स को अनदेखा कर सकें।

POST/ai/services/ai-image-bg-remove/execute
bash
curl -X POST https://api.vberai.com/api/ai/services/ai-image-bg-remove/execute \
  -H "X-API-Key: vber_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input": {"imageUrl": "https://example.com/photo.png"}}'
bash
curl https://api.vberai.com/api/ai/tasks/{taskId} \
  -H "X-API-Key: vber_sk_YOUR_KEY"