_spot` value sent for it is ignored. The `usd_pricing` targets are whole-server $/day figures validated against the USD range (0.1–1,000); out-of-range values clamp to the nearest bound.
**Output**
| Field | Type | Description |
| ------ | ----- | ----------- |
| `code` | `int` | Status code |
**Example**
Let's create a send proof for a transaction sent from the current wallet.
**Input:**
```
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'
```
**Output:**
```
{
"code": 0
}
```
#### 8. `set_spot_price`
**About**
Set price per day on your SPOT market offer
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| --------------- | ------- | --------- | -------------------------- |
| `order_id` | `int` | Yes | Unique offer ID |
| `desired_price` | `float` | Yes | Your offered price per day |
> **A price below the server's current spot floor** is rejected with the current minimum included:
>
> ```
> { "error": "amount_too_low", "min_price": 0.0000012, "code": 6 }
> ```
**Example**
Let's try to update spot market price
**Input 1 (Step down was too big):**
```
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'
```
**Possible output 1 (Step down was too big):**\
You can lower spot market offer price by max of 0.00000100 ₿
| Field | Type | Description |
| ---------- | -------- | ----------------------------------------------------------- |
| `code` | `int` | Status code |
| `error` | `string` | Error description field |
| `max_step` | `float` | Lowest possible value to what you can currently lower price |
```
{
"error":"exceeded_max_step",
"max_step":0.0000032,
"code":6
}
```
**Input 2 (Valid price step down):**
```
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'
```
**Possible output 2 (Valid price step down):**
```
{
"code": 0
}
```
**Input 3 (Lower price even more after sending Input 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
```
**Possible output 3 (Lower price even more after sending Input 2):**\
You can lower spot price once in 600 seconds
| Field | Type | Description |
| ------------------ | -------- | ------------------------------------------------------- |
| `code` | `int` | Status code |
| `error` | `string` | Error description field |
| `time_to_lowering` | `float` | Remaining time (sec) to next possibility to lower price |
```
{
"error":"can_lower_every_600_seconds",
"time_to_lowering":513,
"code":6
}
```
#### 9. `cancel_order`
**About**
Cancel an active order or spot offer
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| ------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | `int` | Yes | Unique order/offer ID |
| `issue` | `string` | No | If you have encountered any issues with the server you can report them to [clore.ai](http://clore.ai/) team, maximum 2048 characters |
**Output**
| Field | Type | Description |
| ------ | ----- | ----------- |
| `code` | `int` | Status code |
**Example**
Cancel order/offer
**Input:**\
In this example we are reporting issues with GPU #1, if you don't have issues, don't include issue field.\
You can write any message to text field and we will investigate it
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"id":39,
"issue":"GPU #1 Was overheating and throttling"
}' 'https://api.clore.ai/v1/cancel_order'
```
**Output:**
```
{
"code": 0
}
```
#### 10. `create_order`
**About**
You can create spot offer or on demand order with this endpoint
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| -------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `currency` | `string` | Yes | Currency name |
| `image` | `string` | Yes | Valid image from dockerhub |
| `renting_server` | `int` | Yes | ID of server you want to rent |
| `type` | `string` | Yes | `on-demand` OR `spot` |
| `spotprice` | `float` | Depends | Offering price per day on spot market, required when making spot order |
| `ports` | `object` | No | Port forwarding configuration, max 5 records |
| `env` | `object` | No | Environment variables, limited to 12288 characters in total when stringified.
Variable name - 128 symbols max, must not contain -
Variable value - 1536 symbols max
Only the first 30 valid variables are kept; extras are silently dropped
|
| `jupyter_token` | `string` | No | Jupyter token for images that has jupyter notebooks, maximum 32 characters \* |
| `ssh_key` | `string` | No | SSH key for images with SSH, maximum 3072 characters \* |
| `ssh_password` | `string` | No | SSH password for images with SSH, maximum 32 characters \* |
| `command` | `string` | No | Command will be run on server after order creation |
| `required_price` | `float` | No | Specify price for what you want to start the order, if machine owner changes the price, then order will not start (on demand only) |
| `gpu_count` | `int` | No | Number of GPUs to rent on servers that support [partial rental](/for-renters/partial-gpu-rental.md). Omit to rent the whole rig. On-demand only, homogeneous rigs only |
| `gpu_indices` | `[]int` | No | 0-based GPU slot indices to rent; length must equal `gpu_count`. Take free slots from `partial_gpu_rental.free_indices`. Omit to let the backend pick free GPUs automatically |
| `autossh_entrypoint` | `bool` | No | Use clore.ai entrypoint, that autometically deploy SSH server and custom `/root/onstart.sh` script |
\* To fields marked with star you can only input characters from this regexp group `/^[a-zA-Z0-9\s-=.@+/]+$/`
**Output**
| Field | Type | Description |
| ------ | ----- | ----------- |
| `code` | `int` | Status code |
> **Spot bids below the server's floor** are rejected with the current minimum included, so you can retry immediately:
>
> ```
> { "error": "too_low_price", "min_price": 0.0000012, "code": 6 }
> ```
>
> The floor is recomputed from live coin rates roughly every 10 minutes, so a price read off the marketplace listing can be slightly stale — always use the returned `min_price` for the retry.
**Example**
**Input 1 (Create spot offer):**
```
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'
```
**Output 1 (Create spot offer):**
```
{
"code":0
}
```
**Input 2 (Create on demand order):**
```
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'
```
**Output 2 (Create on demand order):**
```
{
"code":0
}
```
#### 11. `renter_fees`
**About**
Get the current fee configuration: base renter fees, PoH fee reduction settings, order creation fees, and your PoH balance
**Headers**
| Field | Type | Mandatory | Description |
| ------ | -------- | --------- | ----------- |
| `auth` | `string` | Yes | API token |
**Output**
| Field | Type | Description |
| ---------------------------------- | -------- | ----------------------------------------------------- |
| `code` | `int` | Status code |
| `renter_fees.on_demand` | `object` | Base fee (%) per currency for on-demand orders |
| `renter_fees.spot` | `object` | Base fee (%) per currency for spot orders |
| `poh_config.max_reduction_percent` | `int` | Maximum base-fee reduction through PoH (%) |
| `poh_config.max_poh_amount` | `int` | PoH balance at which the maximum reduction is reached |
| `creation_fees.on_demand` | `object` | Order creation fee per currency |
| `creation_fees.spot` | `object` | Spot order creation fee per currency |
| `poh_balance` | `float` | Your PoH CLORE balance |
**Input:**
```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/renter_fees'
```
**Output:**
```
{
"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`
**About**
Cancel multiple orders at once (up to 256 per request)
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| ----------- | ------- | --------- | -------------------------------- |
| `order_ids` | `[]int` | Yes | Order IDs to cancel, maximum 256 |
**Output**
| Field | Type | Description |
| ------------------ | ------- | ------------------------------------- |
| `code` | `int` | Status code |
| `failed_to_cancel` | `[]int` | Order IDs that could not be cancelled |
**Input:**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_ids": [38, 39]
}' 'https://api.clore.ai/v1/cancel_orders'
```
**Output:**
```
{
"failed_to_cancel": [],
"code": 0
}
```
#### 13. `poh_balance`
**About**
Get your Proof of Holding balance: items, totals, and PoH Marketplace offer amounts
**Headers**
| Field | Type | Mandatory | Description |
| ------ | -------- | --------- | ----------- |
| `auth` | `string` | Yes | API token |
**Output**
| Field | Type | Description |
| --------------------------------------------- | ---------- | --------------------------------------- |
| `code` | `int` | Status code |
| `items` | `[]object` | Your PoH items with individual balances |
| `balance.total` | `float` | Total PoH balance across all items |
| `balance.free_amount` | `float` | PoH balance not committed to offers |
| `balance.reward_amount` | `float` | Balance eligible for rewards |
| `balance.offers.rented_amount` | `float` | Amount rented out to other users |
| `balance.offers.rented_on_marketplace_amount` | `float` | Amount listed on the PoH Marketplace |
| `balance.offers.leased_amount` | `float` | Amount leased from other users |
**Input:**
```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/poh_balance'
```
**Output:**
```
{
"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`
**About**
Get static API configuration data. No authentication required
**Input:**
```
curl -XGET 'https://api.clore.ai/v1/server-config.json'
```
#### 15. `get_relay`
**About**
Get TCP forwarding relay nodes for your detected country. No authentication required
**Output**
| Field | Type | Description |
| --------- | -------- | --------------------- |
| `code` | `int` | Status code |
| `country` | `string` | Detected country code |
| `nodes` | `object` | Available relay nodes |
**Input:**
```
curl -XGET 'https://api.clore.ai/v1/get_relay'
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.clore.ai/for-hosts/api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
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.
