Pangkalan pengetahuan / Pengembang

Pemandangan api

Model, generator dan keseimbangan yang anda gunakan dalam aplikasi, daripada kod anda sendiri. API berbicara format OpenAI dan Anthropic, jadi kebanyakan alat dan SDK berfungsi dengan mengubah URL asas dan kunci.

Halaman ini diterjemahkan mesin untuk kemudahan. Versi asal bahasa Inggeris ialah versi yang digunakan.

Apa yang dimaksud dengan api

Perkhidmatan HTTP API nymbot.ai yang menjawab permintaan yang sama yang telah dihantar oleh klien OpenAI atau Anthropic.

• Chat Penyelesaian, yang Penyelesaian api dan Pesan Antropologi, dengan streaming, alat, imej, alasan dan carian web, untuk setiap model dalam Katalog dan untuk auto-routing Nymbot sendiri.
• imej, Video yang, Perkataan, Transkripsi dan embeddings.
• awak keseimbangan, Pemandangan Top-ups, Top-up automatik daripada dompet anda dan a Sejarah Berapakah kos setiap permintaan?

Ia dibayar daripada kedua-dua keseimbangan seperti aplikasi, pada harga yang sama.Tiada langganan dan tiada peruntukan percuma pada API: setiap permintaan dibayar daripada kredit yang anda beli.

Apa yang API tidak lakukan ialah menambah apa-apa daripada Nymbot sendiri. mesej anda pergi kepada model semasa anda menghantar mereka: tiada petunjuk sistem Nymbot, tiada memori, tiada tarikh atau petunjuk bahasa.

Pangkalan URL

Setiap titik akhir hidup di bawah /api/v1/Jalan yang tidak dikenali kembali 404 dan laluan yang dikenali yang dipanggil dengan kaedah yang salah kembali 405Kedua-duanya ialah JSON

Apa-apa yang anda kirim ke pelayar boleh dibaca oleh sesiapa yang membukanya, bagaimanapun, jadi hanya berbuat demikian dengan kunci yang mempunyai kepalaEndpoints yang ditandatangani dengan nym anda (keywords, ringkasan akaun, NWC auto-top-up dan penebusan bayaran balik) adalah pengecualian: dalam pelayar mereka menjawab hanya laman web Nymbot sendiri. Menandatangani permintaan akaun.

Hantar setiap badan JSON dengan Content-Type: application/jsonApa-apa jenis yang lain ditolak dengan 415, jadi bentuk HTML biasa atau a text/plain Permintaan daripada laman lain tidak boleh mencapai API. Dengan cURL, -H "Content-Type: application/json" Bersama dengan -d.

Kunci api

Kunci dibuat dalam aplikasi.Buka Kebakaran dalam bar sisi aplikasi web, atau dalam menu pada Android dan iOS, dan tekan Mencipta KunciBerikan nama dan, jika anda suka, cap dan tarikh tamat tempoh.

Salin di tempat yang selamat sebelum anda menutup lembaran: Nymbot hanya menyimpan cap jari daripada itu, jadi ia tidak boleh menunjukkan kepada anda lagi.

Kunci yang kelihatan seperti sk-nymbot- diikuti oleh 43 huruf, digit, dash dan sub-score. aplikasi senarai setiap kunci dengan nama dan petunjuk pendek seperti: sk-nymbot-Qm7x…c2Lw.

