Skip to main content

​
अवलोकन

GET /jobs/{id} को बार-बार पोल करने के बजाय, आप एक वेबहुक URL प्रदान कर सकते हैं ताकि जब आपका जॉब पूरा हो जाए तो एक POST अनुरोध प्राप्त हो सके। यह अधिक कुशल है और अनावश्यक API कॉल्स को कम करता है।

​
वेबहुक का उपयोग

किसी भी जनरेशन अनुरोध में X-Webhook-URL हेडर जोड़ें। जब जॉब टर्मिनल स्टेट (completed, failed, या cancelled) तक पहुँचता है, तो API आपके URL पर पूरे जॉब डेटा के साथ एक POST अनुरोध भेजेगा। 
// npm install @krea-ai/sdk
import { Krea } from "@krea-ai/sdk";

const krea = new Krea({ apiKey: process.env.KREA_API_KEY });

const job = await krea.image(
  "bfl/flux-1-dev",
  {
    prompt: "a serene mountain landscape at sunset",
    width: 1024,
    height: 576
  },
  { webhookUrl: "https://your-server.com/webhook" }
);

console.log(`Job ID: ${job.job_id}`);
// Your webhook will receive the results when complete

​
वेबहुक पेलोड

जब जॉब पूरा हो जाता है, तो आपके वेबहुक URL को जॉब डेटा के साथ एक POST अनुरोध प्राप्त होता है: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "created_at": "2025-01-15T10:30:00.000Z",
  "completed_at": "2025-01-15T10:30:05.000Z",
  "result": {
    "urls": ["https://..."]
  }
}

​
सर्वोत्तम प्रथाएँ

तुरंत प्रतिक्रिया दें - तेज़ी से 2xx स्टेटस कोड लौटाएँ। यदि आवश्यक हो तो वेबहुक डेटा को एसिंक्रोनस रूप से प्रोसेस करें।
पेलोड की पुष्टि करें - परिणामों को प्रोसेस करने से पहले सत्यापित करें कि job_id आपके द्वारा शुरू किए गए किसी जॉब से मेल खाता है।
  • सुरक्षा के लिए HTTPS एंडपॉइंट्स का उपयोग करें
  • डुप्लिकेट डिलीवरी के मामले में आइडेम्पोटेंसी लागू करें
  • डिबगिंग के लिए वेबहुक रसीदों को लॉग करें

​
वेबहुक बनाम पोलिंग

दृष्टिकोणफ़ायदेनुकसान
वेबहुकरीयल-टाइम सूचनाएँ, कम API कॉल्सएक सार्वजनिक एंडपॉइंट की आवश्यकता
पोलिंगकहीं भी काम करता है, सर्वर की आवश्यकता नहींअधिक API कॉल्स, थोड़ा विलंब
जब आपके पास ऐसा सर्वर हो जो HTTP अनुरोध प्राप्त कर सके तो वेबहुक का उपयोग करें। क्लाइंट-साइड एप्लिकेशन के लिए या जब आप कोई सार्वजनिक एंडपॉइंट उजागर नहीं कर सकते तो पोलिंग का उपयोग करें।

​
अगले चरण

जॉब लाइफ़साइकिल

जॉब स्टेट्स और स्टेटस पोलिंग के बारे में जानें

कोड उदाहरण

वेबहुक हैंडलिंग के साथ पूर्ण उदाहरण देखें