API
💡 Разработчикам Python: Используйте официальный clore-ai Python SDK вместо прямых вызовов API. Он автоматически обрабатывает аутентификацию, ограничение скорости, повторные попытки и обработку ошибок.
Быстрый старт:
pip install clore-ai— См. документацию Python SDK и Справочник CLI.
🧭 Предпочитаете справочник с навигацией? Откройте интерактивную документацию API по адресу clore.ai/api-docs. Базовый URL для всех конечных точек на этой странице:
https://api.clore.ai/v1/.
Введение
CLORE.AI api можно использовать для автоматизации развёртывания ваших рабочих нагрузок на CLORE.AI
Сначала вам нужно получить API-ключ
Ответы API
Ответы возвращаются в формате JSON, могут иметь разные поля
Всегда возвращаемое поле — code, обозначающее статус
поле code
0
НОРМАЛЬНО
1
ОШИБКА БАЗЫ ДАННЫХ
2
НЕДОПУСТИМЫЕ ДАННЫЕ ВВОДА
3
НЕДЕЙСТВИТЕЛЬНЫЙ API-ТОКЕН
4
НЕДЕЙСТВИТЕЛЬНАЯ КОНЕЧНАЯ ТОЧКА
5
ПРЕВЫШЕН ЛИМИТ 1 ЗАПРОС/СЕКУНДУ
6
Ошибка указана в ошибка поле
Конечные точки
1. Кошельки
Описание
Возвращает кошельки и балансы
Заголовки
auth
строка
Да
API-токен
Вывод
code
int
Код статуса
Кошельки
[]строка
Массив кошельков
Пример
Вход:
Вывод:
2. my_servers
Описание
Возвращает ваши серверы, которые вы предоставляете clore.ai маркетплейсе
Заголовки
auth
строка
Да
API-токен
Вывод
code
int
Код статуса
лимит
int
Максимальное число серверов, которыми вы можете владеть
серверы
[]строка
Массив серверов
servers[x].name
строка
Имя сервера, выбранное пользователем
servers[x].visibility
строка
Видимость на маркетплейсе
servers[x].pricing
[]строка
Цена/день по запросу
servers[x].online
bool
Сервер онлайн
servers[x].min_spot_pricing
[]строка
Минимальная цена/день для аренды на спотовом рынке
servers[x].init_token
строка
Токен инициализации
servers[x].specs
[]строка
Спецификации сервера
servers[x].remaining_time
int
Время окончания аренды последнего активного заказа (эпоха в мс, 0 если не арендован)
servers[x].rental_state
строка
Сводное состояние аренды GPU: нет, частично, или полностью
servers[x].rented_gpus
int
GPU, арендованные в активных заказах
servers[x].total_gpus
int
Общее число GPU на сервере
servers[x].rented_price_by_currency
объект
Сумма цен активных заказов, сгруппированная по валюте
servers[x].update_channel
строка
Канал обновлений хостинг-агента: стабильный или бета
servers[x].requested_channel
строка
Запрос на переключение канала из веб-интерфейса (присутствует только при запросе)
servers[x].target_backend_version
int
Версия backend, которой соответствует текущий канал
Пример
Вход:
Вывод:
Значения USD в pricing объектах отражают режим ценообразования в USD, когда его включил хост.
3. server_config
Описание
Получить конфигурацию конкретного сервера
Заголовки
auth
строка
Да
API-токен
Тип содержимого
строка
Да
Должен быть application/json
Тело
server_name
строка
Да
Имя сервера
Вывод
code
int
Код статуса
creation_completed
bool
Завершено ли создание сервера
config
[]строка
Конфигурация сервера
config.name
строка
Имя сервера, выбранное пользователем
config.visibility
строка
Видимость на маркетплейсе
config.pricing
[]строка
Цена/день по запросу
config.spot_pricing
[]строка
Минимальная цена/день для аренды на спотовом рынке
config.mrl
int
Максимальная длительность аренды в часах
config.online
bool
Сервер онлайн
config.id
int
Уникальный ID сервера
config.rental_status
int
0 - не арендован | 1 - Арендован на спотовом рынке | 2 - Арендован по запросу
config.specs
[]строка
Спецификации сервера
config.background_job
[]строка
Фоновая задача, когда не арендован
config.tenants
[]объект
Активные заказы на сервере: rental_type, currency, цену, remaining_time, gpu_count
server_configтакже возвращает те же поля rental_state и update_channel, что иmy_servers:remaining_time,rental_state,rented_gpus,total_gpus,rented_price_by_currency,update_channel,requested_channel,target_backend_version.
Пример
Вход:
Вывод:
Значения USD в pricing объектах отражают режим ценообразования в USD, когда его включил хост.
4. маркетплейсе
Описание
Получить маркетплейс
Заголовки
auth
строка
Да
API-токен
Вывод
code
int
Код статуса
my_servers
[]строка
Массив ID серверов, которые вы предоставляете на clore.ai (не может быть арендован)
серверы
[]строка
Массив публичных серверов на маркетплейсе
servers[x].id
int
Уникальный ID сервера
servers[x].owner
int
Уникальный ID владельца
servers[x].mrl
int
Максимальная длительность аренды в часах
servers[x].price.on_demand
[]строка
Цена по запросу за день
servers[x].spot
[]строка
Минимальная цена спотового рынка за день
servers[x].rented
bool
Сервер арендован по запросу
servers[x].specs
[]строка
Спецификации сервера
servers[x].partial_gpu_rental
объект | bool
false когда частичная аренда недоступна, иначе { total_gpus, available_gpus, free_indices }
Пример
Получить маркетплейс
Вход:
Вывод:
5. my_orders
Описание
Получить ваши заказы
Заголовки
auth
строка
Да
API-токен
Строка запроса
return_completed
bool
Нет
Возвращать завершённые (истекшие) заказы
Вывод
code
int
Код статуса
лимит
int
Максимальное число активных заказов
заказы
[]строка
Массив заказов
orders[x].id
int
Уникальный ID заказа
orders[x].price
float
Цена заказа (стоимость) в день
orders[x].mrl
int
Максимальная длительность аренды заказа в секундах
orders[x].image
строка
Используемый docker-образ
orders[x].currency
строка
Валюта, используемая для выставления счетов
orders[x].spend
float
Средства, потраченные на заказ
orders[x].ct
int
Время создания (время UNIX)
orders[x].p
int
Текущий используемый кластер прокси
orders[x].specs
[]строка
Спецификации сервера
orders[x].si
int
Уникальный ID сервера
orders[x].pub_cluster
[]строка
Публичные конечные точки с проброшенными портами
orders[x].tcp_ports
[]строка
Проброс TCP-портов
orders[x].http_port
строка
Порт контейнера, проброшенный через HTTPS-прокси
orders[x].spot
bool
Признак того, что это спотовый заказ
orders[x].expired
bool
Признак того, что заказ истёк
Вход:
Вывод:
6. спотовый маркетплейс
Описание
Получить спотовый маркетплейс для конкретного сервера
Заголовки
auth
строка
Да
API-токен
Строка запроса
рынок
int
Да
Уникальный ID сервера
Вывод
code
int
Код статуса
существует
bool
Проверка того, что рынок существует
рынок
объект
Marketplace
market.offers
массив
Предложения аренды для сервера
market.offers[x].offer_id
int
Уникальный ID предложения
market.offers[x].bid
float
Предложенная цена в день
market.offers[x].active
bool
Это предложение сейчас используется
market.offers[x].my
bool
Это предложение принадлежит мне
market.server
объект
Информация о сервере
market.server.min_pricing
объект
Минимальная цена предложения в день
market.server.mrl
int
Максимальная длительность аренды в секундах
market.server.visibility
строка
Создавать предложения можно только когда видимость — public
market.server.online
bool
Сервер онлайн
Вход:
Вывод:
7. set_server_settings
Описание
Настройте параметры сервера, который вы предоставляете на clore.ai маркетплейсе
Заголовки
auth
строка
Да
API-токен
Тип содержимого
строка
Да
Должен быть application/json
Тело
name
строка
Да
Имя сервера, выбранное пользователем
доступность
bool
Да
Можно ли арендовать сервер
mrl
int
Да
Максимальная длительность аренды сервера
on_demand
float
Да
Цена в день для вашего сервера по запросу
spot
float
Да
Минимальная цена в день для SPOT-предложения
Цены за день ограничены 0,015 BTC / 600 000 CLORE / 1 000 USD.
Вывод
code
int
Код статуса
Пример
Давайте создадим proof отправки для транзакции, отправленной из текущего кошелька.
Вход:
Вывод:
8. set_spot_price
Описание
Установите цену за день для вашего предложения на SPOT-рынке
Заголовки
auth
строка
Да
API-токен
Тип содержимого
строка
Да
Должен быть application/json
Тело
order_id
int
Да
Уникальный ID предложения
desired_price
float
Да
Предлагаемая вами цена за день
Пример
Давайте попробуем обновить цену на спотовом рынке
Ввод 1 (Снижение было слишком большим):
Возможный результат 1 (Снижение было слишком большим): Вы можете снизить цену предложения на спотовом рынке максимум на 0.00000100 ₿
code
int
Код статуса
ошибка
строка
Поле описания ошибки
max_step
float
Наименьшее возможное значение, до которого вы сейчас можете снизить цену
Ввод 2 (Корректное снижение цены):
Возможный результат 2 (Корректное снижение цены):
Ввод 3 (Снизить цену еще больше после отправки Ввода 2):
Возможный результат 3 (Снизить цену еще больше после отправки Ввода 2): Вы можете снижать спотовую цену раз в 600 секунд
code
int
Код статуса
ошибка
строка
Поле описания ошибки
time_to_lowering
float
Оставшееся время (сек.) до следующей возможности снизить цену
9. cancel_order
Описание
Отменить активный заказ или спотовое предложение
Заголовки
auth
строка
Да
API-токен
Тип содержимого
строка
Да
Должен быть application/json
Тело
id
int
Да
Уникальный ID заказа/предложения
issue
строка
Нет
Если вы столкнулись с какими-либо проблемами с сервером, вы можете сообщить о них clore.ai команде, максимум 2048 символов
Вывод
code
int
Код статуса
Пример
Отменить заказ/предложение
Вход: В этом примере мы сообщаем о проблемах с GPU #1; если у вас нет проблем, не включайте поле issue. Вы можете написать любое сообщение в поле text, и мы это расследуем
Вывод:
10. create_order
Описание
С помощью этого эндпоинта вы можете создать спотовое предложение или заказ on-demand Этот эндпоинт также позволяет делать только 1 запрос в 5 секунд
Заголовки
auth
строка
Да
API-токен
Тип содержимого
строка
Да
Должен быть application/json
Тело
currency
строка
Да
Название валюты
image
строка
Да
Допустимый образ из Docker Hub
renting_server
int
Да
ID сервера, который вы хотите арендовать
type
строка
Да
on-demand ИЛИ spot
spotprice
float
Зависит
Предлагаемая цена за день на спотовом рынке, требуется при создании спотового заказа
ports
объект
Нет
Конфигурация проброса портов, максимум 5 записей
env
объект
Нет
Переменные окружения, в сумме ограничены 12000 символами при преобразовании в строку. Имя переменной - 128 символов максимум Значение переменной - 1536 символов максимум
jupyter_token
строка
Нет
Токен Jupyter для образов с ноутбуками Jupyter, максимум 32 символа *
ssh_key
строка
Нет
SSH-ключ для образов с SSH, максимум 3072 символа *
ssh_password
строка
Нет
Пароль SSH для образов с SSH, максимум 32 символа *
command
строка
Нет
Команда будет выполнена на сервере после создания заказа
required_price
float
Нет
Укажите цену, по которой вы хотите запустить заказ; если владелец машины изменит цену, заказ не запустится (только on-demand)
gpu_count
int
Нет
Количество GPU для аренды на серверах, поддерживающих частичную аренду. Не указывайте, чтобы арендовать всю ферму. Только on-demand, только однородные фермы
gpu_indices
[]int
Нет
Индексы слотов GPU, которые нужно арендовать, начиная с 0; длина должна быть равна gpu_count. Использовать свободные слоты из partial_gpu_rental.free_indices. Не указывайте, чтобы бэкенд автоматически выбрал свободные GPU
autossh_entrypoint
bool
Нет
Использовать точку входа clore.ai, которая автоматически развернет SSH-сервер и пользовательский /root/onstart.sh скрипт
* В поля, отмеченные звездочкой, можно вводить только символы из этой группы regexp /^[a-zA-Z0-9\s-=.@+/]+$/
Вывод
code
int
Код статуса
Пример
Ввод 1 (Создать спотовое предложение):
Вывод 1 (Создать спотовое предложение):
Ввод 2 (Создать заказ on-demand):
Вывод 2 (Создать заказ on-demand):
11. renter_fees
Описание
Получите текущую конфигурацию комиссий: базовые комиссии арендатора, настройки снижения комиссии PoH, комиссии за создание заказа и ваш баланс PoH
Заголовки
auth
строка
Да
API-токен
Вывод
code
int
Код статуса
renter_fees.on_demand
объект
Базовая комиссия (%) по каждой валюте для заказов on-demand
renter_fees.spot
объект
Базовая комиссия (%) по каждой валюте для спотовых заказов
poh_config.max_reduction_percent
int
Максимальное снижение базовой комиссии через PoH (%)
poh_config.max_poh_amount
int
Баланс PoH, при котором достигается максимальное снижение
creation_fees.on_demand
объект
Комиссия за создание заказа по каждой валюте
creation_fees.spot
объект
Комиссия за создание спотового заказа по каждой валюте
poh_balance
float
Ваш баланс PoH CLORE
Вход:
Вывод:
12. cancel_orders
Описание
Отменить несколько заказов одновременно (до 256 за запрос)
Заголовки
auth
строка
Да
API-токен
Тип содержимого
строка
Да
Должен быть application/json
Тело
order_ids
[]int
Да
ID заказов для отмены, максимум 256
Вывод
code
int
Код статуса
failed_to_cancel
[]int
ID заказов, которые не удалось отменить
Вход:
Вывод:
13. poh_balance
Описание
Получите баланс Proof of Holding: элементы, итоги и суммы предложений на PoH Marketplace
Заголовки
auth
строка
Да
API-токен
Вывод
code
int
Код статуса
items
[]объект
Ваши элементы PoH с отдельными балансами
balance.total
float
Общий баланс PoH по всем элементам
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
Сумма, арендованная у других пользователей
Вход:
Вывод:
14. server-config.json
Описание
Получить статические данные конфигурации API. Аутентификация не требуется
Вход:
15. get_relay
Описание
Получить relay-узлы для TCP-пересылки для вашей определенной страны. Аутентификация не требуется
Вывод
code
int
Код статуса
country
строка
Определенный код страны
nodes
объект
Доступные relay-узлы
Вход:
Последнее обновление
Это было полезно?