API
💡 Développeurs Python : Utilisez le SDK officiel SDK Python clore-ai au lieu d'appels API bruts. Il gère automatiquement l'authentification, la limitation du débit, les nouvelles tentatives et la gestion des erreurs.
Démarrage rapide :
pip install clore-ai— Voir la documentation du SDK Python et Référence du CLI.
🧭 Vous préférez une référence consultable ? Ouvrez la documentation API interactive à clore.ai/api-docs. URL de base pour tous les points de terminaison de cette page :
https://api.clore.ai/v1/.
Introduction
CLORE.AI L'API peut être utilisée pour automatiser le déploiement de vos charges de travail sur CLORE.AI
Tout d'abord, vous devez obtenir une clé API
Réponses de l'API
Les réponses sont renvoyées au format JSON et peuvent comporter différents champs
Le champ toujours renvoyé est code, indiquant le statut
champ code
0
NORMAL
1
ERREUR DE BASE DE DONNÉES
2
DONNÉES D'ENTRÉE INVALIDES
3
JETON API INVALIDE
4
POINT DE TERMINAISON INVALIDE
5
Limite de 1 requête/seconde dépassée
6
Erreur spécifiée dans erreur champ
Points de terminaison
1. portefeuilles
À propos
Renvoie les portefeuilles et les soldes
En-têtes
auth
chaîne
Oui
jeton API
Sortie
code
int
Code d'état
portefeuilles
[]string
Tableau de portefeuilles
Exemple
Entrée :
Sortie :
2. mes serveurs
À propos
Renvoie les serveurs que vous mettez à disposition pour clore.ai place de marché
En-têtes
auth
chaîne
Oui
jeton API
Sortie
code
int
Code d'état
limite
int
Nombre maximal de serveurs que vous pouvez posséder
serveurs
[]string
Tableau de serveurs
servers[x].name
chaîne
Nom du serveur sélectionné par l'utilisateur
servers[x].visibility
chaîne
Visibilité sur la place de marché
servers[x].pricing
[]string
Prix/jour à la demande
servers[x].online
bool
Le serveur est-il en ligne
servers[x].min_spot_pricing
[]string
Prix minimal/jour pour louer sur le marché spot
servers[x].init_token
chaîne
Jeton d'initialisation
servers[x].specs
[]string
Spécifications du serveur
servers[x].remaining_time
int
Heure de fin de location de la dernière commande active (époque en ms, 0 lorsqu'il n'est pas loué)
servers[x].rental_state
chaîne
État agrégé de location des GPU : aucun, partiel, ou complet
servers[x].rented_gpus
int
GPU actuellement loués dans les commandes actives
servers[x].total_gpus
int
Nombre total de GPU sur le serveur
servers[x].rented_price_by_currency
objet
Somme des prix des commandes actives par devise
servers[x].update_channel
chaîne
Canal de mise à jour de l'agent d'hébergement : stable ou bêta
servers[x].requested_channel
chaîne
Changement de canal demandé depuis l'interface web (présent uniquement lorsqu'il est demandé)
servers[x].target_backend_version
int
Version du backend visée par le canal actuel
Exemple
Entrée :
Sortie :
Les valeurs USD dans les objets pricing reflètent le mode de tarification basé sur l'USD lorsque l'hôte l'a activé.
3. configuration du serveur
À propos
Obtenir la configuration d'un serveur spécifique
En-têtes
auth
chaîne
Oui
jeton API
Type de contenu
chaîne
Oui
Doit être application/json
Corps
server_name
chaîne
Oui
Nom du serveur
Sortie
code
int
Code d'état
creation_completed
bool
La création du serveur est-elle terminée
config
[]string
Configuration du serveur
config.name
chaîne
Nom du serveur sélectionné par l'utilisateur
config.visibility
chaîne
Visibilité sur la place de marché
config.pricing
[]string
Prix/jour à la demande
config.spot_pricing
[]string
Prix minimal/jour pour louer sur le marché spot
config.mrl
int
Durée maximale de location en heures
config.online
bool
Le serveur est-il en ligne
config.id
int
ID de serveur unique
config.rental_status
int
0 - non loué | 1 - Loué sur le marché spot | 2 - Loué à la demande
config.specs
[]string
Spécifications du serveur
config.background_job
[]string
Tâche d'arrière-plan lorsqu'il n'est pas loué
config.tenants
[]object
Commandes actives sur le serveur : rental_type, currency, prix, remaining_time, gpu_count
configuration du serveurrenvoie également les mêmes champs d'état de location et de canal de mise à jour quemes serveurs:remaining_time,rental_state,rented_gpus,total_gpus,rented_price_by_currency,update_channel,requested_channel,target_backend_version.
Exemple
Entrée :
Sortie :
Les valeurs USD dans les objets pricing reflètent le mode de tarification basé sur l'USD lorsque l'hôte l'a activé.
4. place de marché
À propos
Obtenir la place de marché
En-têtes
auth
chaîne
Oui
jeton API
Sortie
code
int
Code d'état
mes serveurs
[]string
Tableau des identifiants de serveurs que vous mettez à disposition pour clore.ai (ne peut pas être loué)
serveurs
[]string
Tableau des serveurs publics sur la place de marché
servers[x].id
int
ID de serveur unique
servers[x].owner
int
Identifiant unique du propriétaire
servers[x].mrl
int
Durée maximale de location en heures
servers[x].price.on_demand
[]string
Prix à la demande par jour
servers[x].spot
[]string
Prix minimal par jour sur le marché spot
servers[x].rented
bool
Le serveur est-il loué à la demande
servers[x].specs
[]string
Spécifications du serveur
servers[x].partial_gpu_rental
objet | bool
faux lorsque la location partielle n'est pas disponible, sinon { total_gpus, available_gpus, free_indices }
Exemple
Obtenir la place de marché
Entrée :
Sortie :
5. my_orders
À propos
Obtenez vos commandes
En-têtes
auth
chaîne
Oui
jeton API
Chaîne de requête
return_completed
bool
Non
Renvoie les commandes terminées (expirées)
Sortie
code
int
Code d'état
limite
int
Nombre maximal de commandes actives
commandes
[]string
Tableau de commandes
orders[x].id
int
ID de commande unique
orders[x].price
float
Prix de la commande (coût) par jour
orders[x].mrl
int
Durée maximale de location de la commande en secondes
orders[x].image
chaîne
Image Docker utilisée
orders[x].currency
chaîne
Devise utilisée pour la facturation
orders[x].spend
float
Argent dépensé pour la commande
orders[x].ct
int
Heure de création (heure UNIX)
orders[x].p
int
Cluster de proxy actuellement utilisé
orders[x].specs
[]string
Spécifications du serveur
orders[x].si
int
ID de serveur unique
orders[x].pub_cluster
[]string
Points de terminaison publics avec ports transférés
orders[x].tcp_ports
[]string
Transfert de ports TCP
orders[x].http_port
chaîne
Port du conteneur transféré via un proxy HTTPS
orders[x].spot
bool
Indication qu'il s'agit d'une commande spot
orders[x].expired
bool
Indication que la commande a expiré
Entrée :
Sortie :
6. marché spot
À propos
Obtenir le marché spot pour un serveur spécifique
En-têtes
auth
chaîne
Oui
jeton API
Chaîne de requête
marché
int
Oui
ID de serveur unique
Sortie
code
int
Code d'état
existe
bool
Vérification que le marché existe
marché
objet
Marketplace
market.offers
tableau
Offres de location pour le serveur
market.offers[x].offer_id
int
Identifiant unique de l'offre
market.offers[x].bid
float
Prix proposé par jour
market.offers[x].active
bool
Cette offre est actuellement utilisée
market.offers[x].my
bool
Cette offre m'appartient
market.server
objet
Informations sur le serveur
market.server.min_pricing
objet
Prix minimal de l'offre par jour
market.server.mrl
int
Durée maximale de location en secondes
market.server.visibility
chaîne
Vous ne pouvez créer des offres que lorsque la visibilité est publique
market.server.online
bool
Le serveur est en ligne
Entrée :
Sortie :
7. set_server_settings
À propos
Configurez les paramètres du serveur que vous mettez à disposition sur clore.ai place de marché
En-têtes
auth
chaîne
Oui
jeton API
Type de contenu
chaîne
Oui
Doit être application/json
Corps
nom
chaîne
Oui
Nom du serveur sélectionné par l'utilisateur
Disponibilité
bool
Oui
Le serveur peut-il être loué
mrl
int
Oui
Durée maximale de location du serveur
À la demande
float
Oui
Prix par jour pour votre serveur à la demande
Spot
float
Oui
Prix minimum par jour pour une offre SPOT
Les prix journaliers sont plafonnés à 0,015 BTC / 600 000 CLORE / 1 000 USD.
Sortie
code
int
Code d'état
Exemple
Créons une preuve d'envoi pour une transaction envoyée depuis le portefeuille actuel.
Entrée :
Sortie :
8. set_spot_price
À propos
Définissez le prix par jour de votre offre sur le marché spot
En-têtes
auth
chaîne
Oui
jeton API
Type de contenu
chaîne
Oui
Doit être application/json
Corps
order_id
int
Oui
Identifiant unique de l'offre
desired_price
float
Oui
Votre prix proposé par jour
Exemple
Essayons de mettre à jour le prix du marché spot
Entrée 1 (La diminution était trop importante) :
Sortie possible 1 (La diminution était trop importante) : Vous pouvez baisser le prix de l'offre sur le marché spot d'au maximum 0.00000100 ₿
code
int
Code d'état
erreur
chaîne
Champ de description de l'erreur
max_step
float
Valeur minimale jusqu'à laquelle vous pouvez actuellement baisser le prix
Entrée 2 (Baisse de prix valide) :
Sortie possible 2 (Baisse de prix valide) :
Entrée 3 (Baisser encore plus le prix après l'envoi de l'entrée 2) :
Sortie possible 3 (Baisser encore plus le prix après l'envoi de l'entrée 2) : Vous pouvez baisser le prix spot une fois toutes les 600 secondes
code
int
Code d'état
erreur
chaîne
Champ de description de l'erreur
time_to_lowering
float
Temps restant (en s) jusqu'à la prochaine possibilité de baisser le prix
9. cancel_order
À propos
Annuler une commande active ou une offre spot
En-têtes
auth
chaîne
Oui
jeton API
Type de contenu
chaîne
Oui
Doit être application/json
Corps
id
int
Oui
ID unique de commande/offre
issue
chaîne
Non
Si vous avez rencontré des problèmes avec le serveur, vous pouvez les signaler à clore.ai équipe, 2048 caractères maximum
Sortie
code
int
Code d'état
Exemple
Annuler la commande/l'offre
Entrée : Dans cet exemple, nous signalons des problèmes avec le GPU #1 ; si vous n'avez pas de problème, n'incluez pas le champ issue. Vous pouvez écrire n'importe quel संदेश ?
Sortie :
10. create_order
À propos
Vous pouvez créer une offre spot ou une commande à la demande avec ce point de terminaison Ce point de terminaison n'autorise également qu'une requête toutes les 5 secondes
En-têtes
auth
chaîne
Oui
jeton API
Type de contenu
chaîne
Oui
Doit être application/json
Corps
currency
chaîne
Oui
Nom de la devise
image
chaîne
Oui
Image valide provenant de Docker Hub
renting_server
int
Oui
ID du serveur que vous souhaitez louer
type
chaîne
Oui
on-demand OU Spot
spotprice
float
Dépend
Prix proposé par jour sur le marché spot, requis lors de la création d'une commande spot
ports
objet
Non
Configuration du transfert de ports, 5 enregistrements maximum
env
objet
Non
Variables d'environnement, limitées à 12000 caractères au total une fois sérialisées. Nom de variable - 128 symboles max Valeur de variable - 1536 symboles max
jupyter_token
chaîne
Non
Jeton Jupyter pour les images contenant des notebooks Jupyter, 32 caractères maximum *
ssh_key
chaîne
Non
Clé SSH pour les images avec SSH, 3072 caractères maximum *
ssh_password
chaîne
Non
Mot de passe SSH pour les images avec SSH, 32 caractères maximum *
command
chaîne
Non
La commande sera exécutée sur le serveur après la création de la commande
required_price
float
Non
Spécifiez le prix auquel vous souhaitez lancer la commande ; si le propriétaire de la machine change le prix, la commande ne démarrera pas (à la demande uniquement)
gpu_count
int
Non
Nombre de GPU à louer sur les serveurs qui prennent en charge la location partielle. Omettez pour louer l'ensemble du rig. Uniquement à la demande, uniquement des rigs homogènes
gpu_indices
[]int
Non
Indices de slots GPU à louer, basés sur 0 ; la longueur doit être égale à gpu_count. Prenez les emplacements libres depuis partial_gpu_rental.free_indices. Omettez pour laisser le backend choisir automatiquement les GPU libres
autossh_entrypoint
bool
Non
Utilisez le point d'entrée clore.ai, qui déploie automatiquement un serveur SSH et un script personnalisé /root/onstart.sh script
* Pour les champs marqués d'une étoile, vous ne pouvez saisir que des caractères provenant de ce groupe regexp /^[a-zA-Z0-9\s-=.@+/]+$/
Sortie
code
int
Code d'état
Exemple
Entrée 1 (Créer une offre spot) :
Sortie 1 (Créer une offre spot) :
Entrée 2 (Créer une commande à la demande) :
Sortie 2 (Créer une commande à la demande) :
11. renter_fees
À propos
Obtenez la configuration actuelle des frais : frais de base du locataire, paramètres de réduction des frais PoH, frais de création de commande et votre solde PoH
En-têtes
auth
chaîne
Oui
jeton API
Sortie
code
int
Code d'état
renter_fees.on_demand
objet
Frais de base (%) par devise pour les commandes à la demande
renter_fees.spot
objet
Frais de base (%) par devise pour les commandes spot
poh_config.max_reduction_percent
int
Réduction maximale des frais de base via PoH (%)
poh_config.max_poh_amount
int
Solde PoH à partir duquel la réduction maximale est atteinte
creation_fees.on_demand
objet
Frais de création de commande par devise
creation_fees.spot
objet
Frais de création de commande spot par devise
poh_balance
float
Votre solde PoH CLORE
Entrée :
Sortie :
12. cancel_orders
À propos
Annuler plusieurs commandes à la fois (jusqu'à 256 par requête)
En-têtes
auth
chaîne
Oui
jeton API
Type de contenu
chaîne
Oui
Doit être application/json
Corps
order_ids
[]int
Oui
IDs des commandes à annuler, 256 maximum
Sortie
code
int
Code d'état
failed_to_cancel
[]int
IDs des commandes qui n'ont pas pu être annulées
Entrée :
Sortie :
13. poh_balance
À propos
Obtenez votre solde Proof of Holding : éléments, totaux et montants des offres PoH Marketplace
En-têtes
auth
chaîne
Oui
jeton API
Sortie
code
int
Code d'état
items
[]object
Vos éléments PoH avec soldes individuels
balance.total
float
Solde PoH total pour tous les éléments
balance.free_amount
float
Solde PoH non engagé dans des offres
balance.reward_amount
float
Solde éligible aux récompenses
balance.offers.rented_amount
float
Montant loué à d'autres utilisateurs
balance.offers.rented_on_marketplace_amount
float
Montant mis en vente sur le PoH Marketplace
balance.offers.leased_amount
float
Montant loué auprès d'autres utilisateurs
Entrée :
Sortie :
14. server-config.json
À propos
Obtenez les données de configuration statiques de l'API. Aucune authentification requise
Entrée :
15. get_relay
À propos
Obtenez les nœuds relais de transfert TCP pour votre pays détecté. Aucune authentification requise
Sortie
code
int
Code d'état
country
chaîne
Code du pays détecté
nodes
objet
Nœuds relais disponibles
Entrée :
Mis à jour
Ce contenu vous a-t-il été utile ?