API
💡 Python-Entwickler: Verwenden Sie das offizielle clore-ai Python SDK anstatt roher API-Aufrufe. Es übernimmt Authentifizierung, Ratenbegrenzung, Wiederholungsversuche und Fehlerbehandlung automatisch.
Schnellstart:
pip install clore-ai— Siehe die Python SDK-Dokumentation und CLI-Referenz.
🧭 Bevorzugen Sie eine durchsuchbare Referenz? Öffnen Sie die interaktiven API-Dokumente unter clore.ai/api-docs. Basis-URL für alle Endpunkte auf dieser Seite:
https://api.clore.ai/v1/.
Einführung
CLORE.AI Die API kann zur Automatisierung von Bereitstellungen Ihrer Workloads auf CLORE.AI
Zunächst müssen Sie einen API-Schlüssel erhalten
API-Antworten
Antworten werden im JSON-Format zurückgegeben und können unterschiedliche Felder haben
Das immer zurückgegebene Feld ist code und zeigt den Status an
code-Feld
0
NORMAL
1
DATENBANKFEHLER
2
UNGÜLTIGE EINGABEDATEN
3
UNGÜLTIGES API-TOKEN
4
UNGÜLTIGER ENDPOINT
5
Limit von 1 Anfrage/Sekunde überschritten
6
Fehler angegeben in Fehler Feld
Endpunkte
1. wallets
Über
Gibt Wallets und Guthaben zurück
Header
auth
Zeichenkette
Ja
API-Token
Ausgabe
code
int
Statuscode
wallets
[]string
Array von Wallets
Beispiel
Eingabe:
Ausgabe:
2. my_servers
Über
Gibt Ihre Server zurück, die Sie bereitstellen an clore.ai Marktplatz
Header
auth
Zeichenkette
Ja
API-Token
Ausgabe
code
int
Statuscode
Limit
int
Maximale Anzahl von Servern, die Sie besitzen können
Server
[]string
Array von Servern
servers[x].name
Zeichenkette
Vom Benutzer gewählter Servername
servers[x].visibility
Zeichenkette
Sichtbarkeit im Marktplatz
servers[x].pricing
[]string
Preis/Tag bei On-Demand
servers[x].online
bool
Ist der Server online
servers[x].min_spot_pricing
[]string
Minimaler Preis/Tag zum Mieten im Spot-Markt
servers[x].init_token
Zeichenkette
Initialisierungstoken
servers[x].specs
[]string
Serverspezifikationen
servers[x].remaining_time
int
Endzeit der Miete der letzten aktiven Bestellung (ms seit Epoch, 0 wenn nicht gemietet)
servers[x].rental_state
Zeichenkette
Aggregierter GPU-Mietstatus: keine, teilweiseoder vollständig
servers[x].rented_gpus
int
Aktuell über aktive Bestellungen gemietete GPUs
servers[x].total_gpus
int
Gesamtzahl der GPUs auf dem Server
servers[x].rented_price_by_currency
Objekt
Summe der aktiven Bestellpreise, nach Währungsschlüssel
servers[x].update_channel
Zeichenkette
Aktualisierungskanal des Hosting-Agenten: stabil oder Beta
servers[x].requested_channel
Zeichenkette
Vom Web-UI angeforderter Kanalwechsel (nur vorhanden, wenn angefordert)
servers[x].target_backend_version
int
Backend-Version, auf die der aktuelle Kanal zielt
Beispiel
Eingabe:
Ausgabe:
USD-Werte in pricing Objekten spiegeln den USD-basierten Preis-Modus wider, wenn der Host ihn aktiviert hat.
3. server_config
Über
Konfiguration eines bestimmten Servers abrufen
Header
auth
Zeichenkette
Ja
API-Token
Content-type
Zeichenkette
Ja
Muss application/json
Body
server_name
Zeichenkette
Ja
Servername
Ausgabe
code
int
Statuscode
creation_completed
bool
Ist die Servererstellung abgeschlossen
config
[]string
Konfiguration des Servers
config.name
Zeichenkette
Vom Benutzer gewählter Servername
config.visibility
Zeichenkette
Sichtbarkeit im Marktplatz
config.pricing
[]string
Preis/Tag bei On-Demand
config.spot_pricing
[]string
Minimaler Preis/Tag zum Mieten im Spot-Markt
config.mrl
int
Maximale Mietdauer in Stunden
config.online
bool
Ist der Server online
config.id
int
Eindeutige Server-ID
config.rental_status
int
0 - nicht gemietet | 1 - Auf dem Spot-Markt gemietet | 2 - On-Demand gemietet
config.specs
[]string
Serverspezifikationen
config.background_job
[]string
Hintergrundauftrag, wenn nicht gemietet
config.tenants
[]Objekt
Aktive Bestellungen auf dem Server: rental_type, currency, price, remaining_time, gpu_count
server_configliefert außerdem dieselben rental_state- und update_channel-Felder zurück wiemy_servers:remaining_time,rental_state,rented_gpus,total_gpus,rented_price_by_currency,update_channel,requested_channel,target_backend_version.
Beispiel
Eingabe:
Ausgabe:
USD-Werte in pricing Objekten spiegeln den USD-basierten Preis-Modus wider, wenn der Host ihn aktiviert hat.
4. Marktplatz
Über
Marktplatz abrufen
Header
auth
Zeichenkette
Ja
API-Token
Ausgabe
code
int
Statuscode
my_servers
[]string
Array von Server-IDs, die Sie bereitstellen an clore.ai (kann nicht gemietet werden)
Server
[]string
Array öffentlicher Server auf dem Marktplatz
servers[x].id
int
Eindeutige Server-ID
servers[x].owner
int
Eindeutige Besitzer-ID
servers[x].mrl
int
Maximale Mietdauer in Stunden
servers[x].price.on_demand
[]string
Preis pro Tag bei On-Demand
servers[x].spot
[]string
Minimaler Spot-Markt-Preis pro Tag
servers[x].rented
bool
Ist der Server On-Demand gemietet
servers[x].specs
[]string
Serverspezifikationen
servers[x].partial_gpu_rental
Objekt | bool
false wenn eine Teilmiete nicht verfügbar ist, andernfalls { total_gpus, available_gpus, free_indices }
Beispiel
Marktplatz abrufen
Eingabe:
Ausgabe:
5. my_orders
Über
Rufen Sie Ihre Bestellungen ab
Header
auth
Zeichenkette
Ja
API-Token
Abfragezeichenfolge
return_completed
bool
Nein
Gibt abgeschlossene (abgelaufene) Bestellungen zurück
Ausgabe
code
int
Statuscode
Limit
int
Maximale Anzahl aktiver Bestellungen
orders
[]string
Array von Bestellungen
orders[x].id
int
Eindeutige Auftrags-ID
orders[x].price
float
Bestellpreis (Kosten) pro Tag
orders[x].mrl
int
Maximale Mietdauer der Bestellung in Sekunden
orders[x].image
Zeichenkette
Verwendetes Docker-Image
orders[x].currency
Zeichenkette
Zur Abrechnung verwendete Währung
orders[x].spend
float
Für die Bestellung ausgegebenes Geld
orders[x].ct
int
Erstellungszeit (UNIX-Zeit)
orders[x].p
int
Derzeit verwendeter Proxy-Cluster
orders[x].specs
[]string
Serverspezifikationen
orders[x].si
int
Eindeutige Server-ID
orders[x].pub_cluster
[]string
Öffentliche Endpunkte mit weitergeleiteten Ports
orders[x].tcp_ports
[]string
TCP-Port-Weiterleitung
orders[x].http_port
Zeichenkette
Container-Port über HTTPS-Proxy weitergeleitet
orders[x].spot
bool
Kennzeichnung, dass es sich um eine Spot-Bestellung handelt
orders[x].expired
bool
Kennzeichnung, dass die Bestellung abgelaufen ist
Eingabe:
Ausgabe:
6. spot_marketplace
Über
Spot-Marktplatz für einen bestimmten Server abrufen
Header
auth
Zeichenkette
Ja
API-Token
Abfragezeichenfolge
market
int
Ja
Eindeutige Server-ID
Ausgabe
code
int
Statuscode
existiert
bool
Überprüfung, dass der Marktplatz existiert
market
Objekt
Marktplatz
market.offers
array
Mietangebote für den Server
market.offers[x].offer_id
int
Eindeutige Angebots-ID
market.offers[x].bid
float
Angebotener Preis pro Tag
market.offers[x].active
bool
Dieses Angebot wird derzeit verwendet
market.offers[x].my
bool
Dieses Angebot gehört mir
market.server
Objekt
Serverinformationen
market.server.min_pricing
Objekt
Minimaler Angebotspreis pro Tag
market.server.mrl
int
Maximale Mietdauer in Sekunden
market.server.visibility
Zeichenkette
Sie können Angebote nur erstellen, wenn die Sichtbarkeit öffentlich ist
market.server.online
bool
Server ist online
Eingabe:
Ausgabe:
7. set_server_settings
Über
Konfigurieren Sie die Einstellungen des Servers, den Sie anbieten clore.ai Marktplatz
Header
auth
Zeichenkette
Ja
API-Token
Content-type
Zeichenkette
Ja
Muss application/json
Body
name
Zeichenkette
Ja
Vom Benutzer gewählter Servername
Verfügbarkeit
bool
Ja
Kann der Server gemietet werden
mrl
int
Ja
Maximale Mietdauer des Servers
On-Demand
float
Ja
Preis pro Tag für Ihren Server bei Bedarf
Spot
float
Ja
Mindestpreis pro Tag für das SPOT-Angebot
Tagespreise sind auf 0,015 BTC / 600.000 CLORE / 1.000 USD begrenzt.
Ausgabe
code
int
Statuscode
Beispiel
Erstellen wir einen Sendenachweis für eine Transaktion, die aus der aktuellen Wallet gesendet wurde.
Eingabe:
Ausgabe:
8. set_spot_price
Über
Setzen Sie den Tagespreis für Ihr SPOT-Marktplatzangebot
Header
auth
Zeichenkette
Ja
API-Token
Content-type
Zeichenkette
Ja
Muss application/json
Body
order_id
int
Ja
Eindeutige Angebots-ID
desired_price
float
Ja
Ihr angebotener Preis pro Tag
Beispiel
Versuchen wir, den SPOT-Marktpreis zu aktualisieren
Eingabe 1 (Schritt nach unten war zu groß):
Mögliche Ausgabe 1 (Schritt nach unten war zu groß): Sie können den SPOT-Marktplatzangebotspreis um maximal 0,00000100 ₿ senken
code
int
Statuscode
Fehler
Zeichenkette
Feld für Fehlerbeschreibung
max_step
float
Niedrigster möglicher Wert, auf den Sie den Preis derzeit senken können
Eingabe 2 (Gültige Preissenkung):
Mögliche Ausgabe 2 (Gültige Preissenkung):
Eingabe 3 (Preis nach Senden von Eingabe 2 noch weiter senken):
Mögliche Ausgabe 3 (Preis nach Senden von Eingabe 2 noch weiter senken): Sie können den SPOT-Preis nur alle 600 Sekunden senken
code
int
Statuscode
Fehler
Zeichenkette
Feld für Fehlerbeschreibung
time_to_lowering
float
Verbleibende Zeit (Sek.) bis zur nächsten Möglichkeit, den Preis zu senken
9. cancel_order
Über
Eine aktive Bestellung oder ein SPOT-Angebot stornieren
Header
auth
Zeichenkette
Ja
API-Token
Content-type
Zeichenkette
Ja
Muss application/json
Body
id
int
Ja
Eindeutige Bestell-/Angebots-ID
Problem
Zeichenkette
Nein
Wenn Sie Probleme mit dem Server festgestellt haben, können Sie diese melden an clore.ai Team, maximal 2048 Zeichen
Ausgabe
code
int
Statuscode
Beispiel
Bestellung/Angebot stornieren
Eingabe: In diesem Beispiel melden wir Probleme mit GPU #1; wenn Sie keine Probleme haben, fügen Sie das Feld issue nicht hinzu. Sie können beliebige Nachricht in das Textfeld schreiben und wir werden sie untersuchen
Ausgabe:
10. create_order
Über
Mit diesem Endpunkt können Sie ein SPOT-Angebot oder eine On-Demand-Bestellung erstellen Dieser Endpunkt erlaubt außerdem nur 1 Anfrage in 5 Sekunden
Header
auth
Zeichenkette
Ja
API-Token
Content-type
Zeichenkette
Ja
Muss application/json
Body
currency
Zeichenkette
Ja
Währungsname
image
Zeichenkette
Ja
Gültiges Image von Docker Hub
renting_server
int
Ja
ID des Servers, den Sie mieten möchten
type
Zeichenkette
Ja
on-demand ODER Spot
spotprice
float
Hängt davon ab
Angebotener Preis pro Tag auf dem SPOT-Markt, erforderlich beim Erstellen einer SPOT-Bestellung
ports
Objekt
Nein
Portweiterleitungs-Konfiguration, maximal 5 Einträge
env
Objekt
Nein
Umgebungsvariablen, insgesamt auf 12000 Zeichen begrenzt, wenn als String serialisiert. Variablenname - maximal 128 Zeichen Variablenwert - maximal 1536 Zeichen
jupyter_token
Zeichenkette
Nein
Jupyter-Token für Images mit Jupyter-Notebooks, maximal 32 Zeichen *
ssh_key
Zeichenkette
Nein
SSH-Schlüssel für Images mit SSH, maximal 3072 Zeichen *
ssh_password
Zeichenkette
Nein
SSH-Passwort für Images mit SSH, maximal 32 Zeichen *
command
Zeichenkette
Nein
Der Befehl wird nach dem Erstellen der Bestellung auf dem Server ausgeführt
required_price
float
Nein
Geben Sie den Preis an, zu dem Sie die Bestellung starten möchten; wenn der Maschinenbesitzer den Preis ändert, wird die Bestellung nicht gestartet (nur On-Demand)
gpu_count
int
Nein
Anzahl der GPUs, die auf Servern gemietet werden sollen, die Teilmiete. Weglassen, um das gesamte Rig zu mieten. Nur On-Demand, nur homogene Rigs
gpu_indices
[]int
Nein
0-basierte GPU-Slot-Indizes zum Mieten; die Länge muss entsprechen gpu_count. Freie Slots entnehmen aus partial_gpu_rental.free_indices. Weglassen, damit das Backend freie GPUs automatisch auswählt
autossh_entrypoint
bool
Nein
Verwenden Sie den clore.ai-Entrypoint, der automatisch einen SSH-Server und ein benutzerdefiniertes /root/onstart.sh Skript
* In die mit einem Stern markierten Felder können Sie nur Zeichen aus dieser Regex-Gruppe eingeben /^[a-zA-Z0-9\\s-=.@+/]+$/
Ausgabe
code
int
Statuscode
Beispiel
Eingabe 1 (SPOT-Angebot erstellen):
Ausgabe 1 (SPOT-Angebot erstellen):
Eingabe 2 (On-Demand-Bestellung erstellen):
Ausgabe 2 (On-Demand-Bestellung erstellen):
11. renter_fees
Über
Rufen Sie die aktuelle Gebührenkonfiguration ab: Basis-Mietgebühren, Einstellungen zur Reduzierung der PoH-Gebühr, Gebühren für das Erstellen von Bestellungen und Ihr PoH-Guthaben
Header
auth
Zeichenkette
Ja
API-Token
Ausgabe
code
int
Statuscode
renter_fees.on_demand
Objekt
Basisgebühr (%) pro Währung für On-Demand-Bestellungen
renter_fees.spot
Objekt
Basisgebühr (%) pro Währung für SPOT-Bestellungen
poh_config.max_reduction_percent
int
Maximale Reduzierung der Basisgebühr durch PoH (%)
poh_config.max_poh_amount
int
PoH-Guthaben, bei dem die maximale Reduzierung erreicht wird
creation_fees.on_demand
Objekt
Gebühr für das Erstellen von Bestellungen pro Währung
creation_fees.spot
Objekt
Gebühr für das Erstellen von SPOT-Bestellungen pro Währung
poh_balance
float
Ihr PoH-CLORE-Guthaben
Eingabe:
Ausgabe:
12. cancel_orders
Über
Mehrere Bestellungen gleichzeitig stornieren (bis zu 256 pro Anfrage)
Header
auth
Zeichenkette
Ja
API-Token
Content-type
Zeichenkette
Ja
Muss application/json
Body
order_ids
[]int
Ja
Zu stornierende Bestell-IDs, maximal 256
Ausgabe
code
int
Statuscode
failed_to_cancel
[]int
Bestell-IDs, die nicht storniert werden konnten
Eingabe:
Ausgabe:
13. poh_balance
Über
Rufen Sie Ihr Proof-of-Holding-Guthaben ab: Positionen, Summen und Angebotsbeträge im PoH-Marktplatz
Header
auth
Zeichenkette
Ja
API-Token
Ausgabe
code
int
Statuscode
items
[]Objekt
Ihre PoH-Positionen mit einzelnen Guthaben
balance.total
float
Gesamtes PoH-Guthaben über alle Positionen hinweg
balance.free_amount
float
PoH-Guthaben, das nicht an Angebote gebunden ist
balance.reward_amount
float
Für Belohnungen berechtigtes Guthaben
balance.offers.rented_amount
float
An andere Nutzer vermieteter Betrag
balance.offers.rented_on_marketplace_amount
float
Im PoH-Marktplatz gelisteter Betrag
balance.offers.leased_amount
float
Von anderen Nutzern geleaster Betrag
Eingabe:
Ausgabe:
14. server-config.json
Über
Statische API-Konfigurationsdaten abrufen. Keine Authentifizierung erforderlich
Eingabe:
15. get_relay
Über
TCP-Weiterleitungs-Relay-Knoten für Ihr ermitteltes Land abrufen. Keine Authentifizierung erforderlich
Ausgabe
code
int
Statuscode
country
Zeichenkette
Ermittelter Ländercode
nodes
Objekt
Verfügbare Relay-Knoten
Eingabe:
Zuletzt aktualisiert
War das hilfreich?