API
💡 पायथन डेवलपर्स: आधिकारिक clore-ai Python SDK कच्चे API कॉलों के बजाय इसका उपयोग करें। यह प्रमाणीकरण, रेट-लिमिटिंग, पुनः प्रयास, और त्रुटि-प्रबंधन को स्वचालित रूप से संभालता है।
त्वरित शुरुआत:
pip install clore-ai— देखें Python SDK दस्तावेज़ और CLI संदर्भ.
🧭 क्या आपको ब्राउज़ करने योग्य संदर्भ पसंद है? इंटरैक्टिव API दस्तावेज़ यहाँ खोलें clore.ai/api-docs। इस पेज के सभी एंडपॉइंट्स के लिए आधार URL:
https://api.clore.ai/v1/.
परिचय
CLORE.AI api का उपयोग आपके वर्कलोड्स की तैनाती को स्वचालित करने के लिए किया जा सकता है CLORE.AI
सबसे पहले आपको एक API कुंजी प्राप्त करनी होगी
API प्रतिक्रियाएँ
प्रतिक्रियाएँ JSON प्रारूप में लौटाई जाती हैं, इनके विभिन्न फ़ील्ड हो सकते हैं
हमेशा लौटाया जाने वाला फ़ील्ड code है, जो स्थिति दर्शाता है
code फ़ील्ड
0
सामान्य
1
डेटाबेस त्रुटि
2
अमान्य इनपुट डेटा
3
अमान्य API टोकन
4
अमान्य एंडपॉइंट
5
1 अनुरोध/सेकंड की सीमा पार हो गई
6
त्रुटि निर्दिष्ट है error फ़ील्ड
एंडपॉइंट्स
1. वॉलेट्स
बारे में
वॉलेट्स और बैलेंस लौटाता है
हेडर्स
auth
string
हाँ
API टोकन
आउटपुट
code
int
स्थिति कोड
वॉलेट्स
[]string
वॉलेट्स की सरणी
उदाहरण
इनपुट:
आउटपुट:
2. my_servers
बारे में
आपके वे सर्वर लौटाता है जिन्हें आप प्रदान कर रहे हैं clore.ai मार्केटप्लेस
हेडर्स
auth
string
हाँ
API टोकन
आउटपुट
code
int
स्थिति कोड
सीमा
int
आपके पास हो सकने वाले सर्वरों की अधिकतम संख्या
सर्वर
[]string
सर्वरों की सरणी
servers[x].name
string
उपयोगकर्ता द्वारा चयनित सर्वर का नाम
servers[x].visibility
string
मार्केटप्लेस पर दृश्यता
servers[x].pricing
[]string
ऑन-डिमांड कीमत/दिन
servers[x].online
bool
क्या सर्वर ऑनलाइन है
servers[x].min_spot_pricing
[]string
स्पॉट मार्केट में किराए पर लेने की न्यूनतम कीमत/दिन
servers[x].init_token
string
आरंभिकरण टोकन
servers[x].specs
[]string
सर्वर विनिर्देश
servers[x].remaining_time
int
नवीनतम सक्रिय ऑर्डर का किराया समाप्ति समय (ms epoch, किराए पर न होने पर 0)
servers[x].rental_state
string
समेकित GPU किराया स्थिति: कोई नहीं, आंशिक, या पूर्ण
servers[x].rented_gpus
int
सक्रिय ऑर्डरों में वर्तमान में किराए पर लिए गए GPUs
servers[x].total_gpus
int
सर्वर पर कुल GPUs
servers[x].rented_price_by_currency
object
मुद्रा के अनुसार कुंजीबद्ध सक्रिय ऑर्डर कीमतों का योग
servers[x].update_channel
string
होस्टिंग-एजेंट अपडेट चैनल: स्थिर या बीटा
servers[x].requested_channel
string
वेब UI से अनुरोधित चैनल परिवर्तन (केवल अनुरोध होने पर उपस्थित)
servers[x].target_backend_version
int
वर्तमान चैनल जिस बैकएंड संस्करण को लक्षित करता है
उदाहरण
इनपुट:
आउटपुट:
में USD मान मूल्य निर्धारण ऑब्जेक्ट्स उस USD-आधारित मूल्य निर्धारण मोड को दर्शाते हैं जिसे होस्ट ने सक्षम किया है।
3. server_config
बारे में
विशिष्ट सर्वर का कॉन्फ़िगरेशन प्राप्त करें
हेडर्स
auth
string
हाँ
API टोकन
सामग्री-प्रकार
string
हाँ
होना चाहिए application/json
बॉडी
सर्वर नाम
string
हाँ
सर्वर नाम
आउटपुट
code
int
स्थिति कोड
creation_completed
bool
क्या सर्वर निर्माण पूर्ण हो चुका है
config
[]string
सर्वर का कॉन्फ़िग
config.name
string
उपयोगकर्ता द्वारा चयनित सर्वर का नाम
config.visibility
string
मार्केटप्लेस पर दृश्यता
config.pricing
[]string
ऑन-डिमांड कीमत/दिन
config.spot_pricing
[]string
स्पॉट मार्केट में किराए पर लेने की न्यूनतम कीमत/दिन
config.mrl
int
घंटों में अधिकतम किराये की लंबाई
config.online
bool
क्या सर्वर ऑनलाइन है
config.id
int
अद्वितीय सर्वर ID
config.rental_status
int
0 - किराए पर नहीं | 1 - स्पॉट मार्केट में किराए पर | 2 - ऑन-डिमांड किराए पर
config.specs
[]string
सर्वर विनिर्देश
config.background_job
[]string
किराए पर न होने पर बैकग्राउंड जॉब
config.tenants
[]object
सर्वर पर सक्रिय ऑर्डर: rental_type, currency, मूल्य, remaining_time, gpu_count
server_configवही rental-state और update-channel फ़ील्ड भी लौटाता है जैसेmy_servers:remaining_time,rental_state,rented_gpus,total_gpus,rented_price_by_currency,update_channel,requested_channel,target_backend_version.
उदाहरण
इनपुट:
आउटपुट:
में USD मान मूल्य निर्धारण ऑब्जेक्ट्स उस USD-आधारित मूल्य निर्धारण मोड को दर्शाते हैं जिसे होस्ट ने सक्षम किया है।
4. मार्केटप्लेस
बारे में
मार्केटप्लेस प्राप्त करें
हेडर्स
auth
string
हाँ
API टोकन
आउटपुट
code
int
स्थिति कोड
my_servers
[]string
उन सर्वर आईडी की सरणी जिन्हें आप प्रदान कर रहे हैं clore.ai (किराए पर नहीं लिया जा सकता)
सर्वर
[]string
मार्केटप्लेस पर सार्वजनिक सर्वरों की सरणी
servers[x].id
int
अद्वितीय सर्वर ID
servers[x].owner
int
विशिष्ट मालिक आईडी
servers[x].mrl
int
घंटों में अधिकतम किराये की लंबाई
servers[x].price.on_demand
[]string
ऑन-डिमांड कीमत प्रति दिन
servers[x].spot
[]string
स्पॉट मार्केट की न्यूनतम कीमत प्रति दिन
servers[x].rented
bool
क्या सर्वर ऑन-डिमांड किराए पर है
servers[x].specs
[]string
सर्वर विनिर्देश
servers[x].partial_gpu_rental
object | bool
false जब आंशिक किराया उपलब्ध न हो, अन्यथा { total_gpus, available_gpus, free_indices }
उदाहरण
मार्केटप्लेस प्राप्त करें
इनपुट:
आउटपुट:
5. my_orders
बारे में
अपने ऑर्डर प्राप्त करें
हेडर्स
auth
string
हाँ
API टोकन
क्वेरी स्ट्रिंग
return_completed
bool
नहीं
पूर्ण (समाप्त) ऑर्डर लौटाएँ
आउटपुट
code
int
स्थिति कोड
सीमा
int
सक्रिय ऑर्डरों की अधिकतम संख्या
orders
[]string
ऑर्डरों की सरणी
orders[x].id
int
अद्वितीय ऑर्डर ID
orders[x].price
float
ऑर्डर कीमत (लागत) प्रति दिन
orders[x].mrl
int
ऑर्डर किराये की अधिकतम अवधि सेकंड में
orders[x].image
string
उपयोग की गई Docker इमेज
orders[x].currency
string
बिलिंग के लिए उपयोग की गई मुद्रा
orders[x].spend
float
ऑर्डर पर खर्च की गई राशि
orders[x].ct
int
निर्माण समय (UNIX समय)
orders[x].p
int
वर्तमान में उपयोग किया जा रहा प्रॉक्सी क्लस्टर
orders[x].specs
[]string
सर्वर विनिर्देश
orders[x].si
int
अद्वितीय सर्वर ID
orders[x].pub_cluster
[]string
फॉरवर्ड किए गए पोर्ट्स वाले सार्वजनिक एंडपॉइंट्स
orders[x].tcp_ports
[]string
TCP पोर्ट फ़ॉरवर्डिंग
orders[x].http_port
string
HTTPS प्रॉक्सी के माध्यम से फ़ॉरवर्ड किया गया कंटेनर पोर्ट
orders[x].spot
bool
यह स्पॉट ऑर्डर है इसका संकेत
orders[x].expired
bool
यह संकेत कि ऑर्डर समाप्त हो चुका है
इनपुट:
आउटपुट:
6. spot_marketplace
बारे में
विशिष्ट सर्वर के लिए स्पॉट मार्केटप्लेस प्राप्त करें
हेडर्स
auth
string
हाँ
API टोकन
क्वेरी स्ट्रिंग
market
int
हाँ
अद्वितीय सर्वर ID
आउटपुट
code
int
स्थिति कोड
मौजूद है
bool
यह सत्यापन कि बाज़ार मौजूद है
market
object
मार्केटप्लेस
market.offers
array
सर्वर के लिए किराये के ऑफ़र
market.offers[x].offer_id
int
विशिष्ट ऑफ़र आईडी
market.offers[x].bid
float
प्रस्तावित कीमत प्रति दिन
market.offers[x].active
bool
यह ऑफ़र वर्तमान में उपयोग में है
market.offers[x].my
bool
यह ऑफ़र मेरा है
market.server
object
सर्वर जानकारी
market.server.min_pricing
object
प्रति दिन न्यूनतम ऑफ़र कीमत
market.server.mrl
int
किराये की अधिकतम अवधि सेकंड में
market.server.visibility
string
आप केवल तब ऑफ़र बना सकते हैं जब दृश्यता सार्वजनिक हो
market.server.online
bool
सर्वर ऑनलाइन है
इनपुट:
आउटपुट:
7. set_server_settings
बारे में
जिस सर्वर को आप प्रदान कर रहे हैं उसकी सेटिंग्स कॉन्फ़िगर करें clore.ai मार्केटप्लेस
हेडर्स
auth
string
हाँ
API टोकन
सामग्री-प्रकार
string
हाँ
होना चाहिए application/json
बॉडी
नाम
string
हाँ
उपयोगकर्ता द्वारा चयनित सर्वर का नाम
उपलब्धता
bool
हाँ
क्या सर्वर किराए पर लिया जा सकता है
mrl
int
हाँ
सर्वर किराये की अधिकतम अवधि
ऑन-डिमांड
float
हाँ
आपके सर्वर के लिए ऑन-डिमांड प्रति दिन कीमत
स्पॉट
float
हाँ
SPOT ऑफ़र के लिए प्रति दिन न्यूनतम कीमत
प्रति दिन की कीमतें 0.015 BTC / 600,000 CLORE / 1,000 USD तक सीमित हैं।
आउटपुट
code
int
स्थिति कोड
उदाहरण
आइए वर्तमान वॉलेट से भेजे गए लेन-देन के लिए भेजने का प्रमाण बनाएं।
इनपुट:
आउटपुट:
8. set_spot_price
बारे में
अपने SPOT बाज़ार प्रस्ताव के लिए प्रति दिन मूल्य निर्धारित करें
हेडर्स
auth
string
हाँ
API टोकन
सामग्री-प्रकार
string
हाँ
होना चाहिए application/json
बॉडी
order_id
int
हाँ
विशिष्ट ऑफ़र आईडी
desired_price
float
हाँ
आपका प्रति दिन प्रस्तावित मूल्य
उदाहरण
आइए स्पॉट बाज़ार मूल्य अपडेट करने की कोशिश करें
इनपुट 1 (कदम बहुत बड़ा था):
संभावित आउटपुट 1 (कदम बहुत बड़ा था): आप स्पॉट बाज़ार प्रस्ताव मूल्य अधिकतम 0.00000100 ₿ तक कम कर सकते हैं
code
int
स्थिति कोड
error
string
त्रुटि विवरण फ़ील्ड
max_step
float
वर्तमान में जिस न्यूनतम मान तक आप मूल्य कम कर सकते हैं
इनपुट 2 (मान्य मूल्य चरण-डाउन):
संभावित आउटपुट 2 (मान्य मूल्य चरण-डाउन):
इनपुट 3 (इनपुट 2 भेजने के बाद मूल्य और भी कम करें):
संभावित आउटपुट 3 (इनपुट 2 भेजने के बाद मूल्य और भी कम करें): आप स्पॉट मूल्य हर 600 सेकंड में एक बार कम कर सकते हैं
code
int
स्थिति कोड
error
string
त्रुटि विवरण फ़ील्ड
time_to_lowering
float
अगले मूल्य कम करने के अवसर तक शेष समय (सेकंड)
9. cancel_order
बारे में
एक सक्रिय ऑर्डर या स्पॉट प्रस्ताव रद्द करें
हेडर्स
auth
string
हाँ
API टोकन
सामग्री-प्रकार
string
हाँ
होना चाहिए application/json
बॉडी
id
int
हाँ
अद्वितीय ऑर्डर/प्रस्ताव ID
समस्या
string
नहीं
यदि आपको सर्वर के साथ कोई समस्या आई है, तो आप उन्हें रिपोर्ट कर सकते हैं clore.ai टीम को, अधिकतम 2048 वर्ण
आउटपुट
code
int
स्थिति कोड
उदाहरण
ऑर्डर/प्रस्ताव रद्द करें
इनपुट: इस उदाहरण में हम GPU #1 से संबंधित समस्याओं की रिपोर्ट कर रहे हैं; यदि आपको कोई समस्या नहीं है, तो issue फ़ील्ड शामिल न करें। आप text फ़ील्ड में कोई भी संदेश लिख सकते हैं और हम इसकी जांच करेंगे
आउटपुट:
10. create_order
बारे में
आप इस एंडपॉइंट से स्पॉट ऑफर या ऑन-डिमांड ऑर्डर बना सकते हैं यह एंडपॉइंट केवल 5 सेकंड में 1 अनुरोध की अनुमति भी देता है
हेडर्स
auth
string
हाँ
API टोकन
सामग्री-प्रकार
string
हाँ
होना चाहिए application/json
बॉडी
currency
string
हाँ
मुद्रा का नाम
image
string
हाँ
Dockerhub से मान्य इमेज
renting_server
int
हाँ
जिस सर्वर को आप किराए पर लेना चाहते हैं उसका ID
type
string
हाँ
on-demand या स्पॉट
spotprice
float
निर्भर करता है
स्पॉट बाज़ार पर प्रति दिन प्रस्तावित मूल्य, स्पॉट ऑर्डर बनाते समय आवश्यक
ports
object
नहीं
पोर्ट फ़ॉरवर्डिंग कॉन्फ़िगरेशन, अधिकतम 5 रिकॉर्ड
env
object
नहीं
पर्यावरण चर, स्ट्रिंग में बदले जाने पर कुल मिलाकर 12000 वर्णों तक सीमित। चर नाम - अधिकतम 128 प्रतीक चर मान - अधिकतम 1536 प्रतीक
jupyter_token
string
नहीं
Jupyter नोटबुक वाली इमेज के लिए Jupyter टोकन, अधिकतम 32 वर्ण *
ssh_key
string
नहीं
SSH वाली इमेज के लिए SSH कुंजी, अधिकतम 3072 वर्ण *
ssh_password
string
नहीं
SSH वाली इमेज के लिए SSH पासवर्ड, अधिकतम 32 वर्ण *
command
string
नहीं
ऑर्डर बनने के बाद कमांड सर्वर पर चलाया जाएगा
required_price
float
नहीं
आप जिस मूल्य पर ऑर्डर शुरू करना चाहते हैं उसे निर्दिष्ट करें; यदि मशीन मालिक मूल्य बदलता है, तो ऑर्डर शुरू नहीं होगा (केवल ऑन-डिमांड)
gpu_count
int
नहीं
उन सर्वरों पर किराए पर लेने के लिए GPU की संख्या जो समर्थन करते हैं आंशिक किराया. पूरे रिग को किराए पर लेने के लिए इसे छोड़ दें। केवल ऑन-डिमांड, केवल समरूप रिग
gpu_indices
[]int
नहीं
किराए पर लेने के लिए 0-आधारित GPU स्लॉट सूचकांक; लंबाई बराबर होनी चाहिए gpu_count. से खाली स्लॉट लें partial_gpu_rental.free_indices. बैकएंड को स्वतः खाली GPU चुनने देने के लिए इसे छोड़ दें
autossh_entrypoint
bool
नहीं
clore.ai entrypoint का उपयोग करें, जो स्वचालित रूप से SSH सर्वर और कस्टम /root/onstart.sh स्क्रिप्ट
* जिन फ़ील्डों पर स्टार है, उनमें आप केवल इस regexp समूह के वर्ण इनपुट कर सकते हैं /^[a-zA-Z0-9\s-=.@+/]+$/
आउटपुट
code
int
स्थिति कोड
उदाहरण
इनपुट 1 (स्पॉट ऑफर बनाएं):
आउटपुट 1 (स्पॉट ऑफर बनाएं):
इनपुट 2 (ऑन-डिमांड ऑर्डर बनाएं):
आउटपुट 2 (ऑन-डिमांड ऑर्डर बनाएं):
11. renter_fees
बारे में
वर्तमान शुल्क कॉन्फ़िगरेशन प्राप्त करें: बेस रेंटर शुल्क, PoH शुल्क कटौती सेटिंग्स, ऑर्डर निर्माण शुल्क, और आपका PoH बैलेंस
हेडर्स
auth
string
हाँ
API टोकन
आउटपुट
code
int
स्थिति कोड
renter_fees.on_demand
object
मुद्रा के अनुसार ऑन-डिमांड ऑर्डरों के लिए आधार शुल्क (%)
renter_fees.spot
object
मुद्रा के अनुसार स्पॉट ऑर्डरों के लिए आधार शुल्क (%)
poh_config.max_reduction_percent
int
PoH के माध्यम से अधिकतम आधार-शुल्क कटौती (%)
poh_config.max_poh_amount
int
PoH बैलेंस जिस पर अधिकतम कटौती प्राप्त होती है
creation_fees.on_demand
object
मुद्रा के अनुसार ऑर्डर निर्माण शुल्क
creation_fees.spot
object
मुद्रा के अनुसार स्पॉट ऑर्डर निर्माण शुल्क
poh_balance
float
आपका PoH CLORE बैलेंस
इनपुट:
आउटपुट:
12. cancel_orders
बारे में
एक साथ कई ऑर्डर रद्द करें (प्रति अनुरोध अधिकतम 256)
हेडर्स
auth
string
हाँ
API टोकन
सामग्री-प्रकार
string
हाँ
होना चाहिए application/json
बॉडी
order_ids
[]int
हाँ
रद्द करने के लिए ऑर्डर IDs, अधिकतम 256
आउटपुट
code
int
स्थिति कोड
failed_to_cancel
[]int
वे ऑर्डर IDs जिन्हें रद्द नहीं किया जा सका
इनपुट:
आउटपुट:
13. poh_balance
बारे में
अपना Proof of Holding बैलेंस प्राप्त करें: आइटम, कुल राशि, और PoH Marketplace प्रस्ताव राशियाँ
हेडर्स
auth
string
हाँ
API टोकन
आउटपुट
code
int
स्थिति कोड
आइटम
[]object
अलग-अलग बैलेंस वाले आपके PoH आइटम
balance.total
float
सभी आइटमों में कुल PoH बैलेंस
balance.free_amount
float
प्रस्तावों में प्रतिबद्ध न किया गया PoH बैलेंस
balance.reward_amount
float
पुरस्कारों के लिए पात्र बैलेंस
balance.offers.rented_amount
float
अन्य उपयोगकर्ताओं को किराए पर दी गई राशि
balance.offers.rented_on_marketplace_amount
float
PoH Marketplace पर सूचीबद्ध राशि
balance.offers.leased_amount
float
अन्य उपयोगकर्ताओं से पट्टे पर ली गई राशि
इनपुट:
आउटपुट:
14. server-config.json
बारे में
स्थिर API कॉन्फ़िगरेशन डेटा प्राप्त करें। किसी प्रमाणीकरण की आवश्यकता नहीं
इनपुट:
15. get_relay
बारे में
अपने पता किए गए देश के लिए TCP फ़ॉरवर्डिंग रिले नोड्स प्राप्त करें। किसी प्रमाणीकरण की आवश्यकता नहीं
आउटपुट
code
int
स्थिति कोड
देश
string
पता किया गया देश कोड
नोड्स
object
उपलब्ध रिले नोड्स
इनपुट:
अंतिम अपडेट
क्या यह उपयोगी था?