शुरू करें

API कुंजियाँ और पुष्टि

हर रिक्वेस्ट के साथ API कुंजी जाती है। कुंजियाँ किसी वर्कस्पेस की होती हैं और उसी का बैलेंस इस्तेमाल करती हैं; हर कुंजी के लिए अलग बजट, मॉडल और पतों की सीमाएँ तय की जा सकती हैं।

कुंजी भेजना

दोनों में से कोई भी हेडर हर एंडपॉइंट पर काम करता है:

हेडर
Authorization: Bearer zr_live_your_key_here
# or, as Anthropic's SDKs send it:
x-api-key: zr_live_your_key_here

कुंजियाँ zr_live_ से शुरू होती हैं। पूरी कुंजी सिर्फ़ एक बार, बनाते समय दिखती है; हम केवल उसका हैश रखते हैं, इसलिए कोई भी (हम भी) उसे आपको दोबारा नहीं दिखा सकता। कुंजी खो गई? उसे रद्द करें और नई बनाएँ।

AI एजेंट कनेक्ट करना

कोई एजेंट (OpenClaw, Hermes, Manus, या आपका अपना) बिना किसी से कुंजी कॉपी करवाए अपनी कुंजी पा सकता है: वह लिंक माँगता है, उसका उपयोगकर्ता zurelay.com पर रोज़ाना की सीमा के साथ मंज़ूरी देता है, और एजेंट कुंजी ले लेता है। यह TV में साइन इन करने जैसा है (OAuth का डिवाइस फ़्लो, RFC 8628)। इन दो कॉल के लिए किसी कुंजी की ज़रूरत नहीं है।

POST/connect
namestring
एजेंट अपने लिए जो नाम बताता है, वह मंज़ूरी वाले पेज पर दिखता है; कुंजी को भी यही नाम दिया जाता है। वैकल्पिक।
लिंक माँगें
curl -X POST https://api.zurelay.com/connect \
-H "Content-Type: application/json" \
-d '{"name": "OpenClaw"}'
{
"status": "pending",
"device_code": "zr_dc_…",
"user_code": "WDJB-MJHT",
"verification_uri": "https://zurelay.com/connect",
"verification_uri_complete": "https://zurelay.com/connect?code=WDJB-MJHT",
"expires_in": 900,
"interval": 2
}

व्यक्ति को verification_uri_complete और कोड दिखाएँ। वे साइन इन करके जाँचते हैं कि कोड मेल खाता है, वर्कस्पेस और रोज़ की सीमा चुनते हैं, और 15 मिनट के भीतर मंज़ूरी देते हैं। device_code सिर्फ़ एजेंट के पास रखें: कुंजी पाने के लिए इसकी ज़रूरत होती है।

POST/connect/key
device_codestringज़रूरी
POST /connect से।
waitseconds
pending लौटाने से पहले मंज़ूरी के लिए कितनी देर इंतज़ार करना है, 0 से 25 तक। डिफ़ॉल्ट 25 है।
कुंजी पाएँ
curl -X POST https://api.zurelay.com/connect/key \
-H "Content-Type: application/json" \
-d '{"device_code": "zr_dc_…"}'
{
"status": "approved",
"api_key": "zr_live_…",
"key_name": "OpenClaw",
"workspace": "Acme",
"daily_limit_usd": 10,
"base_url": "https://api.zurelay.com/v1"
}
HTTPstatusमतलब
202pendingअभी मंज़ूरी नहीं मिली है। दोबारा कॉल करें; हर कॉल 25 सेकंड तक इंतज़ार करती है।
200approvedयह रही कुंजी। मंज़ूरी मिलने के 30 मिनट के भीतर दोबारा माँगने पर वही कुंजी मिलती है, ताकि जवाब खो जाने पर भी आप उसे पा सकें।
403deniedव्यक्ति ने मना कर दिया।
410expired15 मिनट के भीतर मंज़ूरी नहीं मिली, या कुंजी लेने में बहुत देर हो गई। फिर से शुरू करें।
410revokedAPI कुंजियाँ पेज पर यह कुंजी रद्द कर दी गई थी।
404unknownइस डिवाइस कोड वाला कोई अनुरोध नहीं है।
यह API कुंजियाँ पेज पर एक सामान्य कुंजी है, जिसका नाम एजेंट के नाम पर है और जिसकी रोज़ की सीमा व्यक्ति ने चुनी है। वहीं इसके नियम बदलें, या एजेंट को डिस्कनेक्ट करने के लिए इसे रद्द करें। एजेंट zurelay.com/skill.md से सेटअप के चरण भी पढ़ते हैं।

