知识库 / 开发者

火焰概览

您在應用程式中使用的模型、發電器和平衡器,來自您自己的代碼. API 會說 OpenAI 和 Anthropic 格式,所以大多數工具和 SDK 都會通過改變基礎 URL 和鍵來工作。

为了方便起见，此页面是机器翻译的。英文原件为适用版本。

什么是火

HTTP API 在 nymbot.ai 它回答了 OpenAI 或 Anthropic 客户端已经发送的相同请求。

• Chat 完成, 该 答案 火 和 人类信息,与流媒体,工具,图像,推理和网络搜索,对于每个模型在 目录 并为Nymbot自己的自动路由。
• 图片, 视频, 演讲, 转录 和 嵌入式.
• 你的 平衡, 闪电顶峰, 从你的钱包自动上传 和 A 历史 每个请求的成本。

它是由相同的两 平衡 与应用程序一样,价格相同.在API上没有订阅和免费授权:每一个请求都是从您购买的学分中支付的。

API 没有做的是添加 Nymbot 自己的任何东西。当您发送它们时,您的消息会传递给模型:没有 Nymbot 系统提示,没有内存,没有日期或语言提示。

基地 URL

每个终点都生活在 /api/v1/未知的路回来了 404 一个已知的路径被称为错误的方法返回 405两者都是JSON。

该 API 响应来自任何网站的交叉源请求,因此浏览器页面可以调用它. 任何你发送到浏览器的内容都可以由打开它的人读取,所以只使用具有小值的密钥 头与您的 nym 签署的终端点(密钥、帐户摘要、NWC自动上传和退款赎回)是例外:在浏览器中,他们只回答 Nymbot 自己的网站。 帐户签名请求.

将每个 JSON 体发送到 Content-Type: application/json任何其他类型都被拒绝 415,所以一个简单的HTML形式或 text/plain 来自其他网站的请求无法到达 API. 使用 cURL,通过 -H "Content-Type: application/json" 与 -d.

火钥匙

密钥是在应用程序中创建的。 火焰 在 Web 应用程序的侧栏中,或在 Android 和 iOS 上的菜单中,然后点击 创建钥匙给它一个名字,如果你愿意,一个封面和一个到期日期。

將鑰匙顯示一次. 在關閉頁面之前在安全的地方複製它:Nymbot 只保留一個指紋,所以它無法再向你顯示它。

一个钥匙看起来像 sk-nymbot- 随后有 43 个字母、数字、分数和分数,应用程序将每个键列出其名称和短提示,如: sk-nymbot-Qm7x…c2Lw.

• 一个钥匙属于你的NIM。 它花费了你的余额,只有你的密码可以创建,更改或撤销它.任何持有密钥的人都可以花费它,所以把它当作密码。
• 帽子在赌注。 一个密钥可以有一个支出限额,并可以重置每一天,每周(星期一)或每个月(第一个),在00:00 UTC. 它计算两个余额,一个标准信用为10 sats和一个Pro信用为100,所以它意味着相同的余额,任何一个请求花费。 403 key_limit_reached,即使答案在封面下出现;错误表示剩余多少和封面何时重置。 max_tokens 一个请求被收取了实际成本,这与上限相比计算,所以如果提供商报告了比被放置的更多代币,最后一个适合的请求可以把钥匙略过其上限;接下来一个被拒绝。
• 耗费的帽子只会停止花费。 一个在其顶端的密钥仍然可以检查余额,阅读其历史,列出模型,计算代币,顶上并检查它已经开始的视频。
• Expiry 是可选的。 设置日期后,密钥停止工作。
• 撤销是即时和最终的。 一个被撤销的密钥失败了其下一个请求. 它仍然在列表中,标记为被撤销,所以它的支出历史仍然有意义。
• 您可以拥有多达 25 个活跃的密钥,每个密钥都有自己的名称。

相同的表格显示了每个密钥在这个期间的花费,以及最后一次使用时的总和,你的余额和最近的API请求。 管理钥匙.

验证请求

在这些标题中的任何一个中发送密钥. 它们等同,所以使用客户端默认发送的内容:

丢失、未知、撤销或过期密钥返回 401与代码 missing_api_key, invalid_api_key, revoked_api_key 或 expired_api_key列出模型、音频模型和语音,以及付款方式不需要密钥。