• Kunci ialah milik nym anda. Ia membelanjakan baki anda, dan hanya nym anda boleh membuat, mengubah atau membatalkannya.Siapa sahaja yang memegang kunci boleh membelanjakan dengan itu, jadi perlakukan ia seperti kata laluan.
• Caps ialah dalam sats. Kunci boleh mempunyai cap perbelanjaan, dan cap boleh disetkan semula setiap hari, setiap minggu (Sabtu) atau setiap bulan (yang pertama), pada 00:00 UTC. Ia mengira kedua-dua baki, satu kredit standard sebagai 10 sats dan satu kredit Pro sebagai 100, jadi ia bermakna sama sama mana-mana baki permintaan yang digunakan. Sebelum permintaan berjalan, jumlah yang paling boleh kos (dibulatkan kepada keseluruhan kredit) ditetapkan terhadap apa yang tersisa daripada cap. Jika ia tidak sesuai, permintaan ditolak dengan 403 key_limit_reached, walaupun jawapan akan datang di bawah cap; kesilapan memberitahu berapa banyak yang tersisa dan apabila cap reset. max_tokens Permintaan dikenakan apa yang sebenarnya kos dan yang dihitung terhadap cap, jadi jika pembekal melaporkan lebih banyak token daripada yang ditempatkan di samping, permintaan terakhir yang sesuai boleh mengambil kunci sedikit melampaui capnya; yang seterusnya ditolak.
• Pengeluaran hanya akan menghentikan pengeluaran. Kunci pada capnya masih boleh memeriksa baki, membaca sejarahnya, senarai model, mengira token, top up dan memeriksa video yang telah dimulakan.
• Expiry ialah opsional. Selepas tarikh yang anda tetapkan, kunci berhenti berfungsi.
• Pembatalan ialah segera dan akhir. Kunci yang dibatalkan gagal permintaan seterusnya. ia kekal dalam senarai, ditandai dibatalkan, jadi sejarah pengeluaran masih bermakna.
• Anda boleh mempunyai sehingga 25 kunci aktif, masing-masing dengan nama tersendiri.Mengubah tempoh reset kunci memulakan tempoh baru dari nol.

Lapisan yang sama menunjukkan pengeluaran setiap kunci untuk tempoh ini dan secara keseluruhan, apabila ia terakhir digunakan, kedua-dua baki anda, dan permintaan API anda baru-baru ini. Pengurusan Kunci.

Mengesahkan permintaan

Hantar kunci dalam mana-mana tajuk ini.Mereka sama, jadi gunakan apa sahaja yang pelanggan anda hantar secara lalai:

Pengembalian kunci yang hilang, tidak diketahui, dibatalkan atau telah tamat tempoh 401Dengan kod yang missing_api_key, invalid_api_key, revoked_api_key atau expired_api_keySenarai model, model audio dan suara, dan kaedah bayaran tidak memerlukan kunci.

Imej, video, ucapan, transkrip dan embeddings juga boleh dibayar untuk satu permintaan pada satu masa melalui Lightning tanpa kunci sama sekali: hantar permintaan tanpa satu dan membayar invois dalam 402 Jawapan : lihat Pembayaran Permintaan Tanpa Kunci.

Pengurusan kunci, ringkasan akaun dan top-up automatik adalah pengecualian: mereka mengambil tanda tangan daripada nym anda bukannya kunci, jadi kunci yang bocor tidak boleh membuat lebih banyak kunci. Menandatangani permintaan akaun.

Permintaan pertama anda

Letakkan kunci dalam variabel persekitaran, kemudian minta sesuatu kepada model. 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 adalah routing Nymbot sendiri, dibayar daripada baki standard. Letakkan ID model katalog di sana, seperti anthropic/claude-sonnet-5, untuk menggunakan model itu daripada keseimbangan Pro. Senarai Model bagi setiap ID.

Berapakah kos permintaan

API bills persis seperti yang dilakukan oleh app.

