डॉक्स देखें

Public API गाइड

Jobs, Assets और आपका बैलेंस

API से job का status पढ़ें, नतीजे Download करें, अपनी तस्वीरें Upload करें और अपने Credits देखें।

यह पेज बताता है कि Public API से job को कैसे फ़ॉलो करें, उसकी फ़ाइलें कैसे लें और अपनी तस्वीरें कैसे Upload करें।

यह क्या करता है

आप जो भी job शुरू करते हैं, उसका एक id होता है। asset आपकी Library की एक फ़ाइल है: या तो कोई नतीजा, या आपकी Upload की हुई तस्वीर।

स्टेप बाय स्टेप

  1. job शुरू करें और उसका id संभालकर रखें।
  2. जब status done हो जाए, तो assets के हर item में एक file पता होता है।
  3. उस पते को अपनी key के साथ खोलें। आपको एक Download लिंक पर भेज दिया जाता है जो 10 मिनट चलता है।

हर विकल्प की जानकारी

job का status

Statusमतलब
queuedइंतज़ार में। position बताता है कि आपसे आगे कितनी हैं।
runningबन रही है
doneपूरी हो गई। सब कुछ बन गया।
partialपूरी हुई। कुछ आउटपुट बने, और पैसे सिर्फ़ उन्हीं के लगते हैं।
failedबन नहीं पाई। होल्ड किए गए Credits वापस आ गए।
blockedcontent नियमों ने रोक दिया
canceledचलने से पहले ही रोक दी गई

credits वह है जो job के लिए होल्ड हुआ। charged वह है जो आखिर में उसका खर्च रहा।

लिस्ट

GET /api/public/v1/jobs आपकी keys से शुरू हुई jobs की लिस्ट देता है, सबसे नई पहले। GET /api/public/v1/assets आपके नतीजों की लिस्ट देता है, और ?media=image, video या audio से उसे छोटा किया जा सकता है।

दोनों में ?limit= लगता है (ज़्यादा से ज़्यादा 50)। जब जवाब में "more": true हो, तो अगला पेज पढ़ने के लिए उसका cursor ?cursor= में भेजें।

तस्वीर Upload करें

  1. जवाब में एक url आता है। फ़ाइल को वहाँ PUT से भेजें, उसी Content-Type के साथ जो उसमें लिखा है।
  2. जवाब में आपका asset मिलता है, उसके id के साथ।

तस्वीरें PNG, JPEG या WebP हो सकती हैं। Captions के लिए क्लिप और आवाज़ की फ़ाइलें भी इसी तरह जाती हैं: उनका अपना mime भेजें, और आख़िरी step में duration_ms। सब पर वही जाँच होती है जो वेबसाइट के Upload पर होती है।

आपका बैलेंस

GET /api/public/v1/balance में credits मिलते हैं, चल रही jobs के लिए कितने held हैं, और आपके अगले Credits कब खत्म होंगे।

इस key के बारे में

GET /api/public/v1/me इस key के scopes, सीमाएँ, आज और इस महीने का इस्तेमाल, और tools में वह सूची दिखाता है जो यह key अभी चला सकती है। इसके लिए किसी scope की ज़रूरत नहीं।

आम दिक्कतें

job not_found आ रही है

यह id किसी दूसरे अकाउंट का है, या वह job API से शुरू ही नहीं हुई थी। वेबसाइट की अपनी jobs आपकी Library में हैं, पर यहाँ की jobs की लिस्ट में नहीं।

Download लिंक काम करना बंद हो गया

वह 10 मिनट ही चलता है। file पते को फिर से खोलें।

इससे जुड़ी गाइड

1 नव॰ 2026 को अपडेट हुआ