Znalostná báza / Vývojári

Oheň prehľad

Modely, generátory a rovnováhy, ktoré používate v aplikácii, z vlastného kódu. API hovorí o formátoch OpenAI a Anthropic, takže väčšina nástrojov a SDK funguje zmenou základnej adresy URL a kľúča.

Táto stránka je pre pohodlie preložená strojovo. Platí anglický originál.

Čo je to oheň

HTTP API na nymbot.ai ktorý odpovedá na rovnaké požiadavky, ktoré už odosiela klient OpenAI alebo Anthropic.

• Chat dokončenie, ktorý Odpoveď API a Antropické posolstvá, s streamovaním, nástrojmi, obrázkami, uvažovaním a vyhľadávaním na webe, pre každý model v Katalóg a pre vlastné automatické smerovanie Nymbotu.
• Obrázky, Videá, Príhovor, transkripcia a Emblémy.
• Váš rovnováhu, Svetelné top-ups, Automatické top-ups z vašej peňaženky a a História Koľko stojí každá žiadosť?

Platí sa z rovnakých dvoch rovnováhy Neexistuje žiadny predplatný a žiadny bezplatný príspevok na API: každá požiadavka je zaplatená z kreditov, ktoré ste si kúpili.

To, čo API nerobí, je pridať niečo z vlastného Nymbotu. Vaše správy idú do modelu, keď ste ich poslali: žiadny systémový výzva Nymbotu, žiadna pamäť, žiadne dátumy alebo náznaky jazyka.

Základné URL

Každý koncový bod žije pod /api/v1/Neznáma cesta sa vracia 404 a známa cesta nazvaná nesprávnou metódou sa vráti 405Obaja sú ako JSON.

API reaguje na krížové požiadavky z akéhokoľvek webu, takže prehliadačová stránka ju môže zavolať.Čokoľvek, čo odošlete do prehliadača, môže čítať ktokoľvek, kto ho otvorí, takže to urobte len s kľúčom, ktorý má malú hlavyKoncové body podpísané s vaším nym (kľúče, súhrn účtu, NWC auto-top-up a vrátenie peňazí) sú výnimkou: v prehliadači odpovedajú iba na vlastné stránky Nymbotu. Podpísanie žiadosti o účet.

Odoslať každé telo JSON s Content-Type: application/jsonAkýkoľvek iný typ je odmietnutý 415, takže jednoduchý formát HTML alebo text/plain žiadosti z inej lokality nemôže dosiahnuť API. s cURL, prejsť -H "Content-Type: application/json" Spolu s -d.

Požiarne kľúče

Kľúče sa vytvárajú v aplikácii.Open Oheň v bočnom paneli webovej aplikácie alebo v ponuke v systéme Android a iOS a ťuknite Vytvoriť kľúčDajte jej názov a ak chcete, kapotu a dátum vypršania platnosti.

Kľúč sa zobrazí raz. Skopírujte ho niekde bezpečne pred zatvorením hárka: Nymbot si ponechá iba odtlačok prsta, takže vám ho nemôže ukázať znova. Stratený kľúč sa nedá obnoviť; zrušte ho a vytvorte iný.

Kľúč vyzerá ako sk-nymbot- nasledovaných 43 písmenami, číslicami, číslicami a podhodnotením. Aplikácia uvádza každý kľúč podľa svojho mena a krátky náznak, ako napríklad: sk-nymbot-Qm7x…c2Lw.