• Apa keseimbangan nymbot/auto Menghabiskan yang standard yang keseimbangan (10 sats a kredit). setiap model chat yang lain menghabiskan Pro untuk keseimbangan (100 ratus kredit). Generator imej standard dan suara standard menghabiskan kredit standard; setiap generator lain menghabiskan Pro. Embeddings menghabiskan kredit standard. Transcription menghabiskan kredit standard apabila keseimbangan standard boleh menutupi ia, dan kredit Pro sebaliknya. Senarai model mengatakan keseimbangan mana yang dihabiskan oleh setiap model.
• Berapa banyak Permintaan chat diukur pada token yang sebenarnya dibaca dan ditulis oleh model, pada kadar yang diterbitkan oleh pembekal. Harga itu mempunyai bayaran 5% ditambah dan kemudian dibanjiri dengan 1.5, jadi anda membayar 1.575 kali harga senarai pembekal. Ia ditukar kepada bayaran pada harga Bitcoin hidup dan dikenakan bayaran dalam seribu peratus daripada kredit. Gambar pro, video dan ucapan dibayar per generasi, per saat atau per watak, dan transkrip per saat audio, dengan bayaran dan margin yang sama.
• yang minimum. Setiap permintaan yang diukur yang menjalankan kos sekurang-kurangnya 0.05 kredit: separuh set pada baki standard, 5 sats pada Pro.
• Tahan dan kemudian menetap. Sebelum permintaan berjalan, jumlah yang paling banyak ia boleh kos ditahan daripada baki anda, berdasarkan kepada apa yang anda hantar dan jumlah token yang paling banyak ia boleh tulis. Teks di luar ASCII biasa adalah saiz daripada bajet UTF-8, dan nombor ASCII dan titik-titik dihitung sebagai token masing-masing, jadi teks dalam mana-mana skrip, kod dan nombor ditahan sepenuhnya. Pemegang adalah dalam kredit keseluruhan, sekurang-kurangnya satu, jadi mana-mana permintaan memerlukan sekurang-kurangnya 10 sats percuma pada baki standard atau 100 sats pada Pro untuk bermula. Hanya kos sebenar yang dikenakan; sisanya dilepaskan apabila ia berakhir. Permintaan panjang mengekalkan pemegangannya selagi ia berjalan; jika kredit yang ditahan berhenti tersedia bagaimanapun, aliran berhenti dengan 402 insufficient_balance Perbezaan antara perbelanjaan dan perbelanjaan (jika perbelanjaan itu lebih besar daripada perbelanjaan yang boleh dibayar, perbelanjaan itu boleh dibayar).owed_sats Di dalam nymbot objek, dan keseimbangan negatif). Apa yang berhutang dibayar terlebih dahulu daripada kredit seterusnya yang mencapai keseimbangan itu. sehingga dibayar, apa-apa pada keseimbangan itu boleh dihabiskan: bukan oleh API, jawapan dalam aplikasi, pemindahan atau hadiah.
• Tiada kredit yang cukup Sekiranya baki tidak boleh menutupi pengekalan, permintaan itu ditolak dengan 402 sebelum apa-apa berjalan. Kesilapan memberitahu mana keseimbangan yang pendek, berapa banyak sats permintaan diperlukan dan berapa banyak yang percuma. max_tokens bermakna lebih kecil.
• Kegagalan Permintaan yang gagal tidak kos apa-apa, melainkan pembekal dikenakan bayaran untuk kerja yang dilakukan sebelum gagal, atau carian web atau nymbot/auto pemeriksaan tugas telah dijalankan; maka itulah yang anda bayar, sekurang-kurangnya 0.05 kredit. aliran yang anda potong dikenakan bayaran untuk token yang dilaporkan oleh pembekal: Nymbot terus membaca aliran pembekal sehingga 25 saat selepas anda meninggalkan untuk mendapatkan jumlah itu.
• Pencarian web kos $0.008 satu carian, ditukar kepada sats, setiap kali carian dijalankan, sama ada model itu kemudian menjawab atau gagal.

Setiap jawapan memberitahu berapa kosnya. jawapan JSON membawa nymbot objek dengan baki yang dibayar daripadanya, yuran dalam kredit dan sats, dan apa yang tersisa:

kos objek

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

Tanggapan berbayar juga membawa tajuk ini, di mana untuk mencari kos jawapan yang bukan JSON, seperti ucapan:

kadar per juta token, yang sudah termasuk yuran dan margin, berada dalam Senarai Model dalam dolar dan kadar, dan pada Senarai HargaJika harga Bitcoin tidak boleh dibaca, permintaan dibayar dikembalikan 503 price_unavailable dengan Retry-After: 60 daripada menebak.

Kesilapan

Setiap kesilapan mempunyai bentuk yang sama, yang klien OpenAI sudah faham. code ialah nama yang stabil yang anda boleh cocok dengan; message kepada rakyat dan boleh berubah.

Kesilapan badan

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

Dua pengecualian :

• /api/v1/messages menjawab dalam format kesilapan Anthropic, kerana itulah yang klien Anthropic menganalisis: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Jenis mengikut status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error atau overloaded_error (503).
• Permintaan streaming yang gagal sebelum bajet pertama mendapat kesilapan JSON biasa dengan status di atas, bukan aliran peristiwa.

Mesej ralat tidak pernah mengandungi butiran dalaman perkhidmatan lain. ralat pembekal sendiri diubahsuai sebelum ia tiba kepada anda.

Perbatasan