कुंजियाँ सुरक्षित रखें

  • कुंजियाँ सीक्रेट मैनेजर या एनवायरनमेंट वैरिएबल में रखें, कभी भी कोड या रिपॉज़िटरी में नहीं।
  • अपने सर्वर से Zurelay को कॉल करें। ब्राउज़र या मोबाइल ऐप में रखी कुंजी को ऐप इस्तेमाल करने वाला कोई भी व्यक्ति पढ़ सकता है।
  • हर ऐप या एनवायरनमेंट (जैसे, production और staging) के लिए अलग कुंजी इस्तेमाल करें, ताकि बाकी कुंजियों को बदले बिना आप किसी एक को रद्द कर सकें।
  • हर कुंजी को सिर्फ़ उतनी ही अनुमति दें जितनी उसे चाहिए: बजट, वे मॉडल जिन्हें वह कॉल करती है, और वे पते जहाँ से उसका इस्तेमाल होता है। कुंजी की सीमाएँ और नियम देखें।
  • अगर कोई कुंजी लीक हो जाए, तो उसे API कुंजियाँ में जाकर रद्द करें। उससे किए गए अनुरोध 15 सेकंड के भीतर बंद हो जाते हैं।

कुंजी पर लगाई जा सकने वाली सीमाएँ

Monthly budgetUSD
हर कैलेंडर महीने में खर्च की अनुमति (UTC)।
Daily budgetUSD
हर दिन खर्च की अनुमति (UTC)।
Rate limitअनुरोध / मिनट
प्रति मिनट अनुरोध; इससे ज़्यादा अनुरोध 429 के साथ अस्वीकार कर दिए जाते हैं।
Expirydate
इसके बाद कुंजी काम करना बंद कर देती है।
Allowed modelslist
सिर्फ़ ये मॉडल; बाकी सभी 403 के साथ अस्वीकार कर दिए जाते हैं।
Allowed IP addresseslist
सिर्फ़ इन पतों या रेंज से आने वाले अनुरोध।
Smart routingsetting
मॉडल उपलब्ध न होने पर क्या होता है: स्मार्ट रूटिंग देखें।

पुष्टि करने में गड़बड़ियाँ

स्थितिकोडमतलब
401missing_api_keyअनुरोध में कुंजी नहीं है।
401invalid_api_keyकुंजी मौजूद नहीं है या रद्द कर दी गई है।
401expired_api_keyकुंजी की समय-सीमा खत्म हो गई है।
403ip_not_allowedयह की सिर्फ़ दूसरे पतों से काम करती है।
403model_not_allowedइस की को यह मॉडल इस्तेमाल करने की अनुमति नहीं है।
402insufficient_quotaवर्कस्पेस के बैलेंस में से चल रहे अनुरोधों के लिए अलग रखी गई रकम घटाने के बाद, इस अनुरोध के लिए पर्याप्त रकम नहीं बचती।
हर चैट, इमेज और वीडियो के जवाब में एक x-request-id हेडर होता है। सहायता के लिए लिखते समय इसे शामिल करें, ताकि हम कुछ ही सेकंड में अनुरोध ढूँढ सकें।

कोई सवाल है, या कुछ छूट गया है? हमारी सहायता टीम से पूछें और हम ईमेल से जवाब देंगे, आम तौर पर एक मिनट के भीतर.