_spot` 为它发送的值会被忽略。 `usd_pricing` 目标值是整台服务器的 $/天 数值，并按 USD 范围（0.1–1,000）验证；超出范围的值会被限制到最近的边界。
**输出**
| 字段 | 类型 | 描述 |
| ------ | ----- | --- |
| `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. `设置现货价格`
**关于**
为你的现货市场报价设置每日价格
**请求头**
| 字段 | 类型 | 必填 | 描述 |
| ------ | -------- | -- | ---------------------- |
| `auth` | `string` | 是 | API 令牌 |
| `内容类型` | `string` | 是 | 必须为 `application/json` |
**请求体**
| 字段 | 类型 | 必填 | 描述 |
| --------------- | ------- | -- | -------- |
| `order_id` | `int` | 是 | 唯一报价 ID |
| `desired_price` | `float` | 是 | 你的每日报价价格 |
> **低于服务器当前现货底价的价格** 会被拒绝，并附上当前最低价：
>
> ```
> { "error": "amount_too_low", "min_price": 0.0000012, "code": 6 }
> ```
**示例**
让我们尝试更新现货市场价格
**输入 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（降价幅度太大）：**\
你可以最多将现货市场报价价格下调 0.00000100 ₿
| 字段 | 类型 | 描述 |
| ---------- | -------- | -------------- |
| `code` | `int` | 状态码 |
| `error` | `string` | 错误描述字段 |
| `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 后进一步降价）：**\
你可以每 600 秒下调一次现货价格
| 字段 | 类型 | 描述 |
| ------------------ | -------- | ------------------ |
| `code` | `int` | 状态码 |
| `error` | `string` | 错误描述字段 |
| `time_to_lowering` | `float` | 到下一次可以下调价格的剩余时间（秒） |
```
{
"error":"can_lower_every_600_seconds",
"time_to_lowering":513,
"code":6
}
```
#### 9. `cancel_order`
**关于**
取消一个活跃订单或现货报价
**请求头**
| 字段 | 类型 | 必填 | 描述 |
| ------ | -------- | -- | ---------------------- |
| `auth` | `string` | 是 | API 令牌 |
| `内容类型` | `string` | 是 | 必须为 `application/json` |
**请求体**
| 字段 | 类型 | 必填 | 描述 |
| ------- | -------- | -- | ---------------------------------------------------------------- |
| `id` | `int` | 是 | 唯一订单/报价 ID |
| `issue` | `string` | 否 | 如果你遇到了服务器的任何问题，可以向 [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 Was overheating and throttling"
}' 'https://api.clore.ai/v1/cancel_order'
```
**输出：**
```
{
"code": 0
}
```
#### 10. `create_order`
**关于**
你可以使用此端点创建现货报价或按需订单
**请求头**
| 字段 | 类型 | 必填 | 描述 |
| ------ | -------- | -- | ---------------------- |
| `auth` | `string` | 是 | API 令牌 |
| `内容类型` | `string` | 是 | 必须为 `application/json` |
**请求体**
| 字段 | 类型 | 必填 | 描述 |
| -------------------- | -------- | --- | -------------------------------------------------------------------------------------------------------------------------- |
| `currency` | `string` | 是 | 货币名称 |
| `image` | `string` | 是 | 来自 dockerhub 的有效镜像 |
| `renting_server` | `int` | 是 | 你想租用的服务器 ID |
| `type` | `string` | 是 | `按需` 或 `现货` |
| `spotprice` | `float` | 取决于 | 创建现货订单时必填的现货市场每日报价价格 |
| `ports` | `object` | 否 | 端口转发配置，最多 5 条记录 |
| `env` | `object` | 否 | 环境变量，转为字符串后总长度限制为 12288 个字符。
变量名 - 最多 128 个符号，不能包含 -
变量值 - 最多 1536 个符号
仅保留前 30 个有效变量；其余会被静默丢弃
|
| `jupyter_token` | `string` | 否 | 用于包含 jupyter notebook 的镜像的 Jupyter 令牌，最多 32 个字符 \* |
| `ssh_key` | `string` | 否 | 用于带 SSH 的镜像的 SSH 密钥，最多 3072 个字符 \* |
| `ssh_password` | `string` | 否 | 用于带 SSH 的镜像的 SSH 密码，最多 32 个字符 \* |
| `command` | `string` | 否 | 订单创建后将在服务器上运行命令 |
| `required_price` | `float` | 否 | 指定你希望以何种价格启动订单；如果机器所有者更改价格，则订单不会启动（仅按需） |
| `gpu_count` | `int` | 否 | 要在支持部分租用的服务器上租用的 GPU 数量 [部分租用](/clore.ai/clore.ai-eng-zh/mian-xiang-zu-ke/partial-gpu-rental.md)。省略则租用整台设备。仅按需，仅限同构设备 |
| `gpu_indices` | `[]int` | 否 | 要租用的从 0 开始的 GPU 插槽索引；长度必须等于 `gpu_count`。从 `partial_gpu_rental.free_indices`中取空闲插槽。省略则让后端自动选择空闲 GPU |
| `autossh_entrypoint` | `bool` | 否 | 使用 clore.ai 入口点，它会自动部署 SSH 服务器和自定义 `/root/onstart.sh` 脚本 |
带星号标记的字段只能输入此正则组中的字符 `/^[a-zA-Z0-9\\s-=.@+/]+$/`
**输出**
| 字段 | 类型 | 描述 |
| ------ | ----- | --- |
| `code` | `int` | 状态码 |
> **低于服务器底价的现货报价** 会被拒绝，并附上当前最低价，因此你可以立即重试：
>
> ```
> { "error": "too_low_price", "min_price": 0.0000012, "code": 6 }
> ```
>
> 底价大约每 10 分钟根据实时币价重新计算一次，因此从市场列表读到的价格可能会略有过时——务必使用返回的 `min_price` 进行重试。
**示例**
**输入 1（创建现货报价）：**
```
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
}
```
#### 11. `renter_fees`
**关于**
获取当前费用配置：基础租客费用、PoH 费用减免设置、订单创建费用以及你的 PoH 余额
**请求头**
| 字段 | 类型 | 必填 | 描述 |
| ------ | -------- | -- | ------ |
| `auth` | `string` | 是 | 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`
**关于**
一次取消多个订单（每次请求最多 256 个）
**请求头**
| 字段 | 类型 | 必填 | 描述 |
| ------ | -------- | -- | ---------------------- |
| `auth` | `string` | 是 | API 令牌 |
| `内容类型` | `string` | 是 | 必须为 `application/json` |
**请求体**
| 字段 | 类型 | 必填 | 描述 |
| ----------- | ------- | -- | ------------------ |
| `order_ids` | `[]int` | 是 | 要取消的订单 ID，最多 256 个 |
**输出**
| 字段 | 类型 | 描述 |
| ------------------ | ------- | ---------- |
| `code` | `int` | 状态码 |
| `failed_to_cancel` | `[]int` | 无法取消的订单 ID |
**输入：**
```
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`
**关于**
获取你的持有证明余额：项目、总额，以及 PoH Marketplace 报价金额
**请求头**
| 字段 | 类型 | 必填 | 描述 |
| ------ | -------- | -- | ------ |
| `auth` | `string` | 是 | API 令牌 |
**输出**
| 字段 | 类型 | 描述 |
| --------------------------------------------- | ---------- | -------------- |
| `code` | `int` | 状态码 |
| `items` | `[]object` | 你的 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 市场上列出的金额 |
| `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`
**关于**
获取静态 API 配置数据。无需身份验证
**输入：**
```
curl -XGET 'https://api.clore.ai/v1/server-config.json'
```
#### 15. `get_relay`
**关于**
获取适用于您检测到的国家的 TCP 转发中继节点。无需身份验证
**输出**
| 字段 | 类型 | 描述 |
| --------- | -------- | -------- |
| `code` | `int` | 状态码 |
| `country` | `string` | 检测到的国家代码 |
| `nodes` | `object` | 可用的中继节点 |
**输入：**
```
curl -XGET 'https://api.clore.ai/v1/get_relay'
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.clore.ai/clore.ai/clore.ai-eng-zh/mian-xiang-zhu-ji-fang/api.md?ask=&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.