Pautan kepada imej mesti menunjukkan kepada host awam: alamat di rangkaian swasta atau tempatan, atau di laman web Nymbot sendiri, ditolak. peta penyedia yang berlaku dalam aplikasi juga berlaku di sini, jadi letupan permintaan kepada satu penyedia boleh dikurangkan daripada gagal.

Apa yang boleh dilihat oleh api

API bukan peribadi dalam cara aplikasi, dan ia bernilai tepat tentang bagaimana.

• Ia bukan end-to-end dienkripsi. Dalam aplikasi, mesej disegel pada peranti anda kepada kunci hanya Nymbot memegang dan bergerak sebagai Penghantaran WrapPermintaan API adalah HTTPS biasa: ia dienkripsi di jalan ke Nymbot, dan pelayan Nymbot membacanya dalam jelas untuk mengendalikannya.
• Soalan dan jawapan tidak disimpan. Apa yang disimpan ialah bil: untuk setiap permintaan masa, model, jenis, jumlah token, kos, baki, kunci dan sama ada ia berjaya, selama 90 hari, yang merupakan apa yang Mencari Sejarah Rekod penggunaan permintaan yang sama (waktu, jenis, model, bilangan token, kos, tempoh dan sama ada ia menggunakan carian web atau berjaya) juga disimpan selama 90 hari, bersama dengan app sendiri.
• Semua yang lain yang dikehendaki untuk nym adalah kecil dan disenaraikan di sini. Kunci api disimpan sebagai hash, tidak pernah kunci, dengan nama mereka, petunjuk pendek, pengeluaran cap, tempoh reset, tamat tempoh dan apabila mereka dibuat dan terakhir digunakan; hanya 50 kunci terkini yang dibatalkan disimpan. automatik top-up sambungan dompet disimpan disulitkan, dengan ambang, jumlah dan hasil daripada top-up terakhir. kerja-kerja video disimpan selama 24 jam. Permintaan yang dibayar per panggilan meninggalkan hanya hash pembayaran Lightning selama 7 hari dan token bayaran balik yang disulitkan selama 30 hari, yang dikaitkan dengan tiada nym. Caj yang tidak boleh diisi baki disimpan sebagai berhutang sehingga top-up membayar mereka.
• Menghapuskan app akan menghapusnya. A Perkhidmatan Wipe membatalkan dan memadamkan setiap kunci API, dan memadamkan sejarah pertanyaan, rekod penggunaan, sambungan dompet dan kerja video.
• Pembekal model melihat permintaan andaModel Katalog berjalan pada pembuat mereka; laluan standard dan embeddings berjalan pada Cloudflare.
• Media yang dihasilkan ialah media awam. Imej dan video yang dihantar sebagai pautan dimuat naik ke tuan fail Blossom awam, di mana alamat fail adalah hashnya.Siapa sahaja yang mempunyai pautan boleh membukanya, dan Nymbot tidak boleh mengambilnya semula.Minta b64_json dan imej yang dihasilkan kembali dalam respons dan tidak pernah dimuat naik.
• Begitu juga gambar-gambar yang anda berikan kepada generator. Gambar yang anda muat naik ke edit, atau hantar sebagai a data: URL dalam generator image_url, dimuat naik ke host Blossom awam terlebih dahulu supaya generator boleh mengambilnya, dan yang sama berlaku kepada ia. https:// Gambar dalam permintaan chat pergi kepada pembekal model, bukan kepada Blossom.
• Kunci yang dikaitkan dengan nym anda. Segala-galanya yang menghabiskan kunci datang daripada baki nym anda, jadi penggunaan API tidak AnonimJika anda mahu penggunaan API disimpan terpisah daripada nym harian anda, buat kunci daripada nym yang berasingan dengan keseimbangan sendiri.

Jika anda memerlukan perlindungan aplikasi, gunakan aplikasi. API adalah untuk apabila anda memerlukan model dalam alat anda sendiri.

Setiap titik akhir

“Nym” bermaksud permintaan yang ditandatangani oleh kunci Nostr anda, yang diterangkan dalam Menandatangani permintaan akaunUntuk alat yang sudah berbicara format ini, lihat Alat dan SDK, dan untuk agen pengkodean seperti Claude Code, Codex dan Cline, lihat Alat koding.