> 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-ru/dlya-khostov/api.md).

# API

> 💡 **Разработчики Python:** Используйте официальный [Python SDK clore-ai](https://docs.clore.ai/clore.ai/clore.ai-ru/razrabotchikam/python-sdk.md) вместо прямых вызовов API. Он автоматически обрабатывает аутентификацию, ограничение скорости, повторные попытки и обработку ошибок.
>
> **Быстрый старт:** `pip install clore-ai` — См.  [документацию Python SDK](https://docs.clore.ai/clore.ai/clore.ai-ru/razrabotchikam/python-sdk.md) и [Справочник CLI](https://docs.clore.ai/clore.ai/clore.ai-ru/razrabotchikam/cli-guide.md).

> 🧭 Предпочитаете справочник, который можно просматривать? Откройте интерактивную документацию API по адресу [clore.ai/api-docs](https://clore.ai/api-docs). Базовый URL для всех конечных точек на этой странице: `https://api.clore.ai/v1/`.

<div data-full-width="true"><figure><img src="https://1059281095-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>

### Введение <a href="#introduction" id="introduction"></a>

[CLORE.AI](http://clore.ai/) api можно использовать для автоматизации развертывания ваших рабочих нагрузок на [CLORE.AI](http://clore.ai/)

Сначала вам нужно получить API-ключ\
![alt text](https://clore.ai/assets/html/api-export1.png)\
![alt text](https://clore.ai/assets/html/api-export2.png)

***

### Ответы API <a href="#api-responses" id="api-responses"></a>

Ответы возвращаются в формате JSON и могут содержать разные поля

Всегда возвращаемое поле — code, указывающее статус

**поле code**

| code | Описание                         |
| ---- | -------------------------------- |
| `0`  | NORMAL                           |
| `1`  | ОШИБКА БАЗЫ ДАННЫХ               |
| `2`  | НЕДОПУСТИМЫЕ ВХОДНЫЕ ДАННЫЕ      |
| `3`  | НЕДОПУСТИМЫЙ API-ТОКЕН           |
| `4`  | НЕДОПУСТИМАЯ КОНЕЧНАЯ ТОЧКА      |
| `5`  | ПРЕВЫШЕН лимит 1 запрос/секунду  |
| `6`  | Ошибка, указанная в `error` поле |

***

### Конечные точки <a href="#endpoints" id="endpoints"></a>

#### 1. `кошельки` <a href="#id-1-wallets" id="id-1-wallets"></a>

**О разделе**

Возвращает кошельки и балансы

**Заголовки**

| Поле   | Тип      | Обязательно | Описание  |
| ------ | -------- | ----------- | --------- |
| `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` <a href="#id-2-my_servers" id="id-2-my_servers"></a>

**О разделе**

Возвращает ваши серверы, которые вы предоставляете [clore.ai](http://clore.ai/) маркетплейсе

**Заголовки**

| Поле   | Тип      | Обязательно | Описание  |
| ------ | -------- | ----------- | --------- |
| `auth` | `строка` | Да          | API-токен |

**Вывод**

| Поле                                  | Тип        | Описание                                                                                                                                                                                                                                                                                                       |
| ------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`                                | `int`      | Код статуса                                                                                                                                                                                                                                                                                                    |
| `лимит`                               | `int`      | Максимальное количество серверов, которыми вы можете владеть                                                                                                                                                                                                                                                   |
| `серверы`                             | `[]string` | Массив серверов                                                                                                                                                                                                                                                                                                |
| `servers[x].name`                     | `строка`   | Имя сервера, выбранное пользователем                                                                                                                                                                                                                                                                           |
| `servers[x].connected`                | `строка`   | Был ли сервер когда-либо подключен к [clore.ai](http://clore.ai/)                                                                                                                                                                                                                                              |
| `servers[x].visibility`               | `строка`   | Видимость на маркетплейсе                                                                                                                                                                                                                                                                                      |
| `servers[x].pricing`                  | `[]string` | Цена/день по запросу                                                                                                                                                                                                                                                                                           |
| `servers[x].online`                   | `bool`     | Сервер в сети                                                                                                                                                                                                                                                                                                  |
| `servers[x].min_spot_pricing`         | `[]string` | Минимальная цена/день для аренды на спотовом рынке                                                                                                                                                                                                                                                             |
| `servers[x].auto_renew_allowed`       | `bool`     | Могут ли заказы арендаторов по запросу на этом сервере продлеваться по вашей текущей цене, когда они достигают максимальной длительности аренды. `true` когда вы никогда не задавали его. Отсутствует на сервере, который удаляется. Измените его с помощью [`set_server_settings`](#id-7-set_server_settings) |
| `servers[x].init_token`               | `строка`   | Токен регистрации машины, возвращается только до инициализации машины — **считайте его учетными данными**, он регистрирует машины в вашей учетной записи                                                                                                                                                       |
| `servers[x].specs`                    | `[]string` | Характеристики сервера                                                                                                                                                                                                                                                                                         |
| `servers[x].remaining_time`           | `int`      | Время окончания аренды последнего активного заказа (эпоха в мс)                                                                                                                                                                                                                                                |
| `servers[x].rental_state`             | `строка`   | Состояние совокупной аренды GPU: `none`, `partial`, или `full`                                                                                                                                                                                                                                                 |
| `servers[x].rented_gpus`              | `int`      | GPU, арендованные в настоящее время по активным заказам                                                                                                                                                                                                                                                        |
| `servers[x].total_gpus`               | `int`      | Общее количество GPU на сервере                                                                                                                                                                                                                                                                                |
| `servers[x].rented_price_by_currency` | `object`   | Сумма цен активных заказов, сгруппированная по валютам                                                                                                                                                                                                                                                         |
| `servers[x].update_channel`           | `строка`   | Канал обновлений хостинг-агента: `stable` или `beta`                                                                                                                                                                                                                                                           |
| `servers[x].requested_channel`        | `строка`   | Запрошенное переключение канала из веб-интерфейса (присутствует только при запросе)                                                                                                                                                                                                                            |
| `servers[x].target_backend_version`   | `int`      | Версия бэкенда, на которую нацелен текущий канал                                                                                                                                                                                                                                                               |

> Поля состояния аренды (`remaining_time`, `rental_state`, `rented_gpus`, `total_gpus`, `rented_price_by_currency`) присутствуют только когда у сервера есть активный заказ.

**Пример**

**Входные данные:**

```
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 },
      "auto_renew_allowed": true,
      "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 },
      "auto_renew_allowed": true,
      "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 в `pricing` объектах отражают режим ценообразования в USD, когда хост включил его.

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

**О разделе**

Получить конфигурацию конкретного сервера

**Заголовки**

| Поле           | Тип      | Обязательно | Описание                       |
| -------------- | -------- | ----------- | ------------------------------ |
| `auth`         | `строка` | Да          | API-токен                      |
| `Content-type` | `строка` | Да          | Должен быть `application/json` |

**Тело**

| Поле          | Тип      | Обязательно | Описание    |
| ------------- | -------- | ----------- | ----------- |
| `server_name` | `строка` | Да          | Имя сервера |

**Вывод**

| Поле                        | Тип                  | Описание                                                                                                                                                      |
| --------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`                      | `int`                | Код статуса                                                                                                                                                   |
| `creation_completed`        | `bool`               | Завершено ли создание сервера                                                                                                                                 |
| `config`                    | `[]string`           | Конфигурация сервера                                                                                                                                          |
| `config.name`               | `строка`             | Имя сервера, выбранное пользователем                                                                                                                          |
| `config.connected`          | `bool`               | Был ли сервер когда-либо подключен к [clore.ai](http://clore.ai/)                                                                                             |
| `config.visibility`         | `строка`             | Видимость на маркетплейсе                                                                                                                                     |
| `config.pricing`            | `[]string`           | Цена/день по запросу                                                                                                                                          |
| `config.spot_pricing`       | `[]string`           | Минимальная цена/день для аренды на спотовом рынке                                                                                                            |
| `config.mrl`                | `int`                | Максимальная длительность аренды в часах                                                                                                                      |
| `config.auto_renew_allowed` | `bool`               | Могут ли заказы арендаторов по запросу на этом сервере продлеваться по вашей текущей цене, когда они достигают `mrl`. `true` когда вы никогда не задавали его |
| `config.online`             | `bool`               | Сервер в сети                                                                                                                                                 |
| `config.initialized`        | `bool`               | Был ли сервер когда-либо подключен к [clore.ai](http://clore.ai/)                                                                                             |
| `config.id`                 | `int`                | Уникальный ID сервера                                                                                                                                         |
| `config.rental_status`      | `int`                | 0 - не арендован \| 1 - арендован на спотовом рынке \| 2 - арендован по запросу \| 3 - аренда с фиксированным USD                                             |
| `config.specs`              | `[]string`           | Характеристики сервера                                                                                                                                        |
| `config.background_job`     | `object`             | Фоновая задача, когда не арендован: `image`, `command`, `env`, `times_updated`                                                                                |
| `config.autoprice`          | `object` \| `строка` | Конфигурация автопрайсинга по валютам (устаревшие строковые значения `"pow"` / `"usd"` тоже встречаются)                                                      |
| `config.usd_pricing`        | `object`             | Целевые цены в USD — присутствуют только когда включен автопрайсинг в USD                                                                                     |
| `config.tenants`            | `[]object`           | Активные заказы на сервере: `rental_type`, `currency`, `price`, `remaining_time`, `gpu_count`                                                                 |

> `server_config` также возвращает те же поля состояния аренды и канала обновлений, что и `my_servers`: `remaining_time`, `rental_state`, `rented_gpus`, `total_gpus`, `rented_price_by_currency`, `update_channel`, `requested_channel`, `target_backend_version`. В обоих конечных точках поля состояния аренды присутствуют только пока у сервера есть активный заказ.

**Пример**

**Входные данные:**

```
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,
    "auto_renew_allowed": true,
    "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 в `pricing` объектах отражают режим ценообразования в USD, когда хост включил его.

#### 4. `маркетплейсе` <a href="#id-4-marketplace" id="id-4-marketplace"></a>

**О разделе**

Получить маркетплейс

**Заголовки**

| Поле   | Тип      | Обязательно | Описание  |
| ------ | -------- | ----------- | --------- |
| `auth` | `строка` | Да          | API-токен |

**Вывод**

| Поле                            | Тип                | Описание                                                                                                                                                                                                                        |
| ------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`                          | `int`              | Код статуса                                                                                                                                                                                                                     |
| `my_servers`                    | `[]string`         | Массив идентификаторов серверов, которые вы предоставляете [clore.ai](http://clore.ai/) (нельзя арендовать)                                                                                                                     |
| `серверы`                       | `[]string`         | Массив публичных серверов на маркетплейсе                                                                                                                                                                                       |
| `servers[x].id`                 | `int`              | Уникальный ID сервера                                                                                                                                                                                                           |
| `servers[x].owner`              | `int`              | Уникальный ID владельца                                                                                                                                                                                                         |
| `servers[x].mrl`                | `int`              | Максимальная длительность аренды в часах. Когда сервер допускает автопродление, это также период пересчета цены: продлеваемый заказ каждый раз получает текущую цену хоста, когда достигает этой длительности                   |
| `servers[x].auto_renew_allowed` | `bool`             | Разрешает ли хост автопродление на этом сервере. `true` когда хост никогда не задавал его. Когда `false`, `create_order` с `auto_renew: true` отклоняется с `auto_renew_not_allowed`, и `rental_hours` не может превышать `mrl` |
| `servers[x].price.on_demand`    | `[]string`         | Цена в день по запросу                                                                                                                                                                                                          |
| `servers[x].price.spot`         | `[]string`         | Минимальная цена спотового рынка в день                                                                                                                                                                                         |
| `servers[x].rented`             | `bool`             | Сервер арендован по запросу                                                                                                                                                                                                     |
| `servers[x].specs`              | `[]string`         | Характеристики сервера                                                                                                                                                                                                          |
| `servers[x].partial_gpu_rental` | `object` \| `bool` | `false` когда частичная аренда недоступна, иначе `{ total_gpus, available_gpus, free_indices }`                                                                                                                                 |

> `price.on_demand` и `price.spot` включайте только те валюты, которые фактически принимает каждый сервер — сервер без цены в какой-либо валюте нельзя арендовать в ней.
>
> Список — это кешированный снимок, поэтому изменение `mrl` или `auto_renew_allowed` сервера может отобразиться здесь через несколько минут.

**Пример**

Получить маркетплейс

**Входные данные:**

```
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,
      "auto_renew_allowed": true,
      "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>

**О разделе**

Получить ваши заказы

**Заголовки**

| Поле   | Тип      | Обязательно | Описание  |
| ------ | -------- | ----------- | --------- |
| `auth` | `строка` | Да          | API-токен |

**Строка запроса**

| Поле               | Тип    | Обязательно | Описание                                 |
| ------------------ | ------ | ----------- | ---------------------------------------- |
| `return_completed` | `bool` | Нет         | Возвращать завершенные (истекшие) заказы |

**Вывод**

| Поле                             | Тип        | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| -------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`                           | `int`      | Код статуса                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `лимит`                          | `int`      | В настоящее время всегда 999999                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `orders`                         | `[]string` | Массив заказов                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `orders[x].id`                   | `int`      | Уникальный ID заказа                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `orders[x].creation_fee`         | `float`    | Комиссия за создание, уплаченная [clore.ai](http://clore.ai/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `orders[x].price`                | `float`    | Цена заказа (стоимость) в день                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `orders[x].mrl`                  | `int`      | Секунд от создания до конца текущего срока. Продление добавляет к нему новый срок, поэтому `ct + mrl` всегда является текущим окончанием                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `orders[x].image`                | `строка`   | Используемый docker-образ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `orders[x].currency`             | `строка`   | Валюта, используемая для выставления счетов                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `orders[x].spend`                | `float`    | Фактически списанная на данный момент сумма: накопленная стоимость аренды плюс базовая плата арендатора (после уменьшения PoH) и любая дополнительная плата; не включает единовременную плату за создание                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `orders[x].gpu_count`            | `int`      | Количество GPU, которое занимает заказ (заказы по запросу; равно общему количеству GPU стойки, если это не частичная аренда)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `orders[x].ct`                   | `int`      | Время создания (время UNIX)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `orders[x].p`                    | `int`      | Текущий используемый кластер прокси                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `orders[x].specs`                | `[]string` | Характеристики сервера                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `orders[x].si`                   | `int`      | Уникальный ID сервера                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `orders[x].pub_cluster`          | `[]string` | Публичные конечные точки с перенаправленными портами                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `orders[x].tcp_ports`            | `[]string` | Перенаправление TCP-портов                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `orders[x].http_port`            | `строка`   | Порт контейнера, перенаправленный через HTTPS-прокси                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `orders[x].spot`                 | `bool`     | Признак того, что это спотовый заказ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `orders[x].expired`              | `bool`     | Признак того, что заказ истек                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `orders[x].rental_hours`         | `int`      | Часы, которые вы запросили, отсчитываются от создания (только для заказов по запросу). Отсутствует, если лимит не был запрошен: тогда заказ заканчивается при достижении максимальной длительности аренды хоста, если `auto_renew` включен, в этом случае он работает, пока вы не отмените                                                                                                                                                                                                                                                                                                                                                                                |
| `orders[x].rental_end`           | `int`      | Время UNIX, когда запрошенные часы исчерпаны; отсутствует, если лимит не был запрошен                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `orders[x].term_start`           | `int`      | Время UNIX, когда начался текущий срок (создание или последнее продление)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `orders[x].term_end`             | `int`      | Время UNIX, когда заканчивается текущий срок; всегда `ct + mrl`. Отсутствует у спотовых заказов и у заказа по запросу, созданного до внедрения автопродления и с тех пор никогда не редактировавшегося                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `orders[x].term_mrl`             | `int`      | Максимальная длительность аренды хоста в секундах на момент начала текущего срока. [`set_order_auto_renew`](#id-16-set_order_auto_renew) может продлить текущий срок до `term_start + term_mrl`                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `orders[x].last_renewal_at`      | `int`      | Время UNIX, когда было применено последнее продление; отсутствует до первого продления                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `orders[x].auto_renew`           | `bool`     | Продлевается ли заказ по текущей цене хоста, когда заканчивается текущий срок. Устанавливается в `false` когда продление отклонено. Отсутствует у заказа, созданного без автопродления и никогда не редактировавшегося                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `orders[x].auto_renew_max_price` | `float`    | Ваш предел цены за день для продлений, в валюте заказа. Продление отклоняется, когда цена хоста выше его                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `orders[x].renewals_count`       | `int`      | Количество примененных продлений на данный момент; отсутствует до первого продления                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `orders[x].pending_renewal`      | `object`   | Присутствует, пока запланировано продление на конец текущего срока: `price` (`float`, цена следующего срока за день) и `term_seconds` (`int`, длительность следующего срока в секундах)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `orders[x].auto_renew_declined`  | `object`   | Показывается после отклонения продления: `причина` и `в` (время решения в формате UNIX). Заказ завершится по окончании текущего срока. `причина` является одним из `price_above_cap` (новая цена хоста за день выше `auto_renew_max_price`), `server_unlisted` (сервер скрыт или удаляется, больше не принимает валюту заказа или не имеет в ней цены, либо больше не проходит проверки здоровья, которые должен проходить новый заказ), `host_disallowed` (хост отключил автопродление), `server_reserved` (сервер зарезервирован для другого арендатора) или `insufficient_balance` (после оплаты времени до конца срока ваш баланс покрыл бы менее часа по новой цене) |

> Каждый on-demand-заказ, созданный с момента внедрения автопродления, содержит `term_start`, `term_end` и `term_mrl`. Остальные поля продления появляются только когда применимы: `rental_hours` и `rental_end` когда были запрошены часы, `auto_renew` и `auto_renew_max_price` когда автопродление было запрошено при создании или задано через [`set_order_auto_renew`](#id-16-set_order_auto_renew), и `renewals_count` и `last_renewal_at` после первого продления. См. [Длительность аренды и автообновление](https://docs.clore.ai/clore.ai/clore.ai-ru/dlya-arendatorov/order-management.md#rental-length-and-auto-renewal).

**Входные данные:**

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

Первый заказ ниже — on-demand-заказ на сервере с максимальной длительностью аренды 73 часа (`mrl` из 262800 секунд), созданный с `rental_hours: 120` и включённым автопродлением, всё ещё в первом сроке. Второй — истёкший spot-заказ.

**Вывод:**

```
{
  "orders": [
    {
      "id": 38,
      "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",
      "ssh_auth": "password",
      "rental_hours": 120,
      "rental_end": 1667833396,
      "term_start": 1667401396,
      "term_end": 1667664196,
      "term_mrl": 262800,
      "auto_renew_max_price": 0.0000125,
      "auto_renew": true
    },{
      "id": 36,
      "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,
      "ssh_auth": "password",
      "expired": true,
      "tcp_ports": []
    }
  ],
  "limit": 999999,
  "code": 0
}
```

#### 6. `spot_marketplace` <a href="#id-6-spot_marketplace" id="id-6-spot_marketplace"></a>

**О разделе**

Получить spot-рынок для конкретного сервера

**Заголовки**

| Поле   | Тип      | Обязательно | Описание  |
| ------ | -------- | ----------- | --------- |
| `auth` | `строка` | Да          | API-токен |

**Строка запроса**

| Поле    | Тип   | Обязательно | Описание              |
| ------- | ----- | ----------- | --------------------- |
| `рынок` | `int` | Да          | Уникальный ID сервера |

**Вывод**

| Поле                           | Тип      | Описание                                                              |
| ------------------------------ | -------- | --------------------------------------------------------------------- |
| `code`                         | `int`    | Код статуса                                                           |
| `существует`                   | `bool`   | Проверка существования рынка                                          |
| `рынок`                        | `object` | Маркетплейсе                                                          |
| `market.offers`                | `массив` | Предложения аренды для сервера                                        |
| `market.offers[x].offer_id`    | `int`    | Уникальный ID предложения                                             |
| `market.offers[x].bid`         | `float`  | Предложенная цена за день (в валюте предложения)                      |
| `market.offers[x].currency`    | `строка` | Валюта ставки                                                         |
| `market.offers[x].active`      | `bool`   | Это предложение сейчас используется                                   |
| `market.offers[x].my`          | `bool`   | Это предложение принадлежит мне                                       |
| `market.server`                | `object` | Информация о сервере                                                  |
| `market.server.min_pricing`    | `object` | Минимальная цена предложения за день для каждой принимаемой валюты    |
| `market.server.mrl`            | `int`    | Максимальная длительность аренды в **часах**                          |
| `market.server.visibility`     | `строка` | Вы можете создавать предложения только при публичной видимости        |
| `market.server.online`         | `bool`   | Сервер онлайн                                                         |
| `market.currency_rates_in_usd` | `object` | Текущие USD-курсы, используемые для сравнения ставок в разных валютах |

> Ставки можно размещать в любой валюте, которую принимает сервер; конкурирующие ставки сравниваются по их **USD-стоимости** (используя `currency_rates_in_usd`), а не номиналу.
>
> ⚠️ **Изменено в августе 2026:** `market.server.mrl` теперь возвращается в **часах** (ранее — в секундах). Значение, которое отображалось как `262800` теперь отображается как `73`.

**Входные данные:**

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

**О разделе**

Настройте параметры сервера, который вы предоставляете на [clore.ai](http://clore.ai/) маркетплейсе

**Заголовки**

| Поле           | Тип      | Обязательно | Описание                       |
| -------------- | -------- | ----------- | ------------------------------ |
| `auth`         | `строка` | Да          | API-токен                      |
| `Content-type` | `строка` | Да          | Должен быть `application/json` |

**Тело**

| Поле                         | Тип      | Обязательно | Описание                                                                                                                                                                                                                                                                                                     |
| ---------------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name`                       | `строка` | Да          | Имя сервера, выбранное пользователем                                                                                                                                                                                                                                                                         |
| `доступность`                | `bool`   | Да          | Можно ли арендовать сервер                                                                                                                                                                                                                                                                                   |
| `mrl`                        | `int`    | Да          | Максимальная длительность аренды сервера в **часах** (6 to 3000)                                                                                                                                                                                                                                             |
| `bitcoin_on_demand`          | `float`  | Да          | Цена on-demand в BTC за день                                                                                                                                                                                                                                                                                 |
| `bitcoin_spot`               | `float`  | Да          | Минимальная spot-цена в BTC за день                                                                                                                                                                                                                                                                          |
| `CLORE-Blockchain_on_demand` | `float`  | Нет         | Цена on-demand в CLORE за день                                                                                                                                                                                                                                                                               |
| `CLORE-Blockchain_spot`      | `float`  | Нет         | Минимальная spot-цена в CLORE за день                                                                                                                                                                                                                                                                        |
| `USD-Blockchain_on_demand`   | `float`  | Нет         | Цена on-demand в USD за день                                                                                                                                                                                                                                                                                 |
| `USD-Blockchain_spot`        | `float`  | Нет         | Минимальная spot-цена в USD за день                                                                                                                                                                                                                                                                          |
| `enabled-bitcoin`            | `bool`   | Нет\*       | Принимать Bitcoin на этом сервере                                                                                                                                                                                                                                                                            |
| `enabled-CLORE-Blockchain`   | `bool`   | Нет\*       | Принимать CLORE на этом сервере                                                                                                                                                                                                                                                                              |
| `enabled-USD-Blockchain`     | `bool`   | Нет\*       | Принимать USD-стейблкоины на этом сервере                                                                                                                                                                                                                                                                    |
| `autoprice`                  | `object` | Нет         | Автоценообразование по валютам: укажите ключ валюты (`bitcoin`, `CLORE-Blockchain`) в `"usd"` для автоценообразования на основе USD или `false` для фиксированного ценообразования                                                                                                                           |
| `usd_pricing`                | `object` | Нет         | Целевые цены в USD по валютам, например `{ "bitcoin": { "on_demand": 10, "spot": 5 } }` — используется только для валют с `autoprice` установленным значением `"usd"`                                                                                                                                        |
| `auto_renew_allowed`         | `bool`   | Нет         | Разрешить on-demand-заказам арендаторов продлеваться по вашей текущей цене, когда они достигают `mrl`. Опустите это, чтобы сохранить сохранённую настройку; сервер, для которого она никогда не задавалась, разрешает продления. Значение, отличное от `true` или `false` отклоняется с кодом `2` (HTTP 400) |

> \* **Список принимаемых валют пересобирается из `enabled-*` флагов при каждом вызове.** Валюта без своего `enabled-<currency>: true` флага (или без действительной цены) исключается из принимаемых сервером валют — если опустить все флаги, сервер станет недоступен для аренды в любой валюте. Всегда отправляйте `enabled-<currency>: true` для каждой валюты, которую вы хотите продолжать принимать.
>
> Цены за день ограничены по валютам: 0.000001–0.1 BTC, 0.1–5,000,000 CLORE, 0.1–10,000 USD.
>
> Когда для валюты включено автоценообразование в USD, её указанная криптоцена выводится из `usd_pricing` по текущему обменному курсу (пересчитывается примерно каждые 10 минут), а любое `<currency>_on_demand` / `<currency>_spot` значение, переданное для неё, игнорируется. The `usd_pricing` целевые значения — это общесерверные показатели $/день, проверяемые по диапазону USD (0.1–10,000); значения вне диапазона ограничиваются ближайшей границей.
>
> При `auto_renew_allowed` включённом состоянии (по умолчанию), `mrl` это также ваш период изменения цены: заказ, для которого арендатор выбрал автопродление, продлевается каждый раз, когда достигает `mrl`, по вашей цене в этот момент. Установка в `false` никогда не завершает уже идущую аренду: каждый заказ на сервере завершает текущий срок, а его продление отклоняется с `host_disallowed`.

**Вывод**

| Поле   | Тип   | Описание    |
| ------ | ----- | ----------- |
| `code` | `int` | Код статуса |

**Пример**

**Входные данные:**

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

**Вывод:**

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

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

**О разделе**

Установите цену за день для вашего SPOT-предложения на рынке

**Заголовки**

| Поле           | Тип      | Обязательно | Описание                       |
| -------------- | -------- | ----------- | ------------------------------ |
| `auth`         | `строка` | Да          | API-токен                      |
| `Content-type` | `строка` | Да          | Должен быть `application/json` |

**Тело**

| Поле            | Тип     | Обязательно | Описание                       |
| --------------- | ------- | ----------- | ------------------------------ |
| `order_id`      | `int`   | Да          | Уникальный ID предложения      |
| `desired_price` | `float` | Да          | Ваша предложенная цена за день |

> **Цена ниже текущего минимального spot-порога сервера** отклоняется с указанием текущего минимума:
>
> ```
> { "error": "amount_too_low", "min_price": 0.0000012, "code": 6 }
> ```
>
> **Повышение должно быть как минимум на 1% выше и вашей текущей ставки, и максимальной ставки сервера в той же валюте** (округлено вверх до точности валюты, с ограничением по верхнему пределу цены). Меньшее повышение отклоняется с указанием минимально допустимой цены:
>
> ```
> { "error": "below_min_raise_step", "min_price": 0.00000425, "code": 6 }
> ```

**Пример**

Попробуем обновить цену spot-рынка

**Ввод 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 (снижение было слишком большим):**\
Вы можете снизить цену предложения на spot-рынке максимум на 0.00000100 ₿

| Поле       | Тип      | Описание                                                                 |
| ---------- | -------- | ------------------------------------------------------------------------ |
| `code`     | `int`    | Код статуса                                                              |
| `error`    | `строка` | Поле описания ошибки                                                     |
| `max_step` | `float`  | Наименьшее возможное значение, до которого вы сейчас можете снизить цену |

```
{
    "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):**\
Снижать spot-цену можно раз в 600 секунд

| Поле               | Тип      | Описание                                                        |
| ------------------ | -------- | --------------------------------------------------------------- |
| `code`             | `int`    | Код статуса                                                     |
| `error`            | `строка` | Поле описания ошибки                                            |
| `time_to_lowering` | `float`  | Оставшееся время (в сек.) до следующей возможности снизить цену |

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

**О разделе**

Отменить активный заказ или spot-предложение

**Заголовки**

| Поле           | Тип      | Обязательно | Описание                       |
| -------------- | -------- | ----------- | ------------------------------ |
| `auth`         | `строка` | Да          | API-токен                      |
| `Content-type` | `строка` | Да          | Должен быть `application/json` |

**Тело**

| Поле       | Тип      | Обязательно | Описание                                                                                                                                  |
| ---------- | -------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `id`       | `int`    | Да          | Уникальный ID заказа/предложения                                                                                                          |
| `проблема` | `строка` | Нет         | Если у вас возникли какие-либо проблемы с сервером, вы можете сообщить о них [clore.ai](http://clore.ai/) команде, максимум 2048 символов |

**Вывод**

| Поле   | Тип   | Описание    |
| ------ | ----- | ----------- |
| `code` | `int` | Код статуса |

**Пример**

Отменить заказ/предложение

**Входные данные:**\
В этом примере мы сообщаем о проблемах с GPU #1; если проблем нет, не включайте поле issue.\
Вы можете написать любое сообщение в поле text, и мы его рассмотрим

```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
    "id":39,
    "issue":"GPU #1 перегревался и троттлил"
}' 'https://api.clore.ai/v1/cancel_order'
```

**Вывод:**

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

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

**О разделе**

С помощью этого endpoint вы можете создать spot-предложение или on-demand-заказ

**Заголовки**

| Поле           | Тип      | Обязательно | Описание                       |
| -------------- | -------- | ----------- | ------------------------------ |
| `auth`         | `строка` | Да          | API-токен                      |
| `Content-type` | `строка` | Да          | Должен быть `application/json` |

**Тело**

| Поле                   | Тип      | Обязательно | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ---------------------- | -------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `currency`             | `строка` | Да          | Название валюты                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `image`                | `строка` | Да          | Допустимый образ из Docker Hub                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `renting_server`       | `int`    | Да          | ID сервера, который вы хотите арендовать                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `type`                 | `строка` | Да          | `on-demand` ИЛИ `спот`                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `spotprice`            | `float`  | Зависит     | Предлагаемая цена за день на spot-рынке, обязательна при создании spot-заказа                                                                                                                                                                                                                                                                                                                                                                                                       |
| `ports`                | `object` | Нет         | Конфигурация проброса портов, максимум 5 записей                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `env`                  | `object` | Нет         | <p>Переменные окружения, в сумме не более 12288 символов после преобразования в строку.<br>Имя переменной — максимум 128 символов, не должно содержать <code>-</code><br>Значение переменной — максимум 1536 символов<br>Сохраняются только первые 30 допустимых переменных; лишние отбрасываются без уведомления</p>                                                                                                                                                               |
| `jupyter_token`        | `строка` | Нет         | Токен Jupyter для образов с Jupyter Notebook, максимум 32 символа \*                                                                                                                                                                                                                                                                                                                                                                                                                |
| `ssh_key`              | `строка` | Нет         | SSH-ключ для образов с SSH, максимум 3072 символа \*                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `ssh_password`         | `строка` | Нет         | SSH-пароль для образов с SSH, максимум 32 символа \*                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `command`              | `строка` | Нет         | Команда будет выполнена на сервере после создания заказа                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `required_price`       | `float`  | Нет         | Укажите цену, по которой вы хотите запустить заказ; если владелец машины изменит цену, заказ не запустится (только on-demand)                                                                                                                                                                                                                                                                                                                                                       |
| `gpu_count`            | `int`    | Нет         | Количество GPU для аренды на серверах, которые поддерживают [частичной арендой](https://docs.clore.ai/clore.ai/clore.ai-ru/dlya-arendatorov/partial-gpu-rental.md). Опустите, чтобы арендовать всю ферму. Только on-demand, только однородные фермы                                                                                                                                                                                                                                 |
| `gpu_indices`          | `[]int`  | Нет         | Индексы слотов GPU для аренды, начиная с 0; длина должна равняться `gpu_count`. Берите свободные слоты из `partial_gpu_rental.free_indices`. Опустите, чтобы backend автоматически выбрал свободные GPU                                                                                                                                                                                                                                                                             |
| `autossh_entrypoint`   | `bool`   | Нет         | Используйте entrypoint clore.ai, который автоматически разворачивает SSH-сервер и пользовательский `/root/onstart.sh` скрипт                                                                                                                                                                                                                                                                                                                                                        |
| `rental_hours`         | `int`    | Нет         | Только on-demand. На какое время вам нужна машина, в полных часах от 1 до 3000 (максимум платформы), отсчитывая от создания заказа. Опустите, чтобы запросить безлимит: тогда заказ завершится в момент `mrl` если только `auto_renew` включено, в этом случае он будет действовать, пока вы не отмените его. Значение выше серверного `mrl` требует `auto_renew: true`; значение, равное ему или ниже, завершает заказ после этого количества часов. Игнорируется для spot-заказов |
| `auto_renew`           | `bool`   | Нет         | Только on-demand. Когда достигается максимальная длительность аренды сервера, продлевать заказ на том же контейнере по текущей цене сервера, пока эта цена не будет не выше `auto_renew_max_price`, пока `rental_hours` не будут использованы, или пока вы не отмените, когда `rental_hours` опущено. При продлении комиссия за создание не взимается. Отклоняется для spot-заказов и на серверах, у которых `auto_renew_allowed` равно `false`                                     |
| `auto_renew_max_price` | `float`  | Зависит     | Требуется, когда `auto_renew` равно `true`. Лимит цены за день в валюте заказа, больше 0 и не выше максимальной цены рынка для этой валюты (0.1 BTC, 5,000,000 CLORE, 10,000 USD). При каждом продлении он сравнивается с ценой сервера за день, масштабированной к `gpu_count` при частичной аренде                                                                                                                                                                                |

\* В поля, отмеченные звёздочкой, можно вводить только символы из этой группы regexp `/^[a-zA-Z0-9\s-=.@+/]+$/`

**Вывод**

| Поле    | Тип      | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`  | `int`    | Код статуса                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `error` | `строка` | Показывается с кодом `6` (HTTP 200), когда заказ отклонён. Отклонения по длительности аренды и автопродлению: `invalid_rental_hours` (не целое число от 1 до 3000 или `null`), `rental_hours_exceeds_mrl` (выше серверного `mrl` без `auto_renew: true`), `invalid_auto_renew` (`auto_renew` не является логическим значением, или оно `true` без положительного `auto_renew_max_price`, или со значением выше максимальной цены рынка для этой валюты), `auto_renew_not_supported` (`auto_renew: true` для spot-заказа), `auto_renew_not_allowed` (сервер не разрешает автопродление). Отклонения spot-ставок описаны ниже |

> **Spot-ставки ниже нижней границы сервера** отклоняются с указанием текущего минимума, так что вы можете повторить сразу:
>
> ```
> { "error": "too_low_price", "min_price": 0.0000012, "code": 6 }
> ```
>
> Нижняя граница пересчитывается по текущим курсам монет примерно каждые 10 минут, поэтому цена, взятая из листинга на рынке, может быть немного устаревшей — всегда используйте возвращаемое `min_price` для повторной попытки.
>
> **Когда у сервера уже есть spot-ставки в той же валюте**, новая ставка должна быть как минимум на 1% выше верхней (округлено вверх до точности валюты, с ограничением по верхнему пределу цены). Более низкая ставка отклоняется с указанием минимально допустимой цены:
>
> ```
> { "error": "below_min_raise_step", "min_price": 0.00000425, "code": 6 }
> ```

**Пример**

**Ввод 1 (создать spot-предложение):**

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

**Ввод 3 (Заказ по требованию на 48 часов с автопродлением):**

```
curl -XPOST -H 'auth: 6FcuR7ibcwKR1Z32lEFoSotzUUtzKO2H' -H "Content-type: application/json" -d '
{
    "currency":"CLORE-Blockchain",
    "image":"cloreai/jupyter:ubuntu24.04-v2",
    "renting_server":6,
    "type":"on-demand",
    "rental_hours":48,
    "auto_renew":true,
    "auto_renew_max_price":250
}' 'https://api.clore.ai/v1/create_order'
```

**Вывод 3 (Заказ по требованию на 48 часов с автопродлением):**

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

На сервере с 24-часовым `mrl` первый срок длится 24 часа. В его конце заказ продлевается ещё на 24 часа по цене сервера на тот момент, если она равна или ниже 250 CLORE в день, после чего заканчивается, поскольку запрошенные 48 часов исчерпаны. При `auto_renew` включено, при опускании `rental_hours` он будет продлеваться, пока вы не отмените его. Без `auto_renew`, тот же `rental_hours` на этом сервере отклоняется:

```
{ "error": "rental_hours_exceeds_mrl", "code": 6 }
```

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

**О разделе**

Получите текущую конфигурацию комиссий: базовые комиссии арендатора, настройки снижения комиссии по PoH, комиссии за создание заказов и ваш баланс PoH

**Заголовки**

| Поле   | Тип      | Обязательно | Описание  |
| ------ | -------- | ----------- | --------- |
| `auth` | `строка` | Да          | API-токен |

**Вывод**

| Поле                               | Тип      | Описание                                                        |
| ---------------------------------- | -------- | --------------------------------------------------------------- |
| `code`                             | `int`    | Код статуса                                                     |
| `renter_fees.on_demand`            | `object` | Базовая комиссия (%) по каждой валюте для заказов по требованию |
| `renter_fees.spot`                 | `object` | Базовая комиссия (%) по каждой валюте для спотовых заказов      |
| `poh_config.max_reduction_percent` | `int`    | Максимальное снижение базовой комиссии через PoH (%)            |
| `poh_config.max_poh_amount`        | `int`    | Баланс PoH, при котором достигается максимальное снижение       |
| `creation_fees.on_demand`          | `object` | Комиссия за создание заказа по каждой валюте                    |
| `creation_fees.spot`               | `object` | Комиссия за создание спотового заказа по каждой валюте          |
| `poh_balance`                      | `float`  | Ваш баланс PoH CLORE                                            |

**Входные данные:**

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

**Вывод:**

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

**О разделе**

Отмените несколько заказов сразу (до 256 за запрос)

**Заголовки**

| Поле           | Тип      | Обязательно | Описание                       |
| -------------- | -------- | ----------- | ------------------------------ |
| `auth`         | `строка` | Да          | API-токен                      |
| `Content-type` | `строка` | Да          | Должен быть `application/json` |

**Тело**

| Поле        | Тип     | Обязательно | Описание                                        |
| ----------- | ------- | ----------- | ----------------------------------------------- |
| `order_ids` | `[]int` | Да          | Идентификаторы заказов для отмены, максимум 256 |

**Вывод**

| Поле               | Тип     | Описание                                            |
| ------------------ | ------- | --------------------------------------------------- |
| `code`             | `int`   | Код статуса                                         |
| `failed_to_cancel` | `[]int` | Идентификаторы заказов, которые не удалось отменить |

**Входные данные:**

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

**Вывод:**

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

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

**О разделе**

Получите баланс Proof of Holding: items, totals и суммы предложений на PoH Marketplace

**Заголовки**

| Поле   | Тип      | Обязательно | Описание  |
| ------ | -------- | ----------- | --------- |
| `auth` | `строка` | Да          | API-токен |

**Вывод**

| Поле                                          | Тип        | Описание                                      |
| --------------------------------------------- | ---------- | --------------------------------------------- |
| `code`                                        | `int`      | Код статуса                                   |
| `items`                                       | `[]object` | Ваши items PoH с отдельными балансами         |
| `balance.total`                               | `float`    | Общий баланс PoH по всем items                |
| `balance.free_amount`                         | `float`    | Баланс PoH, не привязанный к предложениям     |
| `balance.reward_amount`                       | `float`    | Баланс, имеющий право на вознаграждения       |
| `balance.offers.rented_amount`                | `float`    | Сумма, сданная в аренду другим пользователям  |
| `balance.offers.rented_on_marketplace_amount` | `float`    | Сумма, размещённая на PoH Marketplace         |
| `balance.offers.leased_amount`                | `float`    | Сумма, взятая в аренду у других пользователей |

**Входные данные:**

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

**Вывод:**

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

**О разделе**

Получите статические данные конфигурации API. Аутентификация не требуется

**Входные данные:**

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

**О разделе**

Получите узлы ретрансляции для переадресации TCP для обнаруженной вами страны. Аутентификация не требуется

**Вывод**

| Поле      | Тип      | Описание                    |
| --------- | -------- | --------------------------- |
| `code`    | `int`    | Код статуса                 |
| `country` | `строка` | Обнаруженный код страны     |
| `nodes`   | `object` | Доступные узлы ретрансляции |

**Входные данные:**

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

#### 16. `set_order_auto_renew` <a href="#id-16-set_order_auto_renew" id="id-16-set_order_auto_renew"></a>

**О разделе**

Измените запрошенную длительность аренды, автопродление и его ценовой лимит для вашего активного заказа по требованию. Отправляйте только поля, которые хотите изменить; пропущенное поле сохранит текущее значение. Только POST; на GET возвращается код `4`.

* Текущий срок затем заканчивается в запрошенный момент окончания или в `term_start + term_mrl`, в зависимости от того, что наступит раньше, и не раньше чем через 60 секунд от текущего момента. `mrl` и `term_end` измените, чтобы соответствовать. Продление после `term_start + term_mrl` требует `auto_renew`, а продление в конце срока меняет его цену.
* Увеличение запрошенного срока сверх `term_start + term_mrl` возможно только пока `auto_renew` включено; в противном случае это отклоняется с `rental_hours_exceeds_mrl`. Изменение установленного `rental_hours` на `null` пока `auto_renew` остаётся выключенным, считается увеличением срока, а правка, которая переключает `auto_renew` выключение при отправке новых `rental_hours` чьи сроки окончания выходят за `term_start + term_mrl` отклоняется так же.
* Уменьшение запрошенного срока без переключения `auto_renew` выключения в том же изменении всегда принимается, как и переключение `auto_renew` выключения без новых часов или с `rental_hours: null`. Если новые `rental_hours` уже исчерпаны, заказ заканчивается примерно через минуту после изменения. Чтобы остановить аренду немедленно, используйте [`cancel_order`](#id-9-cancel_order).
* `rental_hours: null` удаляет запрошенный лимит: при `auto_renew` включённом значении заказ затем действует, пока вы его не отмените.
* Начиная с 60 секунд до окончания срока и до тех пор, пока срок не будет продлён или заказ не завершится, изменение отклоняется с `renewal_in_progress`. Снова прочитайте заказ с помощью [`my_orders`](#id-5-my_orders) и повторите попытку.
* Для заказа, созданного до внедрения автопродления, первое изменение устанавливает `term_start` на время создания и `term_mrl` на `mrl`, поэтому без `auto_renew` он не может работать дольше своего первоначального окончания.

**Заголовки**

| Поле           | Тип      | Обязательно | Описание                       |
| -------------- | -------- | ----------- | ------------------------------ |
| `auth`         | `строка` | Да          | API-токен                      |
| `Content-type` | `строка` | Да          | Должен быть `application/json` |

**Тело**

| Поле                   | Тип             | Обязательно | Описание                                                                                                                                                                                                                                                                  |
| ---------------------- | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `order_id`             | `int`           | Да          | Уникальный ID заказа                                                                                                                                                                                                                                                      |
| `rental_hours`         | `int` \| `null` | Нет         | Новая запрошенная длительность в полных часах (от 1 до 3000), отсчитывается от создания заказа. `null` удаляет запрошенный лимит. Опустите его, чтобы сохранить текущее значение                                                                                          |
| `auto_renew`           | `bool`          | Нет         | Продлевать по текущей цене хоста, когда текущий срок заканчивается. Опустите его, чтобы сохранить текущее значение. Включение отклоняется, когда сервер `auto_renew_allowed` равно `false`                                                                                |
| `auto_renew_max_price` | `float`         | Зависит     | Дневной ценовой лимит в валюте заказа, выше 0 и не больше максимальной цены маркетплейса для этой валюты. Обязательно, когда это изменение включает `auto_renew` автопродление, и у заказа ещё нет лимита; в противном случае опустите его, чтобы сохранить текущий лимит |

**Вывод**

| Поле    | Тип      | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`  | `int`    | Код статуса. `2` (HTTP 400), когда тело имеет неверный тип, например отсутствующий или нецелочисленный `order_id`, `rental_hours` который не является ни целым числом, ни `null`, не логическим `auto_renew` или нечисловым `auto_renew_max_price`; это проверяется до любой ошибки ниже                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `error` | `строка` | Показывается с кодом `6` (HTTP 200): `you_dont_own_this_order` (заказ не существует или не принадлежит вам), `order_not_active` (спотовый или закрытый заказ, заказ, находящийся в процессе отмены, или тот, который завершился, пока изменение сохранялось), `renewal_in_progress` (текущий срок заканчивается в течение 60 секунд, или заказ изменился, пока изменение сохранялось; снова прочитайте заказ и повторите попытку), `invalid_rental_hours` (ниже 1 или выше 3000), `rental_hours_exceeds_mrl` (см. правила выше), `invalid_auto_renew` (`auto_renew` (в итоге оказывается включённым без действительного ценового лимита), `auto_renew_not_allowed` (это изменение включает `auto_renew` автопродление, а сервер не позволяет автопродление) |

**Пример**

**Ввод 1 (Продлевать, пока не будет отменено):**

```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
    "order_id":12345,
    "rental_hours":null,
    "auto_renew":true,
    "auto_renew_max_price":30
}' 'https://api.clore.ai/v1/set_order_auto_renew'
```

**Вывод 1 (Продлевать, пока не будет отменено):**

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

**Ввод 2 (Остановить продление, заказ завершится по окончании текущего срока):**

```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
    "order_id":12345,
    "auto_renew":false
}' 'https://api.clore.ai/v1/set_order_auto_renew'
```

**Вывод 2 (Остановить продление, заказ завершится по окончании текущего срока):**

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

Если отправить в последние 60 секунд срока, тот же запрос отклоняется, пока заказ не будет продлён или завершён:

```
{ "error": "renewal_in_progress", "code": 6 }
```

#### 17. `order_renewals` <a href="#id-17-order_renewals" id="id-17-order_renewals"></a>

**О разделе**

Получите историю продлений вашего заказа: по одной строке на каждое решение о продлении, принятое в конце срока, продлено или отклонено, самые новые первыми, максимум 1000 строк. Заказ, который ни разу не дошёл до решения о продлении, возвращает пустой список, а окончание, на котором заказ останавливается из-за исчерпания запрошенных часов, не оставляет строки. Только POST; на GET возвращается код `4`.

**Заголовки**

| Поле           | Тип      | Обязательно | Описание                       |
| -------------- | -------- | ----------- | ------------------------------ |
| `auth`         | `строка` | Да          | API-токен                      |
| `Content-type` | `строка` | Да          | Должен быть `application/json` |

**Тело**

| Поле       | Тип   | Обязательно | Описание             |
| ---------- | ----- | ----------- | -------------------- |
| `order_id` | `int` | Да          | Уникальный ID заказа |

**Вывод**

| Поле                       | Тип        | Описание                                                                                                                                                                                                                                          |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`                     | `int`      | Код статуса. `2` (HTTP 400), когда `order_id` отсутствует или не является целым числом                                                                                                                                                            |
| `error`                    | `строка`   | `you_dont_own_this_order` с кодом `6` (HTTP 200), когда заказ не существует или не принадлежит вам                                                                                                                                                |
| `renewals`                 | `[]object` | Решения о продлении, самые новые первыми; присутствуют только при успехе                                                                                                                                                                          |
| `renewals[x].order_id`     | `int`      | Уникальный ID заказа                                                                                                                                                                                                                              |
| `renewals[x].renewal_no`   | `int`      | Номер этого продления или тот, который оно имело бы среди продлений заказа, начиная с 1                                                                                                                                                           |
| `renewals[x].outcome`      | `строка`   | `renewed` или `declined`                                                                                                                                                                                                                          |
| `renewals[x].reason`       | `строка`   | Только для отклонённых строк: `price_above_cap`, `server_unlisted`, `host_disallowed`, `server_reserved` или `insufficient_balance` (см. `orders[x].auto_renew_declined` в [`my_orders`](#id-5-my_orders))                                        |
| `renewals[x].decided_at`   | `int`      | Время UNIX решения, принятого, когда срок уже закончился                                                                                                                                                                                          |
| `renewals[x].applied_at`   | `int`      | Время UNIX, когда было подтверждено, что продление вступило в силу. Отсутствует при отклонении и при решении о продлении, которое не было подтверждено; решение может остаться неприменённым, когда заказ был отменён или изменён в тот же момент |
| `renewals[x].old_price`    | `float`    | Дневная цена срока, который закончился                                                                                                                                                                                                            |
| `renewals[x].new_price`    | `float`    | Дневная цена нового срока, или при отклонении — цена хоста, которая была отклонена; отсутствует, когда цену нельзя было вычислить                                                                                                                 |
| `renewals[x].cap`          | `float`    | Ваш дневной ценовой лимит на момент принятия решения                                                                                                                                                                                              |
| `renewals[x].term_seconds` | `int`      | Длительность нового срока в секундах; `0` при отклонении                                                                                                                                                                                          |
| `renewals[x].term_start`   | `int`      | Время UNIX начала нового срока (окончание предыдущего); при отклонении — начало срока, который закончился                                                                                                                                         |
| `renewals[x].term_end`     | `int`      | Время UNIX окончания нового срока; при отклонении — окончание срока, который закончился                                                                                                                                                           |

**Пример**

**Входные данные:**

```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
    "order_id":12345
}' 'https://api.clore.ai/v1/order_renewals'
```

**Вывод:**

В этом примере заказ был продлён один раз по цене 24 в день, что укладывалось в лимит 30. В конце этого срока цена хоста была 36, выше лимита, поэтому продление было отклонено, и заказ завершился этим сроком.

```
{
  "renewals": [
    {
      "order_id": 12345,
      "renewal_no": 2,
      "outcome": "declined",
      "reason": "price_above_cap",
      "decided_at": 1792209661,
      "old_price": 24,
      "new_price": 36,
      "cap": 30,
      "term_seconds": 0,
      "term_start": 1792188060,
      "term_end": 1792209660
    },
    {
      "order_id": 12345,
      "renewal_no": 1,
      "outcome": "renewed",
      "decided_at": 1792188061,
      "applied_at": 1792188061,
      "old_price": 20,
      "new_price": 24,
      "cap": 30,
      "term_seconds": 21600,
      "term_start": 1792188060,
      "term_end": 1792209660
    }
  ],
  "code": 0
}
```


---

# 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-ru/dlya-khostov/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.
