Cơ sở tri thức / Nhà phát triển

API tổng quan

Các mô hình, máy phát điện và cân bằng bạn sử dụng trong ứng dụng, từ mã của riêng bạn. API nói về các định dạng OpenAI và Anthropic, vì vậy hầu hết các công cụ và SDK làm việc bằng cách thay đổi một URL cơ bản và một khóa.

Trang này được dịch bằng máy để thuận tiện. Bản gốc tiếng Anh là phiên bản được áp dụng.

API là gì

Sử dụng HTTP API nymbot.ai đáp ứng các yêu cầu tương tự mà một máy khách OpenAI hoặc Anthropic đã gửi.

• Chat hoàn thành, các Trả lời API Và Thông điệp Anthropic, với streaming, công cụ, hình ảnh, lý luận và tìm kiếm web, cho mỗi mô hình trong Danh mục và cho tự động routing của Nymbot.
• Hình ảnh, Video, phát biểu, Transkript Và embeddings.
• Của bạn cân bằng, Đèn Lightning Top-ups, Top-ups tự động từ ví của bạn và a Lịch sử Chi phí của mỗi yêu cầu

Nó được trả từ cùng hai cân bằng Không có đăng ký và không có phần thưởng miễn phí trên API: mỗi yêu cầu được thanh toán từ các khoản tín dụng bạn đã mua.

Những gì API không làm là thêm bất cứ điều gì của riêng Nymbot. tin nhắn của bạn đi đến mô hình khi bạn gửi chúng: không có lời nhắc hệ thống Nymbot, không có bộ nhớ, không có gợi ý ngày hoặc ngôn ngữ.

URL cơ sở

Mỗi điểm cuối sống dưới /api/v1/Một con đường chưa biết trở về 404 và một con đường được gọi với phương pháp sai trở lại 405Cả hai đều là JSON.

API trả lời các yêu cầu chéo từ bất kỳ trang web nào, vì vậy một trang trình duyệt có thể gọi nó.Tất cả mọi thứ bạn gửi đến một trình duyệt có thể được đọc bởi bất cứ ai mở nó, vì vậy chỉ làm điều đó với một phím có một đầuCác điểm cuối được ký với nym của bạn (chìa khóa, tóm tắt tài khoản, NWC auto-top-up và hoàn lại tiền) là ngoại lệ: trong một trình duyệt, họ chỉ trả lời các trang web của Nymbot. Đăng ký tài khoản yêu cầu.

Gửi mỗi cơ thể JSON với Content-Type: application/jsonBất kỳ loại nào khác đều bị từ chối 415, vì vậy một hình thức HTML đơn giản hoặc một text/plain yêu cầu từ một trang web khác không thể tiếp cận API. Với cURL, thông qua -H "Content-Type: application/json" Cùng với -d.

Chìa khóa lửa

Các phím được thực hiện trong ứng dụng.Open Lửa trong thanh bên của ứng dụng web, hoặc trong menu trên Android và iOS, và nhấn Tạo keyCung cấp cho nó một tên và, nếu bạn muốn, một mũ và ngày hết hạn.

Chìa khóa được hiển thị một lần. Sao chép nó ở đâu đó an toàn trước khi bạn đóng tờ: Nymbot chỉ giữ một dấu vân tay của nó, vì vậy nó không thể hiển thị nó cho bạn một lần nữa. một khóa bị mất không thể được phục hồi; thu hồi nó và tạo một khóa khác.

Một chìa khóa trông như sk-nymbot- Tiếp theo là 43 chữ cái, số, dấu chấm và dấu chấm. Ứng dụng liệt kê mỗi phím bằng tên của nó và một gợi ý ngắn như: sk-nymbot-Qm7x…c2Lw.