照片,视频,语音,转录和嵌入也可一次性支付一个请求在闪电上没有任何密钥:发送请求而没有一个并支付发票 402 答案:看 按要求付款,无钥匙.

密钥管理、帐户摘要和自动顶级是例外:它们取代密钥而不是您的密钥的签名,因此泄漏的密钥不能产生更多的密钥。 帐户签名请求.

您的第一个请求

把密钥放在环境变量中,然后向模型询问一些东西。 NYMBOT_API_KEY.

cURL

export NYMBOT_API_KEY="sk-nymbot-..."

curl https://nymbot.ai/api/v1/chat/completions \
  -H "Authorization: Bearer $NYMBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "nymbot/auto",
    "messages": [{"role": "user", "content": "What is a Lightning invoice?"}]
  }'

Python

import os
from openai import OpenAI

client = OpenAI(
    base_url="https://nymbot.ai/api/v1",
    api_key=os.environ["NYMBOT_API_KEY"],
)

reply = client.chat.completions.create(
    model="nymbot/auto",
    messages=[{"role": "user", "content": "What is a Lightning invoice?"}],
)
print(reply.choices[0].message.content)

JavaScript

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://nymbot.ai/api/v1",
  apiKey: process.env.NYMBOT_API_KEY,
});

const reply = await client.chat.completions.create({
  model: "nymbot/auto",
  messages: [{ role: "user", content: "What is a Lightning invoice?" }],
});
console.log(reply.choices[0].message.content);

nymbot/auto 是 Nymbot 自己的路由,由标准平衡支付。 将目录模型的 ID 置于那里,例如: anthropic/claude-sonnet-5,从Pro平衡中使用该模型。 列表模型 给每一个ID。

请求费用多少

API 正如应用程序所做的那样发票。

• 什么平衡 nymbot/auto 花费它 标准 平衡 (10 sats a credit) 每一个其他聊天模型都花费 Pro 的 平衡(百分之一信用)。标准图像生成器和标准语音花费标准信用;每一个其他生成器花费Pro。嵌入式花费标准信用。转录花费标准信用,当标准平衡可以覆盖它,而Pro信用不一样。
• 多少。 一个聊天请求被测量在模型实际上阅读和写的代币上,在提供商发布的价格上。 该价格有5%的费用增加,然后被乘以1.5倍,所以你支付了提供商的名单价格的1575倍。 它被转换为实时比特币价格的代币,并收取了信用的千分之一。 专业图片,视频和语音每代,每秒或每字符,和音频的每秒转录,具有相同的费用和边缘。
• 最小限度。 每次运行的计量请求成本至少为 0.05 信贷:一半放在标准余额上,5 点在 Pro 上。
• 抓住,然后坐下来。 在一个请求运行之前,它可能的成本最多是从你的余额中保留的,基于你发送的内容和它可能写的代币最多。简单的ASCII外部的文本是从其UTF-8字节的尺寸,ASCII数字和点数每一个都作为一个代币计算,所以任何脚本,代码和数字中的文本都被保留在完整的位置。保留是完整的信用,至少有一个,所以任何请求至少需要10个标准余额或100个专业的免费奖励才能开始。 402 insufficient_balance 假如实际成本超过了余额,则全部余额被收取,剩余的余额被收取(owed_sats 在该 nymbot 对象,和负余额)。 所欠的首先是从接下来的信用到达该余额。 直到它被支付,在该余额上什么都不能花:不是API,在应用程序中回复,转移或礼物。
• 信用不够。 如果余额不能覆盖持有,请求被拒绝。 402 在任何事情运行之前. 错误表示哪个平衡短,请求需要多少 sats,以及多少是免费的。 max_tokens 意味着一个较小的支撑。
• 失败。 一个失败的请求不花费任何代价,除非提供商为它在失败之前所做的工作收费,或网络搜索或服务。 nymbot/auto 任务检查已经运行了;那么这就是你付出的,至少 0.05 信贷。你切断的流是为提供商报告的代币收取的:Nymbot在你离开后一直在读取提供商的流,直到 25 秒才能获得该数目。
• 网站搜索 每次搜索都花费0.008美元,转换为 sats,无论模型是否响应或失败,它所阅读的页面也被发送给模型作为输入,因此他们添加了他们的代币。

每個答案都說出它的成本。JSON答案帶有 nymbot 对象与其所支付的余额,信用和费率的收费,以及剩余的:

