Basis kawruh / Pembangunan

Panjenenganipun api.

Model, generator, lan keseimbangan sing sampeyan nggunakake ing aplikasi, saka kode dhewe. API ngandika format OpenAI lan Anthropic, supaya paling alat lan SDK nggunakake kanthi ngganti URL basis lan kunci.

Kaca iki diterjemahake mesin kanggo penak. Asli Inggris minangka versi sing ditrapake.

Apa iku api?

Nggunakake HTTP API nymbot.ai lan nyanggakeun permintaan padha sing klien OpenAI utawa Anthropic wis ngirim.

• Katrangan lengkapDheweke Jawaban saka api lan Panggonan antropik, karo streaming, alat, gambar, argumen lan pencarian web, kanggo saben model ing Kataraké lan kanggo auto-routing Nymbot dhewe.
• gambar, Video lan, pidato, Transaksi lan Ngluwihi.
• Panjenengan Balansipun, Piyambakipun top-ups, Top-ups otomatis saka dompet lan a Sejarah apa biaya saben permintaan.

Dheweke dibayar saka iki padha balansa Ing API ora ana langganan lan ora gratis: saben permintaan dibayar saka kredit sing dibeli.

Apa API ora nambah apa-apa saka Nymbot dhewe. Panggonan sampeyan mbukak menyang model nalika sampeyan ngirim: ora panggilan sistem Nymbot, ora ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing ing.

Url basa

Tiap titik akhir urip ing /api/v1/Rute sing ora dikenal iku kembar. 404 lan jalur sing dikenal disebut karo metode salah mbukak 405Tiyang iku JSON.

API nglakoni permintaan antarane asal saka situs apa-apa, supaya kaca browser bisa nelepon. Apa-apa sing ngirim menyang browser bisa dibaca dening siapa-siapun ngluwihi, supaya mung nggunakake kunci sing duwe kunci sing cilik. KapaEndpoints sing ditandatangani karo nym (keys, ringkasan akun, NWC auto-top-up lan refund redemption) iku pengecualian: ing browser padha nyanggur mung situs Nymbot dhewe. Panggonan akun.

Ngirimake saben badan JSON karo Content-Type: application/jsonApa-apa jenis liyane ditolak karo 415Tiyang ing format HTML lan a text/plain ing situs liyane ora bisa nggunakake API. karo cURL, pas -H "Content-Type: application/json" Sampeyan karo -d.

Kunci api

Kunci iki digawe ing app. Open Neraka ing sidebar aplikasi web, utawa ing menu ing Android lan iOS, lan ketuk Nggunakake KunciGunakake jeneng lan, yen sampeyan suka, cap lan tanggal kedadean.

Nglumpukake ing tempat aman sadurunge ngluwihi lembar: Nymbot nyimpen mung sidik jari, supaya ora bisa nampilake menyang sampeyan. Kunci sing hilang ora bisa diwenehi; njaluk lan nggawe liyane.

Piyambakipun iku tampak sk-nymbot- Iku diikuti karo 43 huruf, angka, dashes lan subscores. Aplikasi nyusun saben kunci kanthi jeneng lan petunjuk sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing ana. sk-nymbot-Qm7x…c2Lw.