• Một chìa khóa thuộc về nym của bạn. Nó chi tiêu số dư của bạn, và chỉ có nym của bạn có thể thực hiện, thay đổi hoặc thu hồi nó.
• Caps là trong sats. Một khóa có thể có một mức chi tiêu, và mức chi tiêu có thể được đặt lại mỗi ngày, mỗi tuần (Thứ Hai) hoặc mỗi tháng (ngày đầu tiên), vào 00:00 UTC. Nó đếm cả hai số dư, một tín dụng tiêu chuẩn là 10 sats và một tín dụng Pro là 100, vì vậy nó có nghĩa là cùng một số dư bất kể một yêu cầu chi tiêu. Trước khi một yêu cầu chạy, số tiền tối đa nó có thể chi phí (được làm tròn lên đến toàn bộ tín dụng) được đặt chống lại những gì còn lại của mức chi phí. 403 key_limit_reached, ngay cả khi câu trả lời đã đi vào dưới cap; lỗi cho biết bao nhiêu còn lại và khi nào cap reset. max_tokens Một yêu cầu được tính phí những gì nó thực sự chi phí và điều đó đếm ngược với mốc, vì vậy nếu nhà cung cấp báo cáo nhiều mã thông báo hơn so với đã được đặt sang một bên, yêu cầu cuối cùng phù hợp có thể lấy chìa khóa một chút vượt qua mốc của nó; sau đó tiếp theo bị từ chối.
• Một cái nắp đã sử dụng chỉ dừng lại chi tiêu. Một phím ở mũ của nó vẫn có thể kiểm tra số dư, đọc lịch sử của nó, liệt kê các mô hình, đếm các token, lên và kiểm tra một video mà nó đã bắt đầu.
• Expiry là tùy chọn. Sau ngày bạn đặt, khóa ngừng hoạt động.
• Hủy bỏ là ngay lập tức và cuối cùng. Một khóa bị thu hồi thất bại yêu cầu tiếp theo của nó. nó vẫn còn trong danh sách, được đánh dấu bị thu hồi, vì vậy lịch sử chi tiêu của nó vẫn có ý nghĩa.
• Bạn có thể có tối đa 25 phím hoạt động, mỗi phím có tên riêng của nó.

Cùng một trang tính cho thấy chi tiêu của mỗi khóa trong khoảng thời gian này và tổng cộng, khi nó được sử dụng lần cuối, cả số dư của bạn và yêu cầu API gần đây của bạn. Quản lý Key.

Xác thực một yêu cầu

Gửi chìa khóa trong bất kỳ tiêu đề nào trong số này. chúng tương đương, vì vậy hãy sử dụng bất cứ điều gì khách hàng của bạn gửi theo mặc định:

Một khóa bị mất, không rõ, bị thu hồi hoặc hết hạn trả về 401Với code missing_api_key, invalid_api_key, revoked_api_key hoặc expired_api_keyDanh sách các mô hình, mô hình âm thanh và giọng nói, và phương thức thanh toán không cần khóa.

Hình ảnh, video, lời nói, bản dịch và nhúng cũng có thể được thanh toán cho một yêu cầu tại một thời điểm trên Lightning mà không có chìa khóa: gửi yêu cầu mà không có một và thanh toán hóa đơn trong 402 Trả lời: See Thanh toán theo yêu cầu mà không có chìa khóa.

Quản lý khóa, tóm tắt tài khoản và top-up tự động là ngoại lệ: chúng lấy chữ ký từ nym của bạn thay vì một khóa, vì vậy một khóa bị rò rỉ không thể tạo ra nhiều khóa hơn. Đăng ký tài khoản yêu cầu.

Yêu cầu đầu tiên của bạn

Đặt chìa khóa trong một biến môi trường, sau đó hỏi một mô hình một cái gì đó. 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 là định tuyến của riêng Nymbot, được thanh toán từ số dư tiêu chuẩn. Đặt ID của mô hình danh mục ở đó thay vào đó, chẳng hạn như anthropic/claude-sonnet-5, để sử dụng mô hình đó từ Pro Balance. Danh sách mô hình cho mỗi ID.

yêu cầu chi phí bao nhiêu

API thanh toán chính xác như cách ứng dụng làm.