成本对象

"nymbot": {
  "balance": "pro",
  "charged_credits": 0.162,
  "charged_sats": 16.2,
  "balance_credits": 412.425,
  "balance_sats": 41242.5
}

付费响应还带有这些标题,这就是搜索不是 JSON 响应的成本的地方,例如语音:

每百万代币的利率,已经包括费用和利润,在 模型列表 在美元和SAT,以及 价格表如果比特币价格无法读取,付费请求返回 503 price_unavailable 与 Retry-After: 60 比起猜测。

错误

每个错误都具有相同的形状,OpenAI客户端已经理解。 code 是可以匹配的稳定名称; message 是为了人,可以改变。

错误的身体

{
  "error": {
    "message": "This request needs up to 200 sats (2 credits) on your Pro balance, and 40 sats are free. Catalog models spend the Pro balance. Top up in the Nymbot app or with POST /api/v1/topup/create/btc-lightning.",
    "type": "insufficient_quota",
    "code": "insufficient_balance",
    "param": null,
    "balance": "pro",
    "required_sats": 200,
    "balance_sats": 40
  }
}

两个例外:

• /api/v1/messages 答案以 Anthropic 的错误格式,因为这就是 Anthropic 客户端分析的内容: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}类型遵循状态: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error 或 overloaded_error (503).
• 在其第一个字节之前失败的流请求会收到一个普通的 JSON 错误,具有上述状态,而不是事件流。

错误消息永远不会包含其他服务的内部细节,而提供商的错误在到达您之前会被重新编写。

界限

对图片的链接必须指向公共主机:在私人或本地网络上的地址或Nymbot自己的网站上被拒绝。

火焰可以看到什么

API在应用程序的方式上不是私密的,值得准确地了解如何。

• 它不是端到端加密的。 在应用中,一个消息在您的设备上被密封到只有Nymbot持有并作为一个键旅行的密钥。 礼品包装一个API请求是普通的HTTPS:它在前往Nymbot的途中被加密,Nymbot的服务器在清晰地阅读它来处理它。
• 快递和回复不会被存储。 他们传到模型,答案传回来。保留的是账单:对于每个请求,时间、模型、类型、代币计数、成本、余额、钥匙以及是否成功,90天,这是什么 希望历史 同一请求的使用记录(时间、类型、模型、代币计数、成本、持续时间以及它是否使用了网页搜索或成功)也被保留90天,除了应用程序本身。
• 所有其他被保留在一个子是小,并列在这里。 火钥匙 将其存储为哈希,而不是密钥,其名称、短提示、支出限额、重置期限、截止日期以及它们创建和最后一次使用时;只保留最新的50个被撤销的密钥。 自动升级 钱包连接被加密存储,其门槛,金额和最后一次上涨的结果。 视频工作被保留24小时。 每通话支付的请求只留下7天的闪电支付哈希和30天的哈希退款代币,连接到无NIM。
• 删除 app 将删除它。 A 设备Wipe 撤销和删除每个 API 密钥,并删除查询历史记录、使用记录、钱包连接和视频工作。
• 模型提供商看到您的请求目录模型在其制造商上运行;标准路径和嵌入功能在Cloudflare上运行。
• 创建的媒体是公共的。 作为链接提供的图片和视频被上传到公共 Blossom 文件主机,其中文件的地址是其哈希。 b64_json 生成的图像在响应中返回,并且从未上传。
• 这就是你给发电机的图像。 您上传的图片 编辑,或发送为 a data: 发电机中的URL image_url,首先上传到公共Blossom主机,以便发电机可以接收它,同样适用于它。 https:// 聊天请求中的图片将传递给模型的提供商,而不是Blossom。
• 一个密钥连接到你的NIM。 一把钥匙所花费的一切都来自你的平衡,所以API的使用不是 匿名如果你想将API的使用保留在你日常的密钥之外,请将密钥从一个单独的密钥中与它自己的平衡。

如果您需要应用程序的保护,请使用应用程序. API 适用于您需要自己的工具中的模型。

每一个终点

“Nym” 指您的Nostr密钥签署的请求,如下所述。 帐户签名请求对于已经使用这些格式的工具,请参阅 工具和SDK,对于代码代理,如 Claude Code、Codex 和 Cline,请参见 代码工具.