• A kunci iku milik nym. Iku nggunakake keseimbangan, lan mung nym sampeyan bisa nggawe, ngganti utawa njaluk. Siap-siap sing duwe kunci bisa nggunakake karo iku, supaya nglakoni minangka password.
• Piyambakipun ora diwenehi. A kunci bisa duwe kapangan pengeluaran, lan kapangan bisa ngreset saben dinten, saben minggu (Monday) utawa saben bulan (yang pertama), ing 00:00 UTC. Dheweke nghitung kedhaftar saldo, kredit standar minangka 10 sats lan kredit Pro minangka 100, supaya iku makna padha apa saldo permintaan nggunakake. 403 key_limit_reached, uga yen jawabane bakal ana ing ngisor kap; kesalahan ngandika apa sing ana lan nalika kap ngreset. max_tokens Rekomendasi dibayarkan apa sing sebenarnya biaya lan sing dihitung kanggo cap, supaya yen penyedia melaporkan token luwih saka sing dipisahake, permintaan pungkasan sing cocok bisa njaluk kunci sedikit liwat cap; siji liyane banjur ditolak.
• Sampeyan ora bisa ngetokake biaya. A kunci ing kapok bisa uga ngetokake keseimbangan, njaluk riwayat, daftar model, nghitung token, top up lan ngetokake video sing wis dimulai.
• Panggonan iku opsional. Sawisé tanggal sing diwenehi, kunci nghenti ngoperasi.
• Penghapusan iku langsung lan final. Kunci sing diwenehi gagal permintaan liyane. Dheweke tetep ing daftar, ditandani diwenehi, supaya riwayat pengeluaran iku masih makna.
• Sampeyan bisa duwe nganti 25 kunci aktif, saben karo jeneng dhewe. Ngganti periode reset kunci ngluwihi periode anyar saka nul.

Ing lembar sing padha nuduhake pengeluaran saben kunci ing periode iki lan total, nalika iku digunakake sadurunge, kedhaftar saldo, lan permintaan API sing sadurunge. Manajemen kunci.

Autentikasi permintaan

Ngirim kunci ing salah siji saka header iki. Mereka ekuivalen, supaya nggunakake apa-apa klien ngirim ing default:

Returns kunci sing munggah, ora dikenal, dibatalake utawa kedadean 401Kanthi kode iku missing_api_key, invalid_api_key, revoked_api_key lan expired_api_keyListing model, model audio lan suara, lan metode pembayaran ora kudu kunci.

Foto, video, pidato, transkripsi lan embeddings uga bisa dibayar kanggo siji permintaan ing wektu liwat Lightning tanpa kunci ana: ngirim permintaan tanpa siji lan mbayar tagihan ing 402 Jawaban: iku Pay per request tanpa kunci.

Manajemen kunci, ringkasan akun lan top-ups otomatis iku pengecualian: padha njaluk tanda tangan saka nym ing ngendi kunci, supaya kunci sing lekat ora bisa nggawe tombol liyane. Panggonan akun.

Tiyang pisanan

Nglumpukake kunci ing variabel lingkungan, banjur nglakoni model apa-apa. 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 iku routing Nymbot dhewe, dibayar saka saldo standar. Simpen id model katalog ing ndhuwur, kayata anthropic/claude-sonnet-5, kanggo nggunakake model iki saka Pro Balance. Model lan model Dhèwèké iku id.

Apa biaya permohonan

API ngeculake persis cara app nggunakake.

