> For the complete documentation index, see [llms.txt](https://docs.clore.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clore.ai/clore.ai/clore.ai-eng-de/fur-hosts/api.md).

# API

> 💡 **Python-Entwickler:** Verwenden Sie das offizielle [clore-ai Python SDK](/clore.ai/clore.ai-eng-de/entwickler/python-sdk.md) anstelle direkter API-Aufrufe. Es übernimmt Authentifizierung, Ratenbegrenzung, Wiederholungsversuche und Fehlerbehandlung automatisch.
>
> **Schnellstart:** `pip install clore-ai` — Siehe die [Python-SDK-Dokumentation](/clore.ai/clore.ai-eng-de/entwickler/python-sdk.md) und [CLI-Referenz](/clore.ai/clore.ai-eng-de/entwickler/cli-guide.md).

> 🧭 Bevorzugen Sie eine durchsuchbare Referenz? Öffnen Sie die interaktive API-Dokumentation unter [clore.ai/api-docs](https://clore.ai/api-docs). Basis-URL für alle Endpunkte auf dieser Seite: `https://api.clore.ai/v1/`.

<div data-full-width="true"><figure><img src="https://3465007990-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbyNlC5NV8aIpXnc76G7w%2Fuploads%2FoEhopGeayaKnbuDjgTEs%2FCLORE%20Docs%20API%20Page.png?alt=media&amp;token=a0adf6bb-1fde-4f1b-8236-dff2563ffbfd" alt=""><figcaption></figcaption></figure></div>

### Einführung <a href="#introduction" id="introduction"></a>

[CLORE.AI](http://clore.ai/) api kann verwendet werden, um Bereitstellungen Ihrer Workloads auf [CLORE.AI](http://clore.ai/)

Zuerst müssen Sie einen API-Schlüssel erhalten\
![alt text](https://clore.ai/assets/html/api-export1.png)\
![alt text](https://clore.ai/assets/html/api-export2.png)

***

### API-Antworten <a href="#api-responses" id="api-responses"></a>

Antworten werden im JSON-Format zurückgegeben und können unterschiedliche Felder haben

Das immer zurückgegebene Feld ist code und gibt den Status an

**code-Feld**

| code | Beschreibung                              |
| ---- | ----------------------------------------- |
| `0`  | NORMAL                                    |
| `1`  | DATENBANKFEHLER                           |
| `2`  | UNGÜLTIGE EINGABEDATEN                    |
| `3`  | UNGÜLTIGES API-TOKEN                      |
| `4`  | UNGÜLTIGER ENDPUNKT                       |
| `5`  | Limit von 1 Anfrage/Sekunde überschritten |
| `6`  | Fehler angegeben in `error` Feld          |

***

### Endpunkte <a href="#endpoints" id="endpoints"></a>

#### 1. `wallets` <a href="#id-1-wallets" id="id-1-wallets"></a>

**Beschreibung**

Gibt Wallets und Guthaben zurück

**Header**

| Feld   | Typ      | Erforderlich | Beschreibung |
| ------ | -------- | ------------ | ------------ |
| `auth` | `string` | Ja           | API-Token    |

**Ausgabe**

| Feld      | Typ        | Beschreibung      |
| --------- | ---------- | ----------------- |
| `code`    | `int`      | Statuscode        |
| `wallets` | `[]string` | Array von Wallets |

**Beispiel**

**Eingabe:**

```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/wallets'
```

**Ausgabe:**

```
{
  "wallets": [
    {
      "name": "bitcoin",
      "deposit": "tb1q6erw7v02t7hakgmlcl4wfnlykzqj05alndruwr",
      "balance": 0.00153176,
      "withdrawal_fee": 0.0001
    }
  ],
  "code": 0
}
```

#### 2. `my_servers` <a href="#id-2-my_servers" id="id-2-my_servers"></a>

**Beschreibung**

Gibt Ihre Server zurück, die Sie bereitstellen für [clore.ai](http://clore.ai/) Marktplatz

**Header**

| Feld   | Typ      | Erforderlich | Beschreibung |
| ------ | -------- | ------------ | ------------ |
| `auth` | `string` | Ja           | API-Token    |

**Ausgabe**

| Feld                                  | Typ        | Beschreibung                                                                                                                                                         |
| ------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`                                | `int`      | Statuscode                                                                                                                                                           |
| `Limit`                               | `int`      | Maximale Anzahl von Servern, die Sie besitzen können                                                                                                                 |
| `Server`                              | `[]string` | Array von Servern                                                                                                                                                    |
| `servers[x].name`                     | `string`   | Vom Benutzer ausgewählter Servername                                                                                                                                 |
| `servers[x].connected`                | `string`   | War der Server jemals verbunden [clore.ai](http://clore.ai/)                                                                                                         |
| `servers[x].visibility`               | `string`   | Sichtbarkeit auf dem Marktplatz                                                                                                                                      |
| `servers[x].pricing`                  | `[]string` | Preis/Tag On-Demand                                                                                                                                                  |
| `servers[x].online`                   | `bool`     | Ist der Server online                                                                                                                                                |
| `servers[x].min_spot_pricing`         | `[]string` | Mindestpreis/Tag zum Mieten auf dem Spot-Markt                                                                                                                       |
| `servers[x].init_token`               | `string`   | Token zur Maschinenregistrierung, wird nur bis zur Initialisierung der Maschine zurückgegeben — **als Anmeldedaten behandeln**, registriert Maschinen in Ihrem Konto |
| `servers[x].specs`                    | `[]string` | Serverspezifikationen                                                                                                                                                |
| `servers[x].remaining_time`           | `int`      | Mietendezeit der zuletzt aktiven Bestellung (ms seit Epoch)                                                                                                          |
| `servers[x].rental_state`             | `string`   | Aggregierter GPU-Mietstatus: `keine`, `teilweise`, oder `vollständig`                                                                                                |
| `servers[x].rented_gpus`              | `int`      | Derzeit in aktiven Bestellungen gemietete GPUs                                                                                                                       |
| `servers[x].total_gpus`               | `int`      | Gesamtzahl der GPUs auf dem Server                                                                                                                                   |
| `servers[x].rented_price_by_currency` | `object`   | Summe der aktiven Bestellpreise, nach Währung gruppiert                                                                                                              |
| `servers[x].update_channel`           | `string`   | Update-Kanal des Hosting-Agents: `stable` oder `beta`                                                                                                                |
| `servers[x].requested_channel`        | `string`   | Vom Web-UI angeforderter Kanalwechsel (nur vorhanden, wenn angefordert)                                                                                              |
| `servers[x].target_backend_version`   | `int`      | Backend-Version, auf die der aktuelle Kanal abzielt                                                                                                                  |

> Die Felder des Mietstatus (`remaining_time`, `rental_state`, `rented_gpus`, `total_gpus`, `rented_price_by_currency`) sind nur vorhanden, solange der Server eine aktive Bestellung hat.

**Beispiel**

**Eingabe:**

```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/my_servers'
```

**Ausgabe:**

```
{
  "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-Werte in `pricing` Objekten spiegeln den USD-basierten Preismodus wider, wenn der Host ihn aktiviert hat.

#### 3. `server_config` <a href="#id-3-server_config" id="id-3-server_config"></a>

**Beschreibung**

Konfiguration eines bestimmten Servers abrufen

**Header**

| Feld           | Typ      | Erforderlich | Beschreibung            |
| -------------- | -------- | ------------ | ----------------------- |
| `auth`         | `string` | Ja           | API-Token               |
| `Content-Type` | `string` | Ja           | Muss `application/json` |

**Body**

| Feld         | Typ      | Erforderlich | Beschreibung |
| ------------ | -------- | ------------ | ------------ |
| `Servername` | `string` | Ja           | Servername   |

**Ausgabe**

| Feld                    | Typ                  | Beschreibung                                                                                              |
| ----------------------- | -------------------- | --------------------------------------------------------------------------------------------------------- |
| `code`                  | `int`                | Statuscode                                                                                                |
| `creation_completed`    | `bool`               | Ist die Servererstellung abgeschlossen                                                                    |
| `config`                | `[]string`           | Konfiguration des Servers                                                                                 |
| `config.name`           | `string`             | Vom Benutzer ausgewählter Servername                                                                      |
| `config.connected`      | `bool`               | War der Server jemals verbunden [clore.ai](http://clore.ai/)                                              |
| `config.visibility`     | `string`             | Sichtbarkeit auf dem Marktplatz                                                                           |
| `config.pricing`        | `[]string`           | Preis/Tag On-Demand                                                                                       |
| `config.spot_pricing`   | `[]string`           | Mindestpreis/Tag zum Mieten auf dem Spot-Markt                                                            |
| `config.mrl`            | `int`                | Maximale Mietdauer in Stunden                                                                             |
| `config.online`         | `bool`               | Ist der Server online                                                                                     |
| `config.initialized`    | `bool`               | War der Server jemals verbunden [clore.ai](http://clore.ai/)                                              |
| `config.id`             | `int`                | Eindeutige Server-ID                                                                                      |
| `config.rental_status`  | `int`                | 0 - nicht vermietet \| 1 - auf dem Spot-Markt vermietet \| 2 - On-Demand vermietet \| 3 - feste USD-Miete |
| `config.specs`          | `[]string`           | Serverspezifikationen                                                                                     |
| `config.background_job` | `object`             | Hintergrundjob, wenn nicht vermietet: `image`, `command`, `env`, `times_updated`                          |
| `config.autoprice`      | `object` \| `string` | Währungsspezifische Autopreis-Konfiguration (auch ältere String-Werte `"pow"` / `"usd"` kommen vor)       |
| `config.usd_pricing`    | `object`             | USD-Preisziele — nur vorhanden, wenn USD-Autopricing aktiviert ist                                        |
| `config.tenants`        | `[]object`           | Aktive Bestellungen auf dem Server: `rental_type`, `currency`, `price`, `remaining_time`, `gpu_count`     |

> `server_config` gibt außerdem dieselben Felder für Mietstatus und Update-Kanal zurück wie `my_servers`: `remaining_time`, `rental_state`, `rented_gpus`, `total_gpus`, `rented_price_by_currency`, `update_channel`, `requested_channel`, `target_backend_version`. In beiden Endpunkten sind die Felder des Mietstatus nur vorhanden, solange der Server eine aktive Bestellung hat.

**Beispiel**

**Eingabe:**

```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
    "server_name":"Jan Vykydal"
}' 'https://api.clore.ai/v1/server_config'
```

**Ausgabe:**

```
{
  "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-Werte in `pricing` Objekten spiegeln den USD-basierten Preismodus wider, wenn der Host ihn aktiviert hat.

#### 4. `Marktplatz` <a href="#id-4-marketplace" id="id-4-marketplace"></a>

**Beschreibung**

Marktplatz abrufen

**Header**

| Feld   | Typ      | Erforderlich | Beschreibung |
| ------ | -------- | ------------ | ------------ |
| `auth` | `string` | Ja           | API-Token    |

**Ausgabe**

| Feld                            | Typ                | Beschreibung                                                                                              |
| ------------------------------- | ------------------ | --------------------------------------------------------------------------------------------------------- |
| `code`                          | `int`              | Statuscode                                                                                                |
| `my_servers`                    | `[]string`         | Array von Server-IDs, die Sie bereitstellen für [clore.ai](http://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 On-Demand                                                                                   |
| `servers[x].price.spot`         | `[]string`         | Mindestpreis pro Tag auf dem Spot-Markt                                                                   |
| `servers[x].rented`             | `bool`             | Ist der Server On-Demand vermietet                                                                        |
| `servers[x].specs`              | `[]string`         | Serverspezifikationen                                                                                     |
| `servers[x].partial_gpu_rental` | `object` \| `bool` | `false` wenn Teilmiete nicht verfügbar ist, andernfalls `{ total_gpus, available_gpus, free_indices }`    |

> `price.on_demand` und `price.spot` nur die Währungen einbeziehen, die jeder Server tatsächlich akzeptiert — ein Server ohne Preis in einer bestimmten Währung kann nicht darin gemietet werden.

**Beispiel**

Marktplatz abrufen

**Eingabe:**

```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/marketplace'
```

**Ausgabe:**

```
{
  "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` <a href="#id-5-my_orders" id="id-5-my_orders"></a>

**Beschreibung**

Ihre Bestellungen abrufen

**Header**

| Feld   | Typ      | Erforderlich | Beschreibung |
| ------ | -------- | ------------ | ------------ |
| `auth` | `string` | Ja           | API-Token    |

**Query-String**

| Feld               | Typ    | Erforderlich | Beschreibung                                          |
| ------------------ | ------ | ------------ | ----------------------------------------------------- |
| `return_completed` | `bool` | Nein         | Abgeschlossene (abgelaufene) Bestellungen zurückgeben |

**Ausgabe**

| Feld                     | Typ        | Beschreibung                                                                                                                                                                     |
| ------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`                   | `int`      | Statuscode                                                                                                                                                                       |
| `Limit`                  | `int`      | Maximale Anzahl aktiver Bestellungen                                                                                                                                             |
| `Bestellungen`           | `[]string` | Array von Bestellungen                                                                                                                                                           |
| `orders[x].id`           | `int`      | Eindeutige Bestell-ID                                                                                                                                                            |
| `orders[x].fee`          | `float`    | Gebühr (%) gezahlt an [clore.ai](http://clore.ai/)                                                                                                                               |
| `orders[x].creation_fee` | `float`    | Erstellungsgebühr gezahlt an [clore.ai](http://clore.ai/)                                                                                                                        |
| `orders[x].price`        | `float`    | Bestellpreis (Kosten) pro Tag                                                                                                                                                    |
| `orders[x].mrl`          | `int`      | Maximale Mietdauer der Bestellung in Sekunden                                                                                                                                    |
| `orders[x].image`        | `string`   | Verwendetes Docker-Image                                                                                                                                                         |
| `orders[x].currency`     | `string`   | Für die Abrechnung verwendete Währung                                                                                                                                            |
| `orders[x].spend`        | `float`    | Tatsächlich bisher abgebuchter Betrag: kumulierter Mietwert plus die Basisgebühr des Mieters (nach PoH-Reduktion) und etwaige Zusatzgebühr; ohne die einmalige Erstellungsgebühr |
| `orders[x].gpu_count`    | `int`      | Anzahl der GPUs, die die Bestellung belegt (On-Demand-Bestellungen; entspricht der Gesamtzahl der GPUs des Rigs, sofern es sich nicht um eine Teilmiete handelt)                 |
| `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-Portweiterleitung                                                                                                                                                            |
| `orders[x].http_port`    | `string`   | Container-Port, der über HTTPS-Proxy weitergeleitet wird                                                                                                                         |
| `orders[x].spot`         | `bool`     | Kennzeichnet, dass es sich um eine Spot-Bestellung handelt                                                                                                                       |
| `orders[x].expired`      | `bool`     | Kennzeichnet, dass die Bestellung abgelaufen ist                                                                                                                                 |

**Eingabe:**

```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/my_orders?return_completed=true'
```

**Ausgabe:**

```
{
  "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-Marktplatz` <a href="#id-6-spot_marketplace" id="id-6-spot_marketplace"></a>

**Beschreibung**

Spot-Marktplatz für einen bestimmten Server abrufen

**Header**

| Feld   | Typ      | Erforderlich | Beschreibung |
| ------ | -------- | ------------ | ------------ |
| `auth` | `string` | Ja           | API-Token    |

**Query-String**

| Feld    | Typ   | Erforderlich | Beschreibung         |
| ------- | ----- | ------------ | -------------------- |
| `Markt` | `int` | Ja           | Eindeutige Server-ID |

**Ausgabe**

| Feld                           | Typ      | Beschreibung                                                                     |
| ------------------------------ | -------- | -------------------------------------------------------------------------------- |
| `code`                         | `int`    | Statuscode                                                                       |
| `existiert`                    | `bool`   | Überprüfung, dass der Markt existiert                                            |
| `Markt`                        | `object` | 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 (in der Währung des Angebots)                          |
| `market.offers[x].currency`    | `string` | Währung des Gebots                                                               |
| `market.offers[x].active`      | `bool`   | Dieses Angebot wird derzeit verwendet                                            |
| `market.offers[x].my`          | `bool`   | Dieses Angebot gehört mir                                                        |
| `market.server`                | `object` | Serverinformationen                                                              |
| `market.server.min_pricing`    | `object` | Mindestangebotspreis pro Tag, je akzeptierter Währung                            |
| `market.server.mrl`            | `int`    | Maximale Mietdauer in **Stunden**                                                |
| `market.server.visibility`     | `string` | Sie können Angebote nur erstellen, wenn die Sichtbarkeit öffentlich ist          |
| `market.server.online`         | `bool`   | Server ist online                                                                |
| `market.currency_rates_in_usd` | `object` | Aktuelle USD-Kurse werden verwendet, um Gebote zwischen Währungen zu vergleichen |

> Angebote können in jeder vom Server akzeptierten Währung abgegeben werden; konkurrierende Gebote werden nach ihrem **USD-Wert** (unter Verwendung von `currency_rates_in_usd`), nicht nach Nennwert.
>
> ⚠️ **Geändert im August 2026:** `market.server.mrl` wird jetzt zurückgegeben in **Stunden** (zuvor Sekunden). Ein Wert, der `262800` jetzt lautet `73`.

**Eingabe:**

```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/spot_marketplace?market=6'
```

**Ausgabe:**

```
{
  "market": {
    "offers": [
      {
        "offer_id": 39,
        "bid": 0.0000042,
        "active": true,
        "my": true,
        "currency": "bitcoin"
      }
    ],
    "server": {
      "min_pricing": {
        "bitcoin": 0.000001
      },
      "mrl": 73,
      "visibility": "public",
      "online": true
    },
    "currency_rates_in_usd": {
      "bitcoin": 110000,
      "CLORE-Blockchain": 0.0045,
      "USD-Blockchain": 1
    }
  },
  "exists": true,
  "code": 0
}
```

#### 7. `set_server_settings` <a href="#id-7-set_server_settings" id="id-7-set_server_settings"></a>

**Beschreibung**

Konfigurieren Sie die Einstellungen des Servers, den Sie bereitstellen [clore.ai](http://clore.ai/) Marktplatz

**Header**

| Feld           | Typ      | Erforderlich | Beschreibung            |
| -------------- | -------- | ------------ | ----------------------- |
| `auth`         | `string` | Ja           | API-Token               |
| `Content-Type` | `string` | Ja           | Muss `application/json` |

**Body**

| Feld                         | Typ      | Erforderlich | Beschreibung                                                                                                                                                                                                               |
| ---------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                       | `string` | Ja           | Vom Benutzer ausgewählter Servername                                                                                                                                                                                       |
| `Verfügbarkeit`              | `bool`   | Ja           | Kann der Server vermietet werden                                                                                                                                                                                           |
| `mrl`                        | `int`    | Ja           | Maximale Server-Mietdauer in **Stunden** (6 bis 3000)                                                                                                                                                                      |
| `bitcoin_on_demand`          | `float`  | Ja           | On-Demand-Preis in BTC pro Tag                                                                                                                                                                                             |
| `bitcoin_spot`               | `float`  | Ja           | Mindest-Spot-Preis in BTC pro Tag                                                                                                                                                                                          |
| `CLORE-Blockchain_on_demand` | `float`  | Nein         | On-Demand-Preis in CLORE pro Tag                                                                                                                                                                                           |
| `CLORE-Blockchain_spot`      | `float`  | Nein         | Mindest-Spot-Preis in CLORE pro Tag                                                                                                                                                                                        |
| `USD-Blockchain_on_demand`   | `float`  | Nein         | On-Demand-Preis in USD pro Tag                                                                                                                                                                                             |
| `USD-Blockchain_spot`        | `float`  | Nein         | Mindest-Spot-Preis in USD pro Tag                                                                                                                                                                                          |
| `enabled-bitcoin`            | `bool`   | Nein\*       | Bitcoin für diesen Server akzeptieren                                                                                                                                                                                      |
| `enabled-CLORE-Blockchain`   | `bool`   | Nein\*       | CLORE für diesen Server akzeptieren                                                                                                                                                                                        |
| `enabled-USD-Blockchain`     | `bool`   | Nein\*       | USD-Stablecoins für diesen Server akzeptieren                                                                                                                                                                              |
| `autoprice`                  | `object` | Nein         | Währungsabhängige automatische Preisgestaltung: Legen Sie einen Währungsschlüssel fest (`bitcoin`, `CLORE-Blockchain`) auf `"usd"` für eine USD-basierte automatische Preisgestaltung oder `false` für Festpreisgestaltung |
| `usd_pricing`                | `object` | Nein         | USD-Preisziele pro Währung, z. B. `{ "bitcoin": { "on_demand": 10, "spot": 5 } }` — nur für Währungen verwendet, die `autoprice` gesetzt auf `"usd"`                                                                       |

> \* **Die Liste der akzeptierten Währungen wird aus den `enabled-*` Flags bei jedem Aufruf neu erstellt.** Eine Währung ohne ihr `enabled-<currency>: true` Flag (oder ohne gültigen Preis) wird aus den vom Server akzeptierten Währungen entfernt — wenn alle Flags weggelassen werden, ist der Server in jeder Währung nicht mietbar. Senden Sie immer `enabled-<currency>: true` für jede Währung, die Sie weiterhin akzeptieren möchten.
>
> Tagespreise sind pro Währung begrenzt: 0.000001–0.1 BTC, 0.1–5,000,000 CLORE, 0.1–10,000 USD.
>
> Wenn eine Währung in USD automatisch bepreist wird, wird ihr angezeigter Krypto-Preis abgeleitet aus `usd_pricing` zum aktuellen Wechselkurs (etwa alle 10 Minuten neu berechnet) und jeder `<currency>_on_demand` / `<currency>_spot` dafür gesendete Wert wird ignoriert. Die `usd_pricing` Zielwerte sind serverweite $/Tag-Werte, die gegen den USD-Bereich (0.1–1,000) validiert werden; Werte außerhalb des Bereichs werden auf die nächste Grenze begrenzt.

**Ausgabe**

| Feld   | Typ   | Beschreibung |
| ------ | ----- | ------------ |
| `code` | `int` | Statuscode   |

**Beispiel**

Lassen Sie uns einen Sendenachweis für eine Transaktion aus der aktuellen Wallet erstellen.

**Eingabe:**

```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
    "name": "Jan Vykydal",
    "availability":true,
    "mrl":96,
    "enabled-bitcoin":true,
    "bitcoin_on_demand":0.0001,
    "bitcoin_spot":0.00000113
}' 'https://api.clore.ai/v1/set_server_settings'
```

**Ausgabe:**

```
{
  "code": 0
}
```

#### 8. `set_spot_price` <a href="#id-8-set_spot_price" id="id-8-set_spot_price"></a>

**Beschreibung**

Preis pro Tag für Ihr SPOT-Marktplatzangebot festlegen

**Header**

| Feld           | Typ      | Erforderlich | Beschreibung            |
| -------------- | -------- | ------------ | ----------------------- |
| `auth`         | `string` | Ja           | API-Token               |
| `Content-Type` | `string` | Ja           | Muss `application/json` |

**Body**

| Feld            | Typ     | Erforderlich | Beschreibung                  |
| --------------- | ------- | ------------ | ----------------------------- |
| `order_id`      | `int`   | Ja           | Eindeutige Angebots-ID        |
| `desired_price` | `float` | Ja           | Ihr angebotener Preis pro Tag |

> **Ein Preis unter dem aktuellen Spot-Mindestpreis des Servers** wird mit dem aktuellen Mindestpreis abgelehnt:
>
> ```
> { "error": "amount_too_low", "min_price": 0.0000012, "code": 6 }
> ```

**Beispiel**

Lassen Sie uns versuchen, den Spot-Marktplatzpreis zu aktualisieren

**Eingabe 1 (Schritt nach unten war zu groß):**

```
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'
```

**Mögliche Ausgabe 1 (Schritt nach unten war zu groß):**\
Sie können den Preis des Spot-Marktplatzangebots um höchstens 0.00000100 ₿ senken

| Feld       | Typ      | Beschreibung                                                            |
| ---------- | -------- | ----------------------------------------------------------------------- |
| `code`     | `int`    | Statuscode                                                              |
| `error`    | `string` | Feld für Fehlerbeschreibung                                             |
| `max_step` | `float`  | Niedrigster möglicher Wert, auf den Sie den Preis derzeit senken können |

```
{
    "error":"exceeded_max_step",
    "max_step":0.0000032,
    "code":6
}
```

**Eingabe 2 (Gültiger Preis-Schritt nach unten):**

```
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'
```

**Mögliche Ausgabe 2 (Gültiger Preis-Schritt nach unten):**

```
{
    "code": 0
}
```

**Eingabe 3 (Preis noch weiter senken, nachdem Eingabe 2 gesendet wurde):**

```
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
```

**Mögliche Ausgabe 3 (Preis noch weiter senken, nachdem Eingabe 2 gesendet wurde):**\
Sie können den Spot-Preis einmal alle 600 Sekunden senken

| Feld               | Typ      | Beschreibung                                                               |
| ------------------ | -------- | -------------------------------------------------------------------------- |
| `code`             | `int`    | Statuscode                                                                 |
| `error`            | `string` | Feld für Fehlerbeschreibung                                                |
| `time_to_lowering` | `float`  | Verbleibende Zeit (Sek.) bis zur nächsten Möglichkeit, den Preis zu senken |

```
{
    "error":"can_lower_every_600_seconds",
    "time_to_lowering":513,
    "code":6
}
```

#### 9. `cancel_order` <a href="#id-9-cancel_order" id="id-9-cancel_order"></a>

**Beschreibung**

Aktive Bestellung oder Spot-Angebot stornieren

**Header**

| Feld           | Typ      | Erforderlich | Beschreibung            |
| -------------- | -------- | ------------ | ----------------------- |
| `auth`         | `string` | Ja           | API-Token               |
| `Content-Type` | `string` | Ja           | Muss `application/json` |

**Body**

| Feld    | Typ      | Erforderlich | Beschreibung                                                                                                                           |
| ------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| `id`    | `int`    | Ja           | Eindeutige Bestell-/Angebots-ID                                                                                                        |
| `issue` | `string` | Nein         | Wenn Sie Probleme mit dem Server festgestellt haben, können Sie sie dem [clore.ai](http://clore.ai/) Team melden, maximal 2048 Zeichen |

**Ausgabe**

| Feld   | Typ   | Beschreibung |
| ------ | ----- | ------------ |
| `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 in das Textfeld jede beliebige Nachricht schreiben, und wir werden sie untersuchen

```
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'
```

**Ausgabe:**

```
{
  "code": 0
}
```

#### 10. `create_order` <a href="#id-10-create_order" id="id-10-create_order"></a>

**Beschreibung**

Mit diesem Endpunkt können Sie ein Spot-Angebot oder eine On-Demand-Bestellung erstellen

**Header**

| Feld           | Typ      | Erforderlich | Beschreibung            |
| -------------- | -------- | ------------ | ----------------------- |
| `auth`         | `string` | Ja           | API-Token               |
| `Content-Type` | `string` | Ja           | Muss `application/json` |

**Body**

| Feld                 | Typ      | Erforderlich | Beschreibung                                                                                                                                                                                                                                                                                                                |
| -------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `currency`           | `string` | Ja           | Währungsname                                                                                                                                                                                                                                                                                                                |
| `image`              | `string` | Ja           | Gültiges Image von Docker Hub                                                                                                                                                                                                                                                                                               |
| `renting_server`     | `int`    | Ja           | ID des Servers, den Sie mieten möchten                                                                                                                                                                                                                                                                                      |
| `Typ`                | `string` | Ja           | `On-Demand` ODER `Spot`                                                                                                                                                                                                                                                                                                     |
| `spotprice`          | `float`  | Hängt ab     | Angebotener Preis pro Tag auf dem Spot-Marktplatz, erforderlich beim Erstellen einer Spot-Bestellung                                                                                                                                                                                                                        |
| `ports`              | `object` | Nein         | Portweiterleitungs-Konfiguration, max. 5 Einträge                                                                                                                                                                                                                                                                           |
| `env`                | `object` | Nein         | <p>Umgebungsvariablen, insgesamt auf 12288 Zeichen begrenzt, wenn als String serialisiert.<br>Variablenname - maximal 128 Zeichen, darf nicht enthalten <code>-</code><br>Variablenwert - maximal 1536 Zeichen<br>Nur die ersten 30 gültigen Variablen werden beibehalten; zusätzliche werden stillschweigend verworfen</p> |
| `jupyter_token`      | `string` | Nein         | Jupyter-Token für Images mit Jupyter-Notebooks, maximal 32 Zeichen \*                                                                                                                                                                                                                                                       |
| `ssh_key`            | `string` | Nein         | SSH-Schlüssel für Images mit SSH, maximal 3072 Zeichen \*                                                                                                                                                                                                                                                                   |
| `ssh_password`       | `string` | Nein         | SSH-Passwort für Images mit SSH, maximal 32 Zeichen \*                                                                                                                                                                                                                                                                      |
| `command`            | `string` | Nein         | Der Befehl wird nach der Auftragserstellung 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 [Teilvermietung](/clore.ai/clore.ai-eng-de/fur-mieter/partial-gpu-rental.md). Weglassen, um das gesamte Rig zu mieten. Nur On-Demand, nur homogene Rigs                                                                                                        |
| `gpu_indices`        | `[]int`  | Nein         | 0-basierte GPU-Slot-Indizes, die gemietet werden sollen; 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 Felder, die mit einem Stern markiert sind, können Sie nur Zeichen aus dieser Regex-Gruppe eingeben `/^[a-zA-Z0-9\s-=.@+/]+$/`

**Ausgabe**

| Feld   | Typ   | Beschreibung |
| ------ | ----- | ------------ |
| `code` | `int` | Statuscode   |

> **Spot-Gebote unter dem Mindestpreis des Servers** werden mit dem aktuellen Mindestpreis abgelehnt, sodass Sie sofort erneut versuchen können:
>
> ```
> { "error": "too_low_price", "min_price": 0.0000012, "code": 6 }
> ```
>
> Der Mindestpreis wird etwa alle 10 Minuten anhand der aktuellen Coin-Kurse neu berechnet, daher kann ein aus dem Marktplatz-Eintrag abgelesener Preis leicht veraltet sein — verwenden Sie immer den zurückgegebenen `min_price` für den erneuten Versuch.

**Beispiel**

**Eingabe 1 (Spot-Angebot erstellen):**

```
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'
```

**Ausgabe 1 (Spot-Angebot erstellen):**

```
{
  "code":0
}
```

**Eingabe 2 (On-Demand-Bestellung erstellen):**

```
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'
```

**Ausgabe 2 (On-Demand-Bestellung erstellen):**

```
{
  "code":0
}
```

#### 11. `renter_fees` <a href="#id-11-renter_fees" id="id-11-renter_fees"></a>

**Beschreibung**

Rufen Sie die aktuelle Gebührenkonfiguration ab: Basis-Mietergebühren, Einstellungen zur PoH-Gebührenreduzierung, Gebühren für die Auftragserstellung und Ihr PoH-Guthaben

**Header**

| Feld   | Typ      | Erforderlich | Beschreibung |
| ------ | -------- | ------------ | ------------ |
| `auth` | `string` | Ja           | API-Token    |

**Ausgabe**

| Feld                               | Typ      | Beschreibung                                                 |
| ---------------------------------- | -------- | ------------------------------------------------------------ |
| `code`                             | `int`    | Statuscode                                                   |
| `renter_fees.on_demand`            | `object` | Basisgebühr (%) pro Währung für On-Demand-Bestellungen       |
| `renter_fees.spot`                 | `object` | 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`          | `object` | Gebühr für die Auftragserstellung pro Währung                |
| `creation_fees.spot`               | `object` | Gebühr für die Erstellung von Spot-Bestellungen pro Währung  |
| `poh_balance`                      | `float`  | Ihr PoH-CLORE-Guthaben                                       |

**Eingabe:**

```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/renter_fees'
```

**Ausgabe:**

```
{
  "renter_fees": {
    "on_demand": {
      "base": { "bitcoin": 5, "CLORE-Blockchain": 5, "USD-Blockchain": 5 }
    },
    "spot": {
      "base": { "bitcoin": 1.25, "CLORE-Blockchain": 1.25, "USD-Blockchain": 1.25 }
    }
  },
  "poh_config": { "max_reduction_percent": 50, "max_poh_amount": 2000000 },
  "creation_fees": {
    "on_demand": { "bitcoin": 3e-7, "CLORE-Blockchain": 0.5, "USD-Blockchain": 0.1 },
    "spot": { "bitcoin": 1e-7, "CLORE-Blockchain": 0.05, "USD-Blockchain": 0.005 }
  },
  "poh_balance": 5000,
  "code": 0
}
```

#### 12. `cancel_orders` <a href="#id-12-cancel_orders" id="id-12-cancel_orders"></a>

**Beschreibung**

Mehrere Bestellungen gleichzeitig stornieren (bis zu 256 pro Anfrage)

**Header**

| Feld           | Typ      | Erforderlich | Beschreibung            |
| -------------- | -------- | ------------ | ----------------------- |
| `auth`         | `string` | Ja           | API-Token               |
| `Content-Type` | `string` | Ja           | Muss `application/json` |

**Body**

| Feld        | Typ     | Erforderlich | Beschreibung                             |
| ----------- | ------- | ------------ | ---------------------------------------- |
| `order_ids` | `[]int` | Ja           | Zu stornierende Bestell-IDs, maximal 256 |

**Ausgabe**

| Feld               | Typ     | Beschreibung                                    |
| ------------------ | ------- | ----------------------------------------------- |
| `code`             | `int`   | Statuscode                                      |
| `failed_to_cancel` | `[]int` | Bestell-IDs, die nicht storniert werden konnten |

**Eingabe:**

```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
    "order_ids": [38, 39]
}' 'https://api.clore.ai/v1/cancel_orders'
```

**Ausgabe:**

```
{
  "failed_to_cancel": [],
  "code": 0
}
```

#### 13. `poh_balance` <a href="#id-13-poh_balance" id="id-13-poh_balance"></a>

**Beschreibung**

Rufen Sie Ihr Proof-of-Holding-Guthaben ab: Positionen, Summen und Angebotsbeträge des PoH-Marktplatzes

**Header**

| Feld   | Typ      | Erforderlich | Beschreibung |
| ------ | -------- | ------------ | ------------ |
| `auth` | `string` | Ja           | API-Token    |

**Ausgabe**

| Feld                                          | Typ        | Beschreibung                                     |
| --------------------------------------------- | ---------- | ------------------------------------------------ |
| `code`                                        | `int`      | Statuscode                                       |
| `items`                                       | `[]object` | Ihre PoH-Positionen mit einzelnen Guthaben       |
| `balance.total`                               | `float`    | Gesamt-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 aufgeführter Betrag            |
| `balance.offers.leased_amount`                | `float`    | Von anderen Nutzern geliehener Betrag            |

**Eingabe:**

```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/poh_balance'
```

**Ausgabe:**

```
{
  "items": [ { "balance": 5000 } ],
  "balance": {
    "total": 5000,
    "free_amount": 4000,
    "reward_amount": 5000,
    "offers": {
      "rented_amount": 0,
      "rented_on_marketplace_amount": 1000,
      "rented_finished_amount": 0,
      "leased_amount": 0
    }
  },
  "code": 0
}
```

#### 14. `server-config.json` <a href="#id-14-server-config-json" id="id-14-server-config-json"></a>

**Beschreibung**

Statische API-Konfigurationsdaten abrufen. Keine Authentifizierung erforderlich

**Eingabe:**

```
curl -XGET 'https://api.clore.ai/v1/server-config.json'
```

#### 15. `get_relay` <a href="#id-15-get_relay" id="id-15-get_relay"></a>

**Beschreibung**

TCP-Weiterleitungs-Relay-Knoten für Ihr erkanntes Land abrufen. Keine Authentifizierung erforderlich

**Ausgabe**

| Feld     | Typ      | Beschreibung            |
| -------- | -------- | ----------------------- |
| `code`   | `int`    | Statuscode              |
| `Land`   | `string` | Erkannter Ländercode    |
| `Knoten` | `object` | Verfügbare Relay-Knoten |

**Eingabe:**

```
curl -XGET 'https://api.clore.ai/v1/get_relay'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.clore.ai/clore.ai/clore.ai-eng-de/fur-hosts/api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