• Cái cân bằng nymbot/auto chi tiêu các Tiêu chuẩn cân bằng (10 sats a credit). Mỗi mô hình trò chuyện khác chi tiêu Pro cân bằng (100 sats một tín dụng). Máy phát hình ảnh tiêu chuẩn và giọng nói tiêu chuẩn chi tiêu tín dụng tiêu chuẩn; mỗi máy phát điện khác chi tiêu Pro. Embeddings chi tiêu tín dụng tiêu chuẩn. Transcription chi tiêu tín dụng tiêu chuẩn khi số dư tiêu chuẩn có thể bao gồm nó, và tín dụng Pro khác. Danh sách mô hình cho biết số dư mà mỗi mô hình chi tiêu.
• Bao nhiêu Một yêu cầu trò chuyện được đo trên các token mà mô hình thực sự đọc và viết, ở mức giá được công bố của nhà cung cấp. Giá đó có phí 5% được thêm vào và sau đó được nhân bằng 1,5, vì vậy bạn trả 1.575 lần giá danh sách của nhà cung cấp. Nó được chuyển đổi để đặt cược ở mức giá Bitcoin trực tiếp và được tính bằng hàng ngàn phần trăm của một tín dụng. Hình ảnh chuyên nghiệp, video và lời nói được định giá mỗi thế hệ, mỗi giây hoặc mỗi ký tự, và chuyển đổi mỗi giây của âm thanh, với cùng một khoản phí và lợi nhuận. Hình ảnh tiêu chuẩn là một tấm 5 tín chỉ tiêu chuẩn và giọng nói tiêu chuẩn là một tấm 3.
• tối thiểu Mỗi yêu cầu đo lường mà chạy chi phí ít nhất 0.05 tín dụng: một nửa ngồi trên số dư tiêu chuẩn, 5 sats trên Pro.
• Giữ, sau đó định cư. Trước khi một yêu cầu chạy, chi phí nhiều nhất có thể được giữ từ số dư của bạn, dựa trên những gì bạn gửi và số token nhiều nhất nó có thể viết. Văn bản bên ngoài ASCII đơn giản được kích thước từ các byte UTF-8 của nó, và số ASCII và điểm số được tính như một token mỗi, vì vậy văn bản trong bất kỳ kịch bản, mã và số được giữ đầy đủ. Việc giữ là toàn bộ tín dụng, ít nhất một, vì vậy bất kỳ yêu cầu nào cần ít nhất 10 sats miễn phí trên số dư tiêu chuẩn hoặc 100 sats trên Pro để bắt đầu. Chỉ có chi phí thực tế được tính; phần còn lại được phát hành khi nó kết thúc. Một yêu cầu dài giữ giữ giữ cho đến khi nó chạy; nếu tín dụng được giữ dừng sẵn bằng cách nào, một luồng dừng với một 402 insufficient_balance Nếu giá trị của sản phẩm là cao hơn giá trị của sản phẩm thì giá trị của sản phẩm là cao hơn giá trị của sản phẩm thì giá trị của sản phẩm là cao (owed_sats Trong the nymbot đối tượng, và một số dư âm). Những gì nợ được thanh toán đầu tiên từ các khoản tín dụng tiếp theo đạt được số dư đó. Cho đến khi nó được thanh toán, không có gì trên số dư đó có thể được chi tiêu: không phải bởi API, trả lời trong ứng dụng, chuyển khoản hoặc quà tặng.
• Không đủ tín dụng Nếu số dư không thể bù đắp giữ, yêu cầu được từ chối với 402 trước khi bất cứ điều gì chạy. Lỗi nói rằng số dư là ngắn, bao nhiêu sats yêu cầu cần và bao nhiêu là miễn phí. max_tokens Có nghĩa là giữ nhỏ hơn.
• Những thất bại Một yêu cầu thất bại không tốn gì, trừ khi nhà cung cấp tính phí cho công việc mà nó đã thực hiện trước khi thất bại, hoặc một tìm kiếm trên web hoặc nymbot/auto Kiểm tra nhiệm vụ đã chạy; sau đó đó là những gì bạn trả, ít nhất 0.05 tín dụng. Một luồng bạn cắt được tính phí cho các token mà nhà cung cấp báo cáo: Nymbot tiếp tục đọc luồng của nhà cung cấp cho đến 25 giây sau khi bạn rời đi để có được số đó. nếu nó không đến, phí được ước tính từ những gì bạn đã gửi và những gì đã được viết, và cho một mô hình đó lý do nó bao gồm toàn bộ mức cho phép đầu ra của giữ.
• Web tìm kiếm Chi phí $0.008 một tìm kiếm, chuyển đổi thành sats, bất cứ khi nào một tìm kiếm chạy, cho dù mô hình sau đó trả lời hoặc thất bại. các trang nó đọc cũng được gửi đến mô hình như là đầu vào, vì vậy họ thêm token của họ.

Mỗi câu trả lời cho biết chi phí của nó. câu trả lời JSON mang một nymbot đối tượng với số dư nó đã được thanh toán từ, phí trong tín dụng và sats, và những gì còn lại:

Chi phí đối tượng

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

Trả lời trả tiền cũng mang những tiêu đề này, đó là nơi để tìm kiếm chi phí của một câu trả lời không phải là JSON, chẳng hạn như lời nói:

Tỷ lệ mỗi triệu token, đã bao gồm phí và lợi nhuận, là trong Mô hình danh sách Trong đô la và sats, và trên Bảng giáNếu giá Bitcoin không thể đọc được, yêu cầu trả lại 503 price_unavailable Với Retry-After: 60 Thay vì đoán

Lỗi

Mỗi lỗi có cùng một hình dạng, một trong những khách hàng OpenAI đã hiểu. code là một tên ổn định mà bạn có thể phù hợp với; message Nó dành cho con người và có thể thay đổi.

Lỗi cơ thể

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

Hai ngoại lệ:

• /api/v1/messages trả lời trong định dạng lỗi của Anthropic, vì đó là những gì khách hàng của Anthropic phân tích: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Loại theo trạng thái: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error hoặc overloaded_error (503).
• Một yêu cầu phát trực tuyến thất bại trước khi byte đầu tiên của nó nhận được một lỗi JSON thông thường với trạng thái ở trên, không phải là một luồng sự kiện.

Thông báo lỗi không bao giờ chứa các chi tiết nội bộ của dịch vụ khác. lỗi của nhà cung cấp được viết lại trước khi nó đến với bạn.

giới hạn

Một liên kết đến một hình ảnh phải chỉ đến một máy chủ công cộng: một địa chỉ trên một mạng tư nhân hoặc địa phương, hoặc trên các trang web của Nymbot, bị từ chối.

Những gì lửa có thể nhìn thấy

API không phải là riêng tư theo cách các ứng dụng, và nó đáng để được chính xác về cách thức.

• Nó không được mã hóa từ đầu đến cuối. Trong các ứng dụng, một thông điệp được niêm phong trên thiết bị của bạn cho các phím chỉ Nymbot giữ và đi du lịch như một Quà tặng WrapMột yêu cầu API là HTTPS thông thường: nó được mã hóa trên đường đến Nymbot, và máy chủ của Nymbot đọc nó trong clear để xử lý nó.
• Các câu hỏi và câu trả lời không được lưu trữ. Những gì được giữ lại là hóa đơn: cho mỗi yêu cầu thời gian, mô hình, loại, token đếm, chi phí, số dư, chìa khóa và nếu nó thành công, trong 90 ngày, đó là những gì yêu cầu lịch sử Một hồ sơ sử dụng của cùng một yêu cầu (thời gian, loại, mô hình, số lượng token, chi phí, thời gian và liệu nó đã sử dụng tìm kiếm web hay thành công) cũng được giữ trong 90 ngày, cùng với ứng dụng của riêng nó.
• Mọi thứ khác được giữ cho một nym là nhỏ và được liệt kê ở đây. Chìa khóa lửa được lưu trữ dưới dạng hash, không bao giờ chìa khóa, với tên của họ, một gợi ý ngắn, chi tiêu cap, thời gian đặt lại, hết hạn và khi chúng được thực hiện và được sử dụng lần cuối; chỉ có 50 chìa khóa bị thu hồi mới nhất được giữ. Tự động top-up Kết nối ví được lưu trữ được mã hóa, với ngưỡng, số tiền và kết quả của top-up cuối cùng. công việc video được giữ trong 24 giờ. yêu cầu trả tiền cho mỗi cuộc gọi chỉ để lại một hash thanh toán Lightning trong 7 ngày và một token hoàn lại hash trong 30 ngày, được liên kết với không có nym.
• Wiping app sẽ xóa nó. A Thiết bị Wipe Hủy bỏ và xóa tất cả các khóa API và xóa lịch sử truy vấn, hồ sơ sử dụng, kết nối ví và công việc video.
• Nhà cung cấp mô hình nhìn thấy yêu cầu của bạn, như nó làm từ ứng dụng Mô hình Catalog chạy tại nhà sản xuất của họ; các tuyến đường tiêu chuẩn và nhúng chạy trên Cloudflare.
• Truyền thông được tạo ra là công khai. Hình ảnh và video được cung cấp dưới dạng liên kết được tải lên các máy chủ tệp Blossom công cộng, nơi địa chỉ của tệp là hash của nó. Bất cứ ai có liên kết có thể mở nó, và Nymbot không thể tải xuống nó một lần nữa. b64_json và một hình ảnh được tạo trở lại trong phản hồi và không bao giờ được tải lên.
• Đó là những hình ảnh bạn đưa cho một máy phát điện. Một hình ảnh bạn tải lên Edit, hoặc gửi như a data: URL trong máy phát điện image_url, được tải lên một máy chủ công cộng Blossom đầu tiên để máy phát điện có thể lấy nó, và điều tương tự cũng áp dụng cho nó. https:// Hình ảnh trong một yêu cầu trò chuyện đi đến nhà cung cấp của mô hình, không phải Blossom.
• Một khóa được liên kết với nym của bạn. Tất cả những gì một khóa chi tiêu đến từ số dư của nym của bạn, vì vậy sử dụng API không phải là AnonymousNếu bạn muốn sử dụng API được giữ tách biệt với nym hàng ngày của bạn, hãy làm cho các phím từ một nym riêng biệt với sự cân bằng của riêng mình.

Nếu bạn cần bảo vệ các ứng dụng, hãy sử dụng các ứng dụng. API là dành cho khi bạn cần các mô hình trong các công cụ của riêng bạn.

Mỗi điểm cuối

“Nym” có nghĩa là một yêu cầu được ký bởi khóa Nostr của bạn, được mô tả trong Đăng ký tài khoản yêu cầuĐối với các công cụ đã nói về các định dạng này, hãy xem Công cụ và SDK, và đối với các đại lý mã hóa như Claude Code, Codex và Cline, xem Coding công cụ.