• Apa iku keseimbangan. nymbot/auto Sampeyan nggunakake Standaripun balanse (10 sats a credit). saben model chatting liyane nggunakake Pro iku balanse (100 sats siji kredit). Generator gambar standar lan suara standar nggawé kredit standar; saben generator liyane nggawé Pro. Embeddings nggawé kredit standar. Transcription nggawé kredit standar nalika saldo standar bisa mbukak, lan kredit Pro liyane. Daftar model ngandika apa saldo saben model nggawé.
• lan apa. Permintaan chatting diukur ing token sing model padha baca lan ditulis, ing tarif diterbitake penyedia. Harga iki duwe biaya 5% ditambahake lan banjur diwiwiti dening 1.5, supaya sampeyan mbayar 1.575 kali saka harga daftar penyedia. Iki diwenehi kanggo sats ing harga Bitcoin urip lan dibayarkan ing ribu-bulan kredit. Pro gambar, video lan pidato diwenehi per generasi, per detik utawa per karakter, lan transkripsi per detik audio, karo biaya lan margin padha. Gambar standar iku flat 5 kredit standar lan suara standar flat 3.
• Minimal iku. Tiap permintaan diukur sing mbukak biaya minimal 0.05 kredit: setengah sat ing keseimbangan standar, 5 sats ing Pro. Fraksi kredit mbukak, ora diwenehi saben kali.
• Tiyang, banjur nyimpen. Kaben permintaan mbukak, paling biaya sing bisa mbukak saka keseimbangan sampeyan, dumunung ing apa sing ngirim lan paling token sing bisa mbukak. Teks ing luar ASCII biasa wis ukuran saka byte UTF-8, lan angka ASCII lan titik-titik nghitung minangka token saben, supaya teks ing script, kode, lan nomer mbukak kanggo lengkap. Keseimbangan punika kredit lengkap, setidaknya siji, supaya saben permintaan kudu setidaknya 10 sats free ing keseimbangan standar utawa 100 sats ing Pro kanggo miwiti. Sadurunge biaya nyata dibayar; sisih liyane diwenehi nalika ngluwihi. 402 insufficient_balance Tiyang-Tiyang ingkang dipunpungkuraken, ingkang dipunpungkuraken, ingkang dipunpungkuraken, ingkang dipunpungkuraken, ingkang dipunpungkurakaken, ingkang dipunpungkurakaken, ingkang dipunpungkurakaké, ingkang dipunpungkurakaké, ingkang dipunpungkurakaké, ingkang dipunpungkurakaké, ingkang dipunpungkurakaké, ingkang dipunpungkurakaké, ingkang dipunpungkurakaké, ingkang dipunpungkurakaké.owed_sats Ing nymbot Objek, lan keseimbangan negatif). Apa sing dibutuhake dibayar pisanan saka kredit liyane sing nampa keseimbangan iki. Sampeyan dibayar, apa-apa ing keseimbangan kasebut bisa diwenehi: ora dening API, respon ing aplikasi, transfer utawa hadiah.
• Kredit ora cukup. Yen saldo ora bisa mbukak retensi, permintaan iki ditolak karo 402 Kabeh apa-apa mbukak. Kesalahan ngandika manawa saldo sing pendek, sawetara sats permintaan kudu lan sawetara gratis. max_tokens Piyambakipun ngandika kurang.
• lan kegagalan. Panggonan sing gagal ora biaya apa-apa, kecuali penyedia tagihan kanggo kerja sing digawe sadurunge gagal, utawa pencarian web utawa nymbot/auto Task check wis wis dilakoni; banjur iku apa sing sampeyan mbayar, minimal 0.05 kredit. A stream sampeyan ngurangi dibayarkan kanggo token sing panyedhiya ngirim: Nymbot terus nonton stream panyedhiya nganti 25 detik sawise sampeyan mbukak kanggo njaluk hitungan iki. Yen ora mbukak, biaya dianggarake saka apa sing sampeyan ngirim lan apa sing ditulis, lan kanggo model sing alasan iku kalebu kabeh izin output saka hold.
• Web lan search biaya $ 0.008 search, diwenehi kanggo sats, nalika search run, utawa model banjur respon utawa gagal. kaca sing dibaca uga dikirim menyang model minangka input, supaya padha nambah token.

Tiap jawaban ngandika apa biaya. respon JSON nglakoni nymbot objek karo saldo sing dibayar saka, biaya ing kredit lan sats, lan apa sing tetep:

Objek biaya

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

Jawaban dibayar uga nglakoni header iki, ing ngendi sampeyan bisa njaluk biaya jawaban sing ora JSON, kayata pidato:

Biaya saben yuta token, wis kalebu biaya lan margin, ana ing Daftar model Ing dolar lan sats, lan ing Kartu HargaYen harga Bitcoin ora bisa dibaca, permintaan dibayar ngirim 503 price_unavailable Dheweke Retry-After: 60 Dheweke ora bisa ngetokake.

Nggawé

Kabeh kesalahan duwe bentuk sing padha, sing klien OpenAI wis ngerti. code iku nama stabil sampeyan bisa match ing; message Iki bisa kanggo wong lan bisa kanggo ngganti.

Tubuh iku salah.

{
  "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 iku:

• /api/v1/messages Jawaban ing format kesalahan Anthropic, amarga iku apa klien Anthropic parse: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Tip iku iku status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error lan overloaded_error (503).
• Rencana streaming sing gagal sadurunge bajet pisanan njaluk kesalahan JSON biasa karo status ndhuwur, ora aliran acara. A kegagalan sawise aliran wis dimulai dikirim minangka acara pungkasan aliran, ing format endpoint sing dhewe.

Panggonan kesalahan ora ngandhut rincian internal layanan liyane. Kesalahan provider dhewe iki reworded sadurunge iki mbukak sampeyan.

limang

Link kanggo gambar kudu ngandhingake host umum: alamat ing jaringan pribadi utawa lokal, utawa ing situs Nymbot dhewe, ditolak. Papan provider sing digunakake ing app uga digunakake, supaya bubar permintaan kanggo siji provider bisa ngurangi nanging ora gagal.

Apa sing api bisa ndeleng

API ora pribadi ing cara aplikasi iku, lan layak dadi akurat babagan cara.

• Dheweke ora end-to-end enkripsi. Ing aplikasi, pesan ditutup ing piranti sampeyan kanggo kunci mung Nymbot mbukak lan ngunjungi minangka Tembung WrapPanggonan API iku HTTPS biasa: iku enkripsi ing jalan kanggo Nymbot, lan server Nymbot njaluk ing jelas kanggo nglakoni.
• Panggonan lan respon ora disimpen. Apa sing disimpen iku tagihan: kanggo saben permintaan wektu, model, jinis, token hitung, biaya, saldo, kunci lan yen iku sukses, kanggo 90 dina, kang iku apa Wektu sejarah A rekaman nggunakake permintaan sing padha (waktu, jenis, model, token count, biaya, durasi lan yen iku nggunakake pencarian web utawa sukses) uga disimpen kanggo 90 dina, karo app dhewe.
• Apa-apa liyane ditahan kanggo nym cilik lan disenaraake ing iki. Kunci api iki disimpen minangka hash, ora kunci, karo jeneng, petunjuk sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing sing paling anyar sing diwenehi. Top-up lan automatik Panggonan video disimpen kanggo 24 jam. Panggonan dibayar per panggilan ndadekake mung hash pembayaran Lightning kanggo 7 dina lan token pengembalian hash kanggo 30 dina, disambungake karo ora nym. Panggonan saldo sing ora bisa mbukak disimpen minangka dibutuhake nganti top-up mbayar.
• Wiping app nghapus iku. A Nglumpuk wipe mbukak lan nghapus saben kunci API, lan nghapus riwayat query, cathetan penggunaan, koneksi wallet lan video jobs.
• Produsèn model ndeleng permintaan sampeyanModèla katalog mbukak ing pembangun; rute standar lan embeddings mbukak ing Cloudflare.
• Media sing diprodhuksi iku publik. Foto lan video sing dikirim minangka link diunggah menyang host file Blossom umum, ing ngendi alamat file iku hash. Siapapun karo link bisa ngluwihi, lan Nymbot ora bisa ngluwihi. b64_json lan gambar sing diprodhuksi balik ing respon lan ora diunggah.
• Iku gambar sing sampeyan nyedhiyakake generator. Foto sing sampeyan ngupload kanggo Tiyang, utawa ngirim minangka a data: URL ing generator image_url, diunggah menyang host Blossom umum sadurunge supaya generator bisa njaluk, lan iku uga berlaku kanggo iku. https:// Gambar ing panggilan chatting ndadekake kanggo penyedia model, ora kanggo Blossom.
• A kunci disambungake karo nym. Kabeh apa-apa kunci nggunakake ana saka keseimbangan nym, supaya nggunakake API ora PanjenenganipunIf you want API use kept apart from your everyday nym, nggawe kunci saka nym sing ndhuwur karo keseimbangan dhewe.

If you need the protection of the apps, use the apps. API iku kanggo nalika sampeyan kudu model ing alat dhewe.

Tiyang Endpoint

“Nym” berarti permintaan sing ditandatangani dening kunci Nostr, sing digambarake ing Panggonan akunKanggo alat sing ora ngandika format iki, ndeleng Alat lan SDK, lan kanggo agen kode kayata Claude Code, Codex lan Cline, ndeleng Alat-alat kode.