• Kľúč patrí vášmu nym. To trávi váš zostatok, a len váš nym môže vytvoriť, zmeniť alebo zrušiť. ktokoľvek drží kľúč môže minúť s ním, tak sa s ním zaobchádzať ako s heslom.
• Caps sú v stávke. Kľúč môže mať výdavkovú hranicu a hranicu možno resetovať každý deň, každý týždeň ( pondelok) alebo každý mesiac (prvý), v 00:00 UTC. Počíta obe zostatky, štandardný kredit ako 10 sats a Pro kredit ako 100, takže to znamená to isté bez ohľadu na to, aký zostatok žiadosť vynakladá. Pred spustením žiadosti sa stanoví maximum, ktoré by mohlo stáť (zaokrúhlené na celé kredity) proti tomu, čo zostáva z hranice. 403 key_limit_reached, aj keby odpoveď prišla pod kapotu; chyba hovorí, koľko zostáva a kedy sa kapota resetuje. max_tokens Žiadosť je účtovaná to, čo skutočne stojí a to sa počíta proti limitu, takže ak poskytovateľ hlásí viac žetónov, než boli uvedené stranou, posledná žiadosť, ktorá sa hodí, môže kľúč trochu prekročiť jeho limitu; ďalší je potom zamietnutý.
• Vyčerpané peniaze zastavujú výdavky. Kľúč na jeho kapote môže stále kontrolovať zostatok, čítať jeho históriu, zoznam modelov, počítať tokeny, nahrať a skontrolovať video, ktoré už začalo.
• Expirácia je voliteľná. Po dátume, ktorý ste nastavili, kľúč prestane pracovať.
• Odvolanie je okamžité a konečné. Zrušený kľúč zlyhá v ďalšej žiadosti, zostáva v zozname označený ako zrušený, takže jeho história výdavkov má stále zmysel.
• Môžete mať až 25 aktívnych kľúčov, z ktorých každý má svoj vlastný názov. Zmena obdobia resetovania kľúča začína nové obdobie od nuly.

Rovnaký hárok zobrazuje výdavky každého kľúča počas tohto obdobia a celkovo, kedy bol naposledy použitý, vaše zostatky a vaše nedávne požiadavky API. Správa kľúčov.

Autentifikácia žiadosti

Odoslať kľúč v ktorejkoľvek z týchto hlavičiek. Sú ekvivalentné, takže použite čokoľvek, čo váš klient odošle predvolene:

Chýbajúce, neznáme, zrušené alebo vypršené vrátené kľúče 401S týmto kódom missing_api_key, invalid_api_key, revoked_api_key alebo expired_api_keyZoznam modelov, zvukových modelov a hlasov a spôsobov platby nepotrebuje žiadny kľúč.

Obrázky, video, reč, transkripcia a vkladanie môžu byť tiež zaplatené za jednu žiadosť naraz cez Lightning bez kľúča vôbec: odoslať žiadosť bez jedného a zaplatiť faktúru v 402 Odpoveď: Pozri Platba na požiadanie bez kľúča.

Správa kľúčov, súhrn účtu a automatické top-upy sú výnimkou: berú podpis z vášho nym namiesto kľúča, takže uniknutý kľúč nemôže vytvoriť viac kľúčov. Podpísanie žiadosti o účet.

Vaša prvá žiadosť

Umiestnite kľúč do premenné prostredia, potom sa opýtajte modelu niečo. 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 je vlastné smerovanie Nymbotu, zaplatené zo štandardného zostatku. Namiesto toho umiestnite ID modelu katalógu, ako napríklad anthropic/claude-sonnet-5, použiť tento model z Pro rovnováhy. Zoznam modelov Získajte každý ID.

Koľko stojí žiadosť

API fakturuje presne tak, ako to aplikácia robí.

• A akú rovnováhu. nymbot/auto vynakladať na štandardné rovnováha (10 sats a kredit). každý iný model chatu strávi Pro pre rovnováha (100 sats jeden kredit). Štandardný obrazový generátor a štandardný hlas míňajú štandardné kredity; každý iný generátor míňa Pro. Embeddings míňajú štandardné kredity. Transcription míňa štandardné kredity, keď ich môže pokrývať štandardný zostatok, a Pro kredity inak. Zoznam modelov hovorí, ktorý zostatok každý model míňa.
• Koľko toho. Žiadosť o rozhovor sa meria na žetóny, ktoré model skutočne čítal a napísal, na zverejnených sadzbách poskytovateľa. Táto cena má 5% poplatok a potom sa vynásobí 1,5, takže platíte 1,575-násobok ceny zoznamu poskytovateľa. Je prevedená na sadzbu na živú cenu Bitcoin a účtovaná v tisícinách úveru. Pro obrázky, video a reč sú oceňované za generáciu, za sekundu alebo za znak a prepisovanie za sekundu zvuku, s rovnakým poplatkom a maržou. Štandardný obrázok je plochý 5 štandardných kreditov a štandardný hlas je plochý 3.
• A to minimálne. Každá meraná požiadavka, ktorá beží, stojí najmenej 0,05 úveru: polovica sedí na štandardnej zostatku, 5 úverov na Pro. Zlomky úveru sa prenášajú, nie zaokrúhlené zakaždým.
• Držte a potom sa usadite. Pred spustením žiadosti sa najviac, čo by mohlo stáť, drží z vášho zostatku, na základe toho, čo ste poslali a najviac tokenov, ktoré môže napísať. Text mimo obyčajného ASCII je zväčšený z jeho UTF-8 bajtov a ASCII číslice a bodovanie sa počítajú ako jeden token každý, takže text v akomkoľvek skripte, kóde a číslach sa drží v plnom rozsahu. Drží sa v celých kreditoch, aspoň jeden, takže každá žiadosť potrebuje aspoň 10 bezplatných stávok na štandardnom zostatku alebo 100 stávok na Pro, aby mohla začať. Len skutočné náklady sa účtujú; zvyšok sa uvoľní, keď skončí. Dlhá žiadosť drží svoje držanie tak dlho, 402 insufficient_balance Ak je skutočná cena vyššia ako zostatok, celý zostatok sa vezme, zvyšok je dlžný (owed_sats V tejto nymbot objekt, a negatívny zostatok). To, čo je dlžné, sa vypláca najprv z nasledujúcich kreditov, ktoré dosiahnu tento zostatok. Kým sa nezaplatí, nič na tomto zostatku nemôže byť vynaložené: nie API, odpovede v aplikácii, prevod alebo darček.
• Nie je dosť úverov. Ak zostatok nemôže pokrývať držbu, žiadosť sa zamietne s 402 predtým, než sa niečo spustí. Chyba hovorí, ktorý zostatok je krátky, koľko stávok požiadavka potrebuje a koľko je zadarmo. max_tokens To znamená menšie držanie.
• a zlyhania. Žiadosť, ktorá zlyhá, nestojí nič, pokiaľ poskytovateľ neúčtuje za prácu, ktorú vykonal pred zlyhaním, alebo webové vyhľadávanie alebo nymbot/auto Kontrola úloh už bola spustená; potom to je to, čo platíte, najmenej 0,05 kreditu. Stream, ktorý ste odrezali, je účtovaný za tokeny, ktoré poskytovateľ hlásí: Nymbot pokračuje v čítaní tokenu poskytovateľa až 25 sekúnd po tom, čo opustíte, aby ste získali toto číslo. Ak nepríde, poplatok sa odhaduje z toho, čo ste poslali a čo bolo napísané, a pre model z týchto dôvodov zahŕňa celú výstupnú prípustnosť držania.
• Web vyhľadávanie Náklady $ 0,008 vyhľadávanie, prevedené na sats, vždy, keď sa vyhľadávanie spustilo, či model potom odpovie alebo zlyhá.

Každá odpoveď hovorí, koľko to stojí. JSON odpovede nesú nymbot objekt so zostatkom, z ktorého bol zaplatený, poplatok v kreditoch a sadzbách a to, čo zostáva:

Objekt nákladov

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

Platené odpovede tiež nesú tieto hlavičky, čo je miesto, kde hľadať náklady na odpoveď, ktorá nie je JSON, ako je napríklad reč:

Sadzby za milión tokenov, ktoré už zahŕňajú poplatok a maržu, sú v Zoznam modelov v dolároch a sadzbách, a na Cenový lístokAk sa cena Bitcoinu nedá prečítať, vrátia sa platené žiadosti 503 price_unavailable s Retry-After: 60 Skôr než hádať.

Chyby

Každá chyba má rovnaký tvar, ktorý klient OpenAI už chápe. code je stabilné meno, na ktoré sa môžete zhodovať; message Je to pre ľudí a môže sa zmeniť.

Chybné telo

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

Dve výnimky :

• /api/v1/messages odpovedí vo formáte chyby spoločnosti Anthropic, pretože to je to, čo klienti spoločnosti Anthropic analyzujú: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Typ sleduje stav: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error alebo overloaded_error (503).
• Streamovacia žiadosť, ktorá zlyhá pred svojím prvým bajtom, dostane bežnú chybu JSON so stavom vyššie, nie s prúdom udalostí.

Chybové správy nikdy neobsahujú interné podrobnosti inej služby.Vlastná chyba poskytovateľa sa preformuluje skôr, než sa k vám dostane.

Limity

Odkaz na obrázok musí poukázať na verejného hostiteľa: adresa na súkromnej alebo miestnej sieti alebo na vlastných stránkach Nymbotu je odmietnutá.Poskytovateľské tempo, ktoré sa uplatňuje v aplikácii, platí aj tu, takže výbuch požiadaviek na jedného poskytovateľa môže byť spomalený namiesto neúspechu.

Čo môže oheň vidieť

Rozhranie API nie je súkromné tak, ako sú aplikácie, a stojí za to byť presný o tom, ako.

• To nie je end-to-end šifrované. V aplikáciách je na vašom zariadení zapečatená správa na kľúče, ktoré len Nymbot drží a cestuje ako Darčekový obalAPI požiadavka je obyčajná HTTPS: je šifrovaná na ceste k Nymbot a server Nymbotu ju číta v jasnom, aby ju zvládol.
• Prospekty a odpovede sa neukladajú. Čo sa uchováva je faktúra: pre každú požiadavku čas, model, druh, token počítanie, náklady, zostatok, kľúč a či sa to podarilo, po dobu 90 dní, čo je to, čo Chcieť históriu Záznam o používaní tej istej žiadosti (čas, typ, model, počty tokenov, náklady, trvanie a či používa webové vyhľadávanie alebo úspešne) sa tiež uchováva po dobu 90 dní, spolu s vlastnou aplikáciou.
• Všetko ostatné držané pre nym je malé a uvedené tu. Požiarne kľúče sú uložené ako hash, nikdy kľúč, s ich menom, krátkym náznakom, výdavkovou kapotou, obnovením obdobia, uplynutím platnosti a kedy boli vytvorené a naposledy použité; iba posledných 50 zrušených kľúčov sa uchováva. Automatický top-up Pripojenie peňaženky je uložené šifrované, s jeho prahom, sumu a výsledkom posledného top-up. Video pracovné miesta sú uchovávané po dobu 24 hodín. Žiadosti zaplatené za hovor ponechávajú len Lightning platobný hash po dobu 7 dní a hashed refund token po dobu 30 dní, spojené s žiadnym nym. Poplatky, ktoré zostatok nemohol pokryť, zostávajú dlžné, kým ich top-up neuhradí.
• Odstránenie aplikácie ho odstraňuje. A Zariadenie Wipe zruší a odstráni každý kľúč API a vymaže históriu dotazov, záznamy o používaní, pripojenie peňaženky a video úlohy.
• Poskytovateľ modelu vidí vašu požiadavkuKatalógové modely sa spúšťajú na svojich výrobcoch; štandardné trasy a vkladanie sa spúšťajú na Cloudflare.
• Generované médiá sú verejné. Obrázky a videá doručené ako odkazy sú nahrané do verejných hostiteľov súborov Blossom, kde je adresou súboru jeho hash. Ktokoľvek s odkazom ho môže otvoriť a Nymbot ho nemôže znova stiahnuť. b64_json a vytvorený obrázok sa vráti v odpovedi a nikdy sa neuloží.
• To sú obrázky, ktoré dáte generátoru. Obrázok, na ktorý nahráte editovať, alebo poslať ako a data: URL v generátore image_url, je nahraný na verejný Blossom hostiteľa najprv tak, že generátor môže vyzdvihnúť, a to isté platí pre to. https:// Obrázky v žiadosti o chat idú na poskytovateľa modelu, nie na Blossom.
• Kľúč je pripojený k vášmu nym. Všetko, čo kľúč vynakladá, pochádza z rovnováhy vášho kľúča, takže použitie API nie je AnonymnýAk chcete, aby sa používanie API držalo oddelene od vašej každodennej nym, vytvorte kľúče z samostatnej nym s vlastnou rovnováhou.

Ak potrebujete ochranu aplikácií, použite aplikácie. API je určené, keď potrebujete modely vo vašich vlastných nástrojoch.

Každý koncový bod

“Nym” znamená požiadavku podpísanú vaším kľúčom Nostr, opísanú v Podpísanie žiadosti o účetPre nástroje, ktoré už tieto formáty hovoria, pozri Nástroje a SDK, a pre kódovanie agentov, ako je Claude Code, Codex a Cline, pozri Nástroje kódovania.