Dasar pangaweruh / ngembangkeun

Ngeunaan API

Modél, generator, jeung balanse anu anjeun ngagunakeun dina aplikasi, ti kode anjeun sorangan. API ngobrol jeung OpenAI jeung Antropic format, jadi loba alat jeung SDK ngajalankeun ku ngarobah URL dasar jeung kunci.

Kaca ieu ditarjamahkeun ku mesin pikeun genah. Asli Inggris nyaéta versi anu lumaku.

Demi sasatoan anu dimaksud nyaéta vertebrata.

Ngeunaan API nymbot.ai nu nyanggakeun permintaan anu sarua pikeun klien OpenAI atawa Anthropic geus dikirim. Anjeun meunang:

• Ngeunaan kompléksAnjeunna Ngeunaan API jeung Panggilan antropik, kalawan streaming, alat, gambar, argumen jeung pencarian web, pikeun unggal model di Catalog nu jeung pikeun auto-routing Nymbot sorangan.
• Gambar, Video nu, Ngobrol, transliterasi jeung Ngeunaan.
• Anjeun balanja, Ngeunaan Top-ups, Top-ups otomatis ti dompet Anjeun Anjeunna a Sejarah Ngeunaan biaya anu dibutuhkeun.

Ieu dibayar ku dua balanja Ngeunaan aplikasi, di harga anu sarua. Aya teu langganan jeung teu kauntungan bébas dina API: unggal permintaan dibayar ku kredit nu dibeli.

Naon nu API teu ngalakukeun téh nambahkeun kitu ti Nymbot sorangan. Panggilan anjeun balik ka model nalika anjeun ngirim aranjeunna: teu Nymbot sistem prompt, teu memori, teu tanggal atawa alesan basa.

Ngeunaan URL

Hiji titik endpoint hirup di handap /api/v1/Hiji lalampahan unknown balik 404 Demi sasatoan anu dimaksud nyaéta vertebrata. 405Di handap ieu nyaéta JSON.

API nyanggakeun request cross-origin ti mana wae situs, jadi hiji kaca browser bisa nelepon eta. Sakabéh anjeun ngirimkeun ka hiji browser bisa dibaca ku anu ngajalankeun eta, ku kituna ngan ngalakukeun eta ku kunci anu boga hiji leutik AnjeunnaThe endpoints signed jeung nym Anjeun (keys, summary akun, NWC auto-top-up jeung refund redemption) mangrupakeun hiji éksklusif: dina hiji browser aranjeunna jawab ngan situs Nymbot sorangan. Nurutkeun permintaan akun.

Ngirimkeun unggal body JSON kalawan Content-Type: application/jsonNgeunaan author nu: Lamun anjeun resep artikel ieu ngeunaan 415, jadi bentuk HTML biasa atawa a text/plain Anjeun tiasa nempatkeun aplikasi anjeun dina API. -H "Content-Type: application/json" Saterusna -d.

Nyambungkeun API

Nyingkaran anu dijieun dina app. buka Ngaronjatkeun di sidebar aplikasi web, atawa dina menu on Android jeung iOS, jeung tap Nyiptakeun kunciNgeunaan ngaran jeung, lamun hayang, cap jeung tanggal kaduaan.

Nymbot ngajadikeun ngan hiji sidik jari tina éta, jadi teu bisa ngajadikeun eta ka anjeun deui. Nymbot teu bisa ngaronjatkeun nu kadua.

Ngeunaan kunci nyaéta sk-nymbot- Nurutkeun ku 43 huruf, angka, dashes jeung underscores. app nyertakeun unggal kunci ku ngaran na hint pendek kayaning: sk-nymbot-Qm7x…c2Lw.

• Salah sahiji kunci téh milik nym Anjeun. Ieu ngamangpaatkeun keseimbangan anjeun, sarta ngan nyim anjeun bisa nyieun, ngarobah atawa nyingkahi eta. Saha anu ngabogaan kunci bisa ngamangpaatkeun eta, jadi perlakuan eta salaku kata sandi.
• Caps aya dina sats. A key bisa boga hiji spending cap, sarta cap bisa reset unggal dinten, unggal minggu (Monday) atawa unggal bulan (pirang), di 00:00 UTC. Ieu ngitung duanana salinan, hiji kredit standar salaku 10 sats jeung hiji kredit Pro salaku 100, jadi éta ngarti sama mana salinan a request spends. Sateuacan permintaan dioperasikeun, maximum eta bisa biaya (ngaronjatkeun nepi ka kredits sakabeh) ieu ditempatkeun kana naon aya ti cap. Upami eta teu cocog, permintaan anu ditolak ku 403 key_limit_reached, malah lamun jawabna bakal datang di handap cap; kesalahan nyebutkeun seueur aya jeung lamun cap reset. max_tokens A permintaan anu dibayarkan naon eta bener biaya na nu dihitung ku cap, jadi lamun provider ngirimkeun leuwih token ti anu ditempatkeun di sakuliahna, permintaan panganyarna nu cocog bisa nyandak kunci saterusna leuwih ti cap nya; nu sakuliahna ditolak.
• A kapang ditangtukeun ngan ngéléhkeun spending. A kunci di cap nya masih bisa nempo keseimbangan, baca sajarah, daftar model, hitungan token, top up jeung nempo dina video nu geus dimimitian.
• Ieu téh opsional. Sanggeus tanggal anjeun nyetel, kunci nganteurkeun.
• Ngabalukarkeun téh langsung jeung final. A key revoked gagal permintaan saterusna. Ieu tetep dina daftar, ditandatanganan revoked, jadi sajarah spending nya masih ngarti.
• Anjeun bisa boga nepi ka 25 kunci aktif, unggal kalawan ngaran sorangan. Ngaronjatkeun periode reset nu kunci ngamimitian periode anyar ti nol.

Hiji lembar anu sarua nembongkeun pangeluaran unggal kunci dina periode ieu sarta totalna, nalika ieu terakhir dipaké, duanana salinan anjeun, jeung requests API panungtungan Anjeun. endpoints di handap ieu didokumentasikeun di Manajemén kunci.

Autentikasi permintaan

Ngirimkeun kunci dina salah sahiji headers ieu. Aranjeunna équivalent, jadi ngagunakeun naon klien anjeun ngirim ku default:

A kadua, unknown, dibatalkeun atawa kadua key balik 401Ku kituna kode missing_api_key, invalid_api_key, revoked_api_key Anjeunna expired_api_keyListing model, model audio jeung voices, jeung metode pembayaran teu kudu kunci.

Gambar, video, pidato, transkripsi jeung embeddings ogé bisa dibayar pikeun hiji perminta dina waktu leuwih Lightning tanpa kunci di sakuliahna: ngirimkeun perminta tanpa hiji jeung mayar invoice dina 402 Jawaban téh. Uang ku permintaan tanpa kunci.

Manajemén kunci, ringkasan akun jeung top-ups otomatis mangrupakeun pengecualian: aranjeunna nyokot tanda ti nym anjeun alatan kunci, jadi kunci leaked teu bisa nyieun leuwih kunci. Nurutkeun permintaan akun.

Percobaan Anjeun

Nempatkeun kunci dina variabel lingkungan, lajeng mintonkeun hiji model kitu. 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 mangrupakeun routing Nymbot sorangan, dibayar ti keseimbangan standar. Simpen ID model katalog di sana, kayaning: anthropic/claude-sonnet-5, pikeun ngagunakeun model ieu ti Pro keseimbangan. Nurutkeun model Anjeun tiasa nyadiakeun ID.

Ngeunaan biaya

The API bills sahenteuna kumaha app ngalakukeun.

• Naon anu balanja. nymbot/auto Ulah ngalahirkeun Standar téh balanse (10 sats a credit). unggal model chat séjén nyimpen Pro téh balanse (100 sats hiji kredit). Generator gambar standar jeung suara standar nyimpen kredit standar; unggal generator séjén nyimpen Pro. Embeddings nyimpen kredit standar. Transcription nyimpen kredit standar lamun saldo standar bisa nyimpen eta, jeung kredit Pro sejenna. Daftar model nyebutkeun naon saldo unggal model nyimpen.
• Naon téh. A permintaan obrolan diukur dina token nu model bener dibaca jeung ditulis, dina tarif diterbitkeun provider urang. Harga ieu boga 5% fee ditambahkeun sarta lajeng dibantahkeun ku 1.5, jadi anjeun mayar 1.575 kali harga daftar provider urang. Ieu dialihkeun ka sats dina harga live Bitcoin sarta dibayarkan dina ribu-bijian tina hiji kredit. Pro gambar, video jeung pidato anu dibayar per generasi, per detik atawa per karakter, jeung transcription per detik audio, kalawan fee jeung margin anu sarua. gambar standar nyaéta flat 5 kredit standar jeung suara standar a flat 3.
• Ieu téh minimum. Sakabéh request métered nu ngajalankeun biaya kurang ti 0.05 kredit: setengah sat dina saldo standar, 5 sats on Pro. fractions of a credit anu dilakukeun, teu buleudkeun unggal kali.
• Ngeunaan pikeun nyimpen. Sateuacan permintaan ngajalankeun, paling biaya anu bisa ditahan ti saldo anjeun, dumasar kana naon anjeun ngirim jeung paling token anu bisa ditulis. Tékstos luar ASCII biasa dikaluarkeun ti UTF-8 bytes na angka ASCII jeung titik-titik dihitung salaku token unggal, jadi teks dina mana wae script, kode jeung angka anu ditahan pikeun lengkep. Tékstos nyaéta dina kreditas sakabéh, sahenteuna hiji, jadi unggal permintaan kudu sahenteuna 10 sats bébas dina saldo standar atawa 100 sats on Pro pikeun ngamimitian. Sadaya biaya nyata anu dibayaran; sisihna dileupaskeun nalika eta diakhiri. A request panjang nyimpen keur lengkep; upami kreditas anu ditutup jadi sadia, a stream dihentikeun ku a 402 insufficient_balance Ngeunaan author nu: Lamun anjeun resep artikel ieu ngeunaan (owed_sats Di nymbot Objek, jeung saldo négatip). Naon anu wajib dibayar kahiji ti kredit saterusna anu ngahontal saldo ieu. Sanajan eta dibayar, kitu dina saldo ieu bisa dihabiskan: teu ku API, respon dina aplikasi, hiji transfer atawa hadiah.
• Kredit nu teu cukup. Upami saldo teu bisa nyertakeun holding, permintaan anu ditolak ku 402 The kesalahan nyebutkeun nu keseimbangan téh pendek, sababaraha sats permintaan dibutuhkeun jeung sababaraha anu bébas. max_tokens Ieu ngabalukarkeun kaayaan leutik.
• Anjeunna gagal. A permintaan nu gagal ngabalukarkeun naon, mun provider dibayaran pikeun karya anu dilakukeun saméméh gagal, atawa pencarian web atawa nymbot/auto Nymbot terus maca stream provider pikeun nepi ka 25 detik sanggeus anjeun leungit pikeun meunangkeun hitungan nu. Upami éta teu datang, biaya anu diperkirakeun ti naon anjeun ngirim jeung naon anu ditulis, jeung pikeun model nu alesan eta ngawengku sakabéh output permission tina hold. A request nu koneksi nu drop masih diakhiri jeung dicharge.
• Nurutkeun cost $0.008 hiji pencarian, dialihkeun ka sats, salila pencarian dilakukeun, nu model lajeng respon atawa gagal. kaca anu dibaca ogé dikirim ka model salaku input, jadi aranjeunna nambah token maranéhanana.

Tiap respon nyebutkeun naon biaya. respon JSON ngabalukarkeun a nymbot Objek jeung saldo anu dibayar ti, biaya dina kredit jeung sats, jeung naon anu tetep:

Objektif biaya

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

Jawaban dibayar ogé ngabalukarkeun header ieu, nu aya di mana pikeun ningali biaya tina respon nu teu JSON, kayaning ucapan:

Tarif per juta token, geus kaasup fee na margin, aya di Ngeunaan model Dolar jeung SATA. Harta hargaUpami harga Bitcoin teu bisa dibaca, permintaan dibayar balik 503 price_unavailable jeung Retry-After: 60 Anjeunna ngabalukarkeun indit.

Salahkeun

Sakabéh kasalahan boga bentuk anu sarua, hiji nu klien OpenAI geus paham. code Ieu mangrupakeun ngaran stabil nu bisa cocog jeung; message Ieu téh pikeun jalma jeung bisa ngarobah.

Tubuh nu 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
  }
}

Aya dua pengecualian:

• /api/v1/messages jawab dina format kesalahan Anthropic urang, sabab éta naon klien Anthropic parse: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Tipe ieu nyandak status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error Anjeunna overloaded_error (503).
• A permintaan streaming nu gagal saméméh byte kahiji nya nampa kasalahan JSON biasa jeung status di luhur, teu hiji aliran acara. A kasalahan sanggeus aliran geus dimimitian dikirim salaku acara panganyarna aliran, dina format endpoint sorangan.

Panggilan runtuyan teu pernah ngandung rinci internal jasa séjén. runtuyan runtuyan provider sorangan ieu reworded saméméh eta nampa anjeun.

limit nu

A link ka gambar kudu nelepon ka host publik: alamat dina jaringan swasta atawa lokal, atawa dina situs sorangan Nymbot, anu ditolak. provider pacing nu diterapkeun dina aplikasi ogé diterapkeun di dieu, jadi a burst of requests ka hiji provider bisa disaluyukeun alatan gagal.

Naha anjeun tiasa nempo ngeunaan hal ieu.

API teu pribadi dina cara aplikasi anu, sarta éta wartos jadi akurat ngeunaan kumaha.

• Ieu teu end-to-end encrypted. Dina aplikasi, hiji pesan ditutup dina alat anjeun ka keyes ngan Nymbot nyimpen jeung jalan salaku Ngeunaan wrapA request API mangrupakeun HTTPS biasa: éta disadiakeun dina jalan ka Nymbot, sarta server Nymbot nelepon eta dina jelas pikeun ngatur eta.
• Prompts jeung jawaban teu disimpen. Kitu anu disimpen nyaéta tagihan: pikeun unggal permintaan waktos, model, jenis, token hitungan, biaya, keseimbangan, kunci jeung lamun éta sukses, pikeun 90 poé, nu mangrupa naon Ngeunaan sajarah A record of usage of the same request (time, jenis, model, token count, cost, duration jeung lamun eta dipaké web search atawa sukses) ogé disimpen pikeun 90 poé, di samping app sorangan.
• Sakabéh hal anu ditangtukeun pikeun nym téh leutik jeung disusun di dieu. Nyambungkeun API ieu disimpen salaku hash, teu ka kunci, jeung ngaran maranéhanana, hint pendek, kapang spésifikasi, periode reset, expiration na lamun aranjeunna dijieun jeung terakhir dipaké; ngan paling anyar 50 kunci dibatalkeun disimpen. Ieu téh top-up otomatis. sambungan dompet disimpen disimpen, jeung ambangna, jumlah na hasil tina top-up panganyarna. kerja video disimpen pikeun 24 jam. permintaan dibayar per panggilan tetep ngan hash pembayaran Lightning pikeun 7 poé jeung token refund hashed pikeun 30 poé, dikaitkeun jeung no nym. Biaya anu saldo teu bisa ditutupi disimpen sakumaha dibutuhkeun nepi ka top-up mayar aranjeunna.
• Ngaronjatkeun app nu ngabalukarkeun. A Ngeunaan wipe nyokot jeung dihapus unggal kunci API, sarta dihapus sajarah query, catetan pamakéan, sambungan wallet jeung video jobs.
• Modél provider nempo permintaan anjeunModél katalog ngajalankeun di produsén maranéhanana; ruteu standar jeung embeddings ngajalankeun dina Cloudflare.
• Media anu dihasilkeun nyaéta publik. Gambar jeung video disadiakeun salaku link nu diunggah ka publik Blossom file hosts, dimana alamat file mangrupakeun hash na. Saha anu boga link bisa buka eta, sarta Nymbot teu bisa ngundeur eta deui. b64_json jeung gambar dihasilkeun balik dina respon na teu pernah diunggah.
• Ieu téh gambar nu Anjeun nyadiakeun generator. Gambar anu anjeun ngunggah ka Ngeunaan, atawa ngirimkeun salaku a data: URL dina generator image_url, diunggahkeun ka host umum Blossom kahiji jadi generator bisa nyokot eta, jeung hal anu sarua ngagaduhan ka eta. https:// gambar dina permintaan obrolan go ka provider model nu, teu ka Blossom.
• A kunci anu dikaitkeun ka nym Anjeun. Sakabéh anu key dihabiskan datang ti keseimbangan nym anjeun, jadi pamakéan API teu NgeunaanUpami anjeun hoyong pamakéan API disimpen jauh ti nym kaséhatan anjeun, nyieun kunci ti nym separat jeung keseimbangan sorangan.

Lamun perlu perlindungan aplikasi, ngagunakeun aplikasi. API nyaéta pikeun lamun anjeun kudu modél dina alat Anjeun sorangan.

Ngeunaan Endpoint

“Nym” ngagambarkeun permintaan ditandatanganan ku kunci Nostr anjeun, dijelaskeun di Nurutkeun permintaan akunPikeun alat nu geus ngobrol format ieu, tingali Alat jeung SDK, jeung pikeun agén coding kayaning Claude Code, Codex jeung Cline, tingali Alat coding téh.