API

परिचय
CLORE.AI api का उपयोग आपके वर्कलोड्स को परिनियोजित करने को स्वचालित करने के लिए किया जा सकता है onto CLORE.AI
सबसे पहले आपको एक API कुंजी प्राप्त करने की आवश्यकता है

API प्रतिक्रियाएँ
प्रतिक्रियाएँ JSON फ़ॉर्मेट में लौटती हैं, जिनमें विभिन्न फ़ील्ड हो सकते हैं
हमेशा लौटाया जाने वाला फ़ील्ड code है, जो स्थिति बताता है
code फ़ील्ड
0
सामान्य
1
डेटाबेस त्रुटि
2
अमान्य इनपुट डेटा
3
अमान्य API टोकन
4
अमान्य एन्डपॉइंट
5
1 अनुरोध/सेकंड सीमा पार की गई
6
त्रुटि निर्दिष्ट की गई है त्रुटि फ़ील्ड
एंडपॉइंट्स
1. वॉलेट्स
वॉलेट्सके बारे में
वॉलेट्स और बैलेंस लौटाएँ
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
आउटपुट
code
int
स्थिति कोड
वॉलेट्स
[]string
वॉलेट्स की सरणी
उदाहरण
इनपुट:
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/wallets'आउटपुट:
{
"wallets": [
{
"name": "bitcoin",
"deposit": "tb1q6erw7v02t7hakgmlcl4wfnlykzqj05alndruwr",
"balance": 0.00153176,
"withdrawal_fee": 0.0001
}
],
"code": 0
}2. my_servers
my_serversके बारे में
आपके वे सर्वर लौटाता है जिन्हें आप प्रदान कर रहे हैं clore.ai बाज़ार
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
आउटपुट
code
int
स्थिति कोड
सीमा
int
आपके पास होने वाले अधिकतम सर्वर्स की संख्या
सर्वर
[]string
सर्वरों की सरणी
servers[x].name
स्ट्रिंग
उपयोगकर्ता द्वारा चुना गया सर्वर नाम
servers[x].visibility
स्ट्रिंग
बाज़ार में दृश्यता
servers[x].pricing
[]string
प्रति दिन ऑन-डिमांड कीमत
servers[x].online
बूल
क्या सर्वर ऑनलाइन है
servers[x].min_spot_pricing
[]string
स्पॉट मार्केट पर किराये के लिए न्यूनतम प्रति दिन कीमत
servers[x].init_token
स्ट्रिंग
प्रारंभिककरण टोकन
servers[x].specs
[]string
सर्वर विनिर्देश
उदाहरण
इनपुट:
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/my_servers'आउटपुट:
{
"servers": [
{
"name": "Michael",
"connected": false,
"visibility": "hidden",
"pricing": { "bitcoin": 0, "usd": 0 },
"online": false,
"min_spot_pricing": { "bitcoin": 0, "usd": 0 },
"init_token": "qnwVIMsZPjUWS7jw6gAbTOeoGQNgTH9XVxJaiCEbG0OlmfjF"
},
{
"name": "Jan Vykydal",
"connected": true,
"visibility": "public",
"pricing": { "bitcoin": 0.00010337, "usd": 0 },
"online": false,
"min_spot_pricing": { "bitcoin": 0.00005168, "usd": 0 },
"specs": {
"mb": "Z590 GAMING X",
"cpu": "Intel Core i9-11900",
"cpus": "8/16",
"ram": 64,
"disk": "NVMe 512GB",
"disk_speed": 2000,
"gpu": "1x GeForce GTX 1080 Ti",
"gpuram": 11,
"net": {
"down":119.61,
"up":25.24
}
}
}
],
"limit": 16,
"code": 0
}*USD अभी लागू नहीं किया गया
3. server_config
server_configके बारे में
विशिष्ट सर्वर का कॉन्फ़िगरेशन प्राप्त करें
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
Content-type
स्ट्रिंग
हाँ
होना चाहिए application/json
बॉडी
server_name
स्ट्रिंग
हाँ
सर्वर का नाम
आउटपुट
code
int
स्थिति कोड
creation_completed
बूल
क्या सर्वर निर्माण पूरा हुआ है
config
[]string
सर्वर का कॉन्फ़िग
config.name
स्ट्रिंग
उपयोगकर्ता द्वारा चुना गया सर्वर नाम
config.visibility
स्ट्रिंग
बाज़ार में दृश्यता
config.pricing
[]string
प्रति दिन ऑन-डिमांड कीमत
config.spot_pricing
[]string
स्पॉट मार्केट पर किराये के लिए न्यूनतम प्रति दिन कीमत
config.mrl
int
घंटों में अधिकतम रेंटल अवधि
config.online
बूल
क्या सर्वर ऑनलाइन है
config.id
int
विशिष्ट सर्वर आईडी
config.rental_status
int
0 - किराया नहीं | 1 - स्पॉट मार्केट पर किराए पर | 2 - ऑन-डिमांड पर किराए पर
config.specs
[]string
सर्वर विनिर्देश
config.background_job
[]string
नोट रेंटेड होने पर बैकग्राउंड जॉब
उदाहरण
इनपुट:
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"server_name":"Jan Vykydal"
}' 'https://api.clore.ai/v1/server_config'आउटपुट:
{
"config": {
"name": "Jan Vykydal",
"connected": true,
"visibility": "public",
"pricing": { "bitcoin": 0.00010337, "usd": 0 },
"spot_pricing": { "bitcoin": 0.00005168, "usd": 0 },
"mrl": 72,
"online": false,
"initialized": true,
"id": 4,
"rental_status": 0,
"specs": {
"mb": "Z590 GAMING X",
"cpu": "Intel Core i9-11900",
"cpus": "8/16",
"ram": 64,
"disk": "NVMe 512GB",
"disk_speed": 2000,
"gpu": "1x GeForce GTX 1080 Ti",
"gpuram": 11,
"net": {
"down":119.61,
"up":25.24
}
},
"background_job": {
"times_updated": 1,
"image": "cloreai/ubuntu20.04-jupyter",
"command": "",
"env": []
}
},
"creation_completed": true,
"code": 0
}*USD अभी लागू नहीं किया गया
4. बाज़ार
बाज़ारके बारे में
बाज़ार प्राप्त करें
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
आउटपुट
code
int
स्थिति कोड
my_servers
[]string
सर्वर आईडी की सरणी जिन्हें आप प्रदान कर रहे हैं clore.ai (किराए पर नहीं दिए जा सकते)
सर्वर
[]string
बाज़ार पर सार्वजनिक सर्वरों की सरणी
servers[x].id
int
विशिष्ट सर्वर आईडी
servers[x].owner
int
विशिष्ट मालिक आईडी
servers[x].mrl
int
घंटों में अधिकतम रेंटल अवधि
servers[x].price.on_demand
[]string
ऑन-डिमांड प्रति दिन कीमत
servers[x].spot
[]string
स्पॉट मार्केट पर न्यूनतम प्रति दिन कीमत
servers[x].rented
बूल
क्या सर्वर ऑन-डिमांड किराए पर है
servers[x].specs
[]string
सर्वर विनिर्देश
उदाहरण
बाज़ार प्राप्त करें
इनपुट:
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/marketplace'आउटपुट:
{
"servers": [
{
"id": 6,
"owner": 4,
"mrl": 73,
"price": { "on_demand": { "bitcoin": 0.00001 },
"spot": { "bitcoin": 0.000001 }},
"rented": false,
"specs": {
"mb": "Z590 GAMING X",
"cpu": "11th Gen Intel(R) Core(TM) i9-11900 @ 2.50GHz",
"cpus": "8/16",
"ram": 62.67348861694336,
"disk": "NVMe disk 247.3623046875GB",
"disk_speed": 0,
"gpu": "1x NVIDIA GeForce GTX 1080 Ti",
"gpuram": 11,
"net": {
"up": 26.38,
"down": 118.42,
"cc": "CZ"
}
}
}
],
"my_servers": [1, 2, 4],
"code": 0
}5. my_orders
my_ordersके बारे में
अपने ऑर्डर प्राप्त करें
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
क्वेरी स्ट्रिंग
return_completed
बूल
नहीं
पूरा (समाप्त) ऑर्डर लौटाएँ
आउटपुट
code
int
स्थिति कोड
सीमा
int
सक्रिय ऑर्डरों की अधिकतम गिनती
orders
[]string
ऑर्डर्स की सरणी
orders[x].id
int
विशिष्ट ऑर्डर आईडी
orders[x].price
फ्लोट
ऑर्डर कीमत (लागत) प्रति दिन
orders[x].mrl
int
सेकंड में अधिकतम ऑर्डर रेंटल अवधि
orders[x].image
स्ट्रिंग
उपयोग किया गया डॉकर इमेज
orders[x].currency
स्ट्रिंग
बिलिंग के लिए उपयोग की जाने वाली मुद्रा
orders[x].spend
फ्लोट
ऑर्डर पर खर्च की गई राशि
orders[x].ct
int
निर्माण समय (UNIX समय)
orders[x].p
int
वर्तमान में उपयोग किया जा रहा प्रॉक्सी क्लस्टर
orders[x].specs
[]string
सर्वर विनिर्देश
orders[x].si
int
विशिष्ट सर्वर आईडी
orders[x].pub_cluster
[]string
फॉरवर्ड किए गए पोर्ट के साथ सार्वजनिक एंडपॉइंट्स
orders[x].tcp_ports
[]string
TCP पोर्ट फॉरवर्डिंग
orders[x].http_port
स्ट्रिंग
HTTPS प्रॉक्सी के माध्यम से फॉरवर्ड किया गया कंटेनर पोर्ट
orders[x].spot
बूल
यह इंगित करता है कि यह स्पॉट ऑर्डर है
orders[x].expired
बूल
यह संकेत कि ऑर्डर की अवधि समाप्त हो गई है
इनपुट:
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/my_orders?return_completed=true'आउटपुट:
{
"orders": [
{
"id": 38,
"fee": 5,
"creation_fee": 3e-7,
"price": 0.00001,
"mrl": 262800,
"image": "cloreai/ubuntu20.04-jupyter",
"currency": "bitcoin",
"spend": 6.944444444444445e-9,
"ct": 1667401396,
"p": 1,
"specs": {
"mb": "Z590 GAMING X",
"cpu": "11th Gen Intel(R) Core(TM) i9-11900 @ 2.50GHz",
"cpus": "8/16",
"ram": 62.67348861694336,
"disk": "NVMe disk 247.3623046875GB",
"disk_speed": 2000,
"gpu": "1x NVIDIA GeForce GTX 1080 Ti",
"gpuram": 11,
"net": {
"up": 26.38,
"down": 118.42,
}
},
"si": 6,
"pub_cluster": [ "n1.c1.clorecloud.net", "n2.c1.clorecloud.net" ],
"tcp_ports": [ "22:10000" ],
"http_port": "8888"
},{
"id": 36,
"fee": 2.5,
"creation_fee": 1e-7,
"price": 0.00001,
"mrl": 262800,
"image": "cloreai/ubuntu20.04-jupyter",
"currency": "bitcoin",
"spend": 1.3888888888888888e-7,
"ct": 1667248597,
"specs": {
"mb": "Z590 GAMING X",
"cpu": "11th Gen Intel(R) Core(TM) i9-11900 @ 2.50GHz",
"cpus": "8/16",
"ram": 62.67348861694336,
"disk": "NVMe disk 247.3623046875GB",
"disk_speed": 2000,
"gpu": "1x NVIDIA GeForce GTX 1080 Ti",
"gpuram": 11,
"net": {
"up": 26.38,
"down": 118.42,
}
},
"si": 6,
"spot": true,
"expired": true,
"tcp_ports": []
}
],
"limit": 13,
"code": 0
}6. spot_marketplace
spot_marketplaceके बारे में
विशिष्ट सर्वर के लिए स्पॉट बाज़ार प्राप्त करें
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
क्वेरी स्ट्रिंग
बाज़ार
int
हाँ
विशिष्ट सर्वर आईडी
आउटपुट
code
int
स्थिति कोड
मौजूद है
बूल
सत्यापन कि बाजार मौजूद है
बाज़ार
वस्तु
बाज़ार
market.offers
सरणी
सर्वर के लिए किराये के ऑफ़र
market.offers[x].offer_id
int
विशिष्ट ऑफ़र आईडी
market.offers[x].bid
फ्लोट
प्रस्तावित प्रति दिन कीमत
market.offers[x].active
बूल
यह ऑफ़र वर्तमान में उपयोग में है
market.offers[x].my
बूल
यह ऑफ़र मेरे द्वारा स्वामित्व में है
market.server
वस्तु
सर्वर जानकारी
market.server.min_pricing
वस्तु
न्यूनतम ऑफ़र प्रति दिन कीमत
market.server.mrl
int
सेकंड में अधिकतम रेंटल अवधि
market.server.visibility
स्ट्रिंग
आप केवल तभी ऑफ़र बना सकते हैं जब दृश्यता सार्वजनिक हो
market.server.online
बूल
सर्वर ऑनलाइन है
इनपुट:
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/spot_marketplace?market=6'आउटपुट:
{
"market": {
"offers": [
{
"offer_id": 39,
"bid": 0.0000042,
"active": true,
"my": true
}
],
"server": {
"min_pricing": {
"bitcoin": 0.000001
},
"mrl": 262800,
"visibility": "public",
"online": true
}
},
"exists": true,
"code": 0
}7. set_server_settings
set_server_settingsके बारे में
उन सर्वरों की सेटिंग्स कॉन्फ़िगर करें जिन्हें आप प्रदान कर रहे हैं पर clore.ai बाज़ार
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
Content-type
स्ट्रिंग
हाँ
होना चाहिए application/json
बॉडी
नाम
स्ट्रिंग
हाँ
उपयोगकर्ता द्वारा चुना गया सर्वर नाम
उपलब्धता
बूल
हाँ
क्या सर्वर किराए पर दिया जा सकता है
mrl
int
हाँ
अधिकतम सर्वर रेंटल अवधि
on_demand
फ्लोट
हाँ
आपके सर्वर के लिए ऑन-डिमांड प्रति दिन कीमत
spot
फ्लोट
हाँ
SPOT ऑफ़र के लिए न्यूनतम प्रति दिन कीमत
आउटपुट
code
int
स्थिति कोड
उदाहरण
आइए वर्तमान वॉलेट से भेजे गए लेनदेन के लिए एक भेजने का प्रमाण बनाएं।
इनपुट:
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"name": "Jan Vykydal",
"availability":true,
"mrl":96,
"on_demand":0.0001,
"spot":0.00000113
}' 'https://api.clore.ai/v1/set_server_settings'आउटपुट:
{
"code": 0
}8. set_spot_price
set_spot_priceके बारे में
आपके SPOT मार्केट ऑफ़र पर प्रति दिन कीमत सेट करें
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
Content-type
स्ट्रिंग
हाँ
होना चाहिए application/json
बॉडी
order_id
int
हाँ
विशिष्ट ऑफ़र आईडी
desired_price
फ्लोट
हाँ
आपकी प्रस्तावित प्रति दिन कीमत
उदाहरण
आइए स्पॉट मार्केट कीमत अपडेट करने का प्रयास करें
इनपुट 1 (कदम घटाना बहुत बड़ा था):
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":39,
"desired_price":0.00000200
}' 'https://api.clore.ai/v1/set_spot_price'संभव आउटपुट 1 (कदम घटाना बहुत बड़ा था): आप स्पॉट मार्केट ऑफ़र की कीमत अधिकतम 0.00000100 ₿ से कम कर सकते हैं
code
int
स्थिति कोड
त्रुटि
स्ट्रिंग
त्रुटि विवरण फ़ील्ड
max_step
फ्लोट
निकटतम संभव न्यूनतम मान जिसे आप वर्तमान में कीमत कम कर सकते हैं
{
"error":"exceeded_max_step",
"max_step":0.0000032,
"code":6
}इनपुट 2 (मान्य कीमत कदम घटाना):
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":39,
"desired_price":0.00000320
}' 'https://api.clore.ai/v1/set_spot_price'संभव आउटपुट 2 (मान्य कीमत कदम घटाना):
{
"code": 0
}इनपुट 3 (इनपुट 2 भेजने के बाद कीमत और भी कम करें):
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":39,
"desired_price":0.00000220
}' 'https://api.clore.ai/v1/set_spot_priceसंभव आउटपुट 3 (इनपुट 2 भेजने के बाद कीमत और भी कम करें): आप स्पॉट कीमत 600 सेकंड में एक बार ही कम कर सकते हैं
code
int
स्थिति कोड
त्रुटि
स्ट्रिंग
त्रुटि विवरण फ़ील्ड
time_to_lowering
फ्लोट
अगली कीमत कम करने की संभावना तक शेष समय (सेकंड)
{
"error":"can_lower_every_600_seconds",
"time_to_lowering":513,
"code":6
}9. cancel_order
cancel_orderके बारे में
आपके SPOT मार्केट ऑफ़र पर प्रति दिन कीमत सेट करें
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
Content-type
स्ट्रिंग
हाँ
होना चाहिए application/json
बॉडी
id
int
हाँ
विशिष्ट ऑर्डर/ऑफ़र आईडी
issue
स्ट्रिंग
नहीं
यदि आपको सर्वर के साथ कोई समस्या आई है तो आप उन्हें टीम को रिपोर्ट कर सकते हैं, अधिकतम 2048 अक्षर clore.ai टीम, अधिकतम 2048 अक्षर
आउटपुट
code
int
स्थिति कोड
उदाहरण
ऑर्डर/ऑफ़र रद्द करें
इनपुट: इस उदाहरण में हम GPU #1 के साथ समस्याओं की रिपोर्ट कर रहे हैं, यदि आपकी कोई समस्या नहीं है, तो issue फ़ील्ड न शामिल करें। आप टेक्स्ट फ़ील्ड में कोई भी संदेश लिख सकते हैं और हम इसकी जाँच करेंगे
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"id":39,
"issue":"GPU #1 Was overheating and throttling"
}' 'https://api.clore.ai/v1/cancel_order'आउटपुट:
{
"code": 0
}10. create_order
create_orderके बारे में
आप इस एन्डपॉइंट से स्पॉट ऑफ़र या ऑन-डिमांड ऑर्डर बना सकते हैं यह एन्डपॉइंट भी 5 सेकंड में केवल 1 अनुरोध की अनुमति देता है
हैडर
auth
स्ट्रिंग
हाँ
API टोकन
Content-type
स्ट्रिंग
हाँ
होना चाहिए application/json
बॉडी
currency
स्ट्रिंग
हाँ
मुद्रा का नाम
image
स्ट्रिंग
हाँ
dockerhub से वैध इमेज
renting_server
int
हाँ
जिस सर्वर को आप किराए पर लेना चाहते हैं उसकी ID
type
स्ट्रिंग
हाँ
on-demand या spot
spotprice
फ्लोट
निर्भर करता है
स्पॉट मार्केट पर प्रस्तावित प्रति दिन कीमत, स्पॉट ऑर्डर बनाते समय आवश्यक
ports
वस्तु
नहीं
पोर्ट फॉरवर्डिंग कॉन्फ़िगरेशन, अधिकतम 5 प्रविष्टियाँ
env
वस्तु
नहीं
पर्यावरण चर, स्ट्रिंग बनाई जाने पर कुल मिलाकर 12000 अक्षरों तक सीमित। वेरिएबल नाम - अधिकतम 128 संकेत वेरिएबल मान - अधिकतम 1536 संकेत
jupyter_token
स्ट्रिंग
नहीं
जुपिटर टोकन उन इमेजों के लिए जिनमें जुपिटर नोटबुक हैं, अधिकतम 32 अक्षर *
ssh_key
स्ट्रिंग
नहीं
SSH की उन इमेजों के लिए जिनमें SSH है, अधिकतम 3072 अक्षर *
ssh_password
स्ट्रिंग
नहीं
SSH पासवर्ड उन इमेजों के लिए जिनमें SSH है, अधिकतम 32 अक्षर *
command
स्ट्रिंग
नहीं
ऑर्डर निर्माण के बाद सर्वर पर कमांड चलाया जाएगा
required_price
फ्लोट
नहीं
जिस कीमत पर आप ऑर्डर शुरू करना चाहते हैं उसे निर्दिष्ट करें, यदि मशीन मालिक कीमत बदलता है, तो ऑर्डर शुरू नहीं होगा (केवल ऑन-डिमांड)
autossh_entrypoint
बूल
नहीं
clore.ai एंट्रीपॉइंट का उपयोग करें, जो स्वचालित रूप से SSH सर्वर और कस्टम को परिनियोजित करता है /root/onstart.sh स्क्रिप्ट
* स्टार चिह्नित फ़ील्डों में आप केवल इस regexp समूह के वर्ण इनपुट कर सकते हैं /^[a-zA-Z0-9\s-=.@+/]+$/
आउटपुट
code
int
स्थिति कोड
उदाहरण
इनपुट 1 (स्पॉट ऑफ़र बनाएं):
curl -XPOST -H 'auth: 6FcuR7ibcwKR1Z32lEFoSotzUUtzKO2H' -H "Content-type: application/json" -d '
{
"currency":"bitcoin",
"image":"cloreai/ubuntu20.04-jupyter",
"renting_server":6,
"type":"spot",
"spotprice":0.000001,
"ports":{
"22":"tcp",
"8888":"http"
},
"env":{
"VARIABLE_NAME":"VARIABLE_VALUE",
},
"jupyter_token":"hoZluOjbCOQ5D5yH7R",
"ssh_password":"Hpcj08ZaOpCbTmn1Eu",
"command":"#!/bin/sh\napt update -y && apt install htop"
}' 'https://api.clore.ai/v1/create_order'आउटपुट 1 (स्पॉट ऑफ़र बनाएं):
{
"code":0
}इनपुट 2 (ऑन-डिमांड ऑर्डर बनाएं):
curl -XPOST -H 'auth: 6FcuR7ibcwKR1Z32lEFoSotzUUtzKO2H' -H "Content-type: application/json" -d '
{
"currency":"bitcoin",
"image":"cloreai/ubuntu20.04-jupyter",
"renting_server":6,
"type":"on-demand",
"ports":{
"22":"tcp",
"8888":"http"
},
"env":{
"VARIABLE_NAME":"VARIABLE_VALUE",
},
"jupyter_token":"hoZluOjbCOQ5D5yH7R",
"ssh_password":"Hpcj08ZaOpCbTmn1Eu",
"command":"#!/bin/sh\napt update -y && apt install htop"
}' 'https://api.clore.ai/v1/create_order'आउटपुट 2 (ऑन-डिमांड ऑर्डर बनाएं):
{
"code":0
}Last updated
Was this helpful?