Wëssensbasis / Entwéckler

Gebuertsdag iwwerrascht

D'API spricht d'OpenAI an d'Anthropic Formater, sou datt déi meescht Tools a SDKs funktionnéieren duerch d'Ännerungen vun enger Basis-URL an engem Schlüssel.

Dës Säit ass Maschinn iwwersat fir Kamoudheet. Déi englesch Original ass d'Versioun déi gëlt.

Wat fir e Feuer?

HTTP API ass nymbot.ai Dat ass déi selwecht Recherche, déi e OpenAI oder Anthropic Client schon sendet.

• Chat completéiertDéi Reaktioun an Anthropesch Messagen, mat Streaming, Tools, Bilder, Argumentatioun a Websuche, fir all Modell am Kataloge Och fir Nymbot's eegen Auto-Routing.
• Fotografie, Videoen, Diskussioun, Transaktioun an Gebuertsdag.
• Är Balancéiert, Déi éischt Top-ups, Automatesch Top-ups aus Ärem Portemonnaie Et ass Historië Wat fir eng Recherche kostet.

Et gëtt aus den selwechten zwee Balancéiert Wéi d'App, zu de selwechten Preisen. Et gëtt keng Abonnement an keng gratis Kontributioun op der API: All Recherche gëtt aus de Krediten bezuelt.

Wat d'API net maachen ass, ass alles vun Nymbot's eegen. Är Messagen gi op de Modell wéi Dir se geschéckt hunn: keng Nymbot System-Prompt, keng Gedächtnis, keng Datum oder Sprachhinn.

Basis vun der URL

All Endpoint lebt ënner /api/v1/An engem onbekannten Wee gëtt et 404 Et handelt sech ëm zwéi Stären, déi no beienee leien. 405Déi aner wéi JSON.

D'API beantwéiert Cross-Origin-Befro vun all Site, sou datt eng Browser-Seite et anrufen kann. Alles, wat Dir an engem Browser sendet, kann vun all déi et öffnet liesen, also nëmmen mat engem Schlëssel, deen eng kleng Schlëssel huet. KapitelD'Endpunkter, déi mat Ärem Nymm ënnerschriwwen sinn (Schlëssel, Kontoerhebung, NWC Auto-Top-up an Remboursement-Erlösung) sinn déi Ausnahme: an engem Browser reagéieren se nëmmen op d'Nymbot-Properties. Kontrakt fir Kontoerklärungen.

Schreift all JSON-Körper mat Content-Type: application/jsonAll aner Typ gëtt verweigert 415, also eng einfacher HTML Form oder a text/plain D'Recherche vun enger aner Site kann d'API net erreechen. mat cURL, passéieren -H "Content-Type: application/json" Duerfir gëtt -d.

Feuer Schlëssel

Schlëssel sinn an der App gemaach. Feuer gëtt an der Sidebar vun der Web-App, oder am Menü op Android an iOS, an Gebuertsdag SchlësselGëtt et e Numm an, wann Dir wëllt, e Cap an e Verëffentlechungsdatum.

De Schlëssel gëtt eng Kéier gezeigt. Kopiere se an eng sécher Plaz, ier Dir de Bléck schloen: De Nymbot behält nëmmen e Fingerabdruck vun him, also kann et Iech net méi ze weisen.

De Schlëssel ass wéi sk-nymbot- D'App liest all Schlëssel mat sengem Numm an engem kurzen Hinweis wéi: sk-nymbot-Qm7x…c2Lw.

• Eng Schlëssel gehéieren zu Ärem Nym. Et verbraucht Är Saldo, an nëmmen Är Nym kann et maachen, änderen oder annuléieren. Jeder, deen de Schlëssel hält, kann mat et spannen, also behandelt et wéi e Passwort.
• De Caps ass am Satz. Eng Schlëssel kann eng Ausgabenkappe hunn, an d'Kappe kann all Dag, all Woch (Mondag) oder all Méindeg (der éischte) um 00:00 UTC reset. Et zählt zwee Saldoen, e Standardkredit als 10 sats an e Pro-Kredit als 100, sou datt et déi selwecht bedeit, wat de Saldo vun enger Recherche auswendet. 403 key_limit_reached, och wann d'Response ënner der Cap kommen hätt; de Fehler heescht wéi vill et ass a wann d'Cap reset. max_tokens Eng Recherche gëtt chargéiert, wat et tatsächlech kostet an dat géint d'Kap, also wann de Provider méi Token rapporteert wéi gesat waren, kann d'letzte Recherche, déi matgeet kann de Schlëssel e bësse iwwer d'Kap; déi nächst gëtt dann verweigert.
• Et ass net einfach ze spannen an ze spannen. Eng Schlëssel bei der Cap kann och de Saldo kontrolléieren, seng Geschicht liesen, Modeller listéieren, Token zählen, top up an e Video kontrolléieren datt et schon ugefaangen huet.
• Expiratioun ass optional. No dem Datum, deen Dir setzt, de Schlëssel funktionnéiert.
• D'Widerruff ass direkt a endgülteg. Et bleift an der Lëscht, markéiert annuléiert, sou datt d'Geschicht vun der Ausgaben nach sinn sinn sinn.
• Dir kënnt bis zu 25 aktive Schlëssel, all mat sengem eegene Numm hunn. Ännerungen d'Reset Period vun engem Schlëssel beginn eng nei Period mat null.

Déi selwecht Bléck weist den Ausgaben vun all de Schlëssel an dës Period an am Gesamt, wann et zuletzt benotzt gouf, souwuel Är Saldoen, an Är nei API-Bezéiungen. Gestioun vun de Schlëssel.

Authentifikatioun vun der Recherche

D'Sendung vum Schlëssel an een vun dësen Header. Si sinn ekvivalent, also benotzen wat de Client als Standard sendet:

Eng fehlend, onbekannt, annuléiert oder verëffentlecht Schlëssel Returns 401Mee de Code missing_api_key, invalid_api_key, revoked_api_key oder expired_api_keyListing Modeller, Audio Modeller a Stimmen, an Payment Methoden braucht keng Schlëssel.

Fotoen, Videoen, Sprach, Transkriptioun an Embeddings kënnen och fir eng Recherche zu engem Moment iwwer Lightning bezeechent ginn ohne Schlüssel überhaupt: senden d'Recherche ouni eng a bezuelen d'Rechnung am 402 Reaktioun : See Bezuelung op Bestellung ouni Schlëssel.

Key Management, d'Konto Zusammenfassung an automatesch Top-ups sinn déi Ausnahme: Si huelen eng Signatur vun Ärem Nym anstatt engem Schlëssel, sou datt e leaked Schlëssel net méi Schlëssel maachen kann. Kontrakt fir Kontoerklärungen.

Déi éischt Recherche

Plazéiert de Schlëssel an eng Ëmweltvariabel, dann bitt e Modell iets. 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 Et ass Nymbot's eegenen Routing, aus dem Standardgeld bezuelt. anthropic/claude-sonnet-5, fir dat Modell aus der Pro Balance ze benotzen. Modeller ze listéieren Et gëtt all Id.

Wat ass d'Käschte vun der Recherche

D'API fakturéiert genau wéi d'App maachen.

• Wat fir eng Balance. nymbot/auto Ausgaben an Normatioun Balance (10 sats a credit). All aner Chat Modell verbréngt den Pro Balance (100 Satz e Kredit). De Standard Image Generator an de Standard Voice verbréngen Standard Credits; all aner Generator verbréngt Pro. Embeddings verbréngen Standard Credits. Transcription verbréngt Standard Credits wann de Standard Balance kann et decken, an Pro Credits anescht.
• Wat fir wat. Eng Chat-Bezéiung gëtt op de Token matgeholl, déi de Modell tatsächlech liest an geschriwwen huet, bei den publizéiert Tariffer vum Provider. Dat Präis huet eng 5% Gebühr ugebueden an ass dann vun 1,5 multiplizéiert, sou datt Dir 1.575-fach den Lëschtpreis vum Provider bezuelt. Et ass zu Sats am Live Bitcoin Präis konvertéiert an an Tausendstel vun engem Kredit belastet. Pro-Bilder, Videoen a Sprach sinn pro Generatioun, pro Sekonn oder pro Charakter, an Transkriptioun pro Sekonn vun Audio, mat der selwechter Gebühr a Margin.
• De Minimum ass. All matgewiesselt Recherche, déi mindestens 0,05 Kredit lafen: déi Hälfte vun der Standardsaldo, 5 Sätze op Pro. Fraktiounen vun engem Kredit sinn iwwerbracht, net ronnéiert all Kéier.
• Et ass, dann setze mir op. Vläicht eng Recherche lafen, de meeschte kann et kosten ass aus Ärem Saldo gehalten, baséiert op wat Dir geschéckt huet an de meeschte Token et kann geschriwwen. Text ausserhalb vun der einfacher ASCII ass aus senger UTF-8 Byte, an ASCII Zäite an Punktuatioun zählen als e Token all, sou datt Text an all Skript, Code a Nummeren am Ganzen gehalten sinn. D'Halt ass an ganzer Credits, mindestens eent, sou datt all Recherche mindestens 10 Sats gratis op der Standard Balance oder 100 Sats op Pro braucht fir ze starten. 402 insufficient_balance D'Käschte fir d'Käschte fir d'Käschte fir d'Käschte fir d'Käschte fir d'Käschte fir d'Käschte fir d'Käschte (owed_sats an der nymbot Objet, an e negativen Saldo). Wat geschitt ass, gëtt éischt aus den nächsten Crediten bezuelen, déi dat Saldo erreechen. Bis et bezuelen ass, kann nichts op dësem Saldo ausgezeechent ginn: net vun der API, Antworten an der App, e Transfer oder e Geschenk.
• Et gëtt net genügend Kredit. Wann d'Bilanz den Halt net decken kann, gëtt d'Recherche verweigert 402 D'Fehler heescht, wat d'Balance kurz ass, wéi vill Sätze d'Bedreiwung braucht an wéi vill sinn gratis. max_tokens Et bedeit eng méi kleng Haltung.
• Et gëtt Failure. Eng Recherche, déi gescheitert ass, kostet net alles, ausser de Provider fir d'Arbeit fakturéiert huet, déi se viru gescheit huet, oder eng Websuche oder nymbot/auto D'Task-Check war schon ausgefouert; dann ass dat wat Dir bezuelt, mindestens 0,05 Kredit. E Stream, deen Dir geschnitzt huet, gëtt fir d'Token, déi de Provider meld: Nymbot liest den Provider-Stream bis zu 25 Sekonnen nach Dir verluer fir déi Zuel ze kréien.
• Websuche kostet $ 0,008 eng Suen, konvertéiert zu sats, wann eng Suen geännert gëtt, ob de Modell dann antwortet oder feelt.

All Reaktioun heescht wat et kostet. JSON Reactions carry a nymbot Objet mat dem Saldo, aus dem et ausgezeechent gouf, der Gebühr an Crediten an Sats, an wat verluer:

Objeten a Kosten

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

Payed Responses hunn och dës Header, déi d'Käschte vun enger Reaktioun, déi net JSON ass, wéi d'Sprach:

D'Raten pro Millioune Token, déi och d'Gebühr an d'Marge enthalen, sinn an der Modelllëscht an Dollar a Satz, an op De PräisheetWann de Bitcoin-Preis net liest kann, kommen déi bezuelten Recherchen zréck. 503 price_unavailable mat Retry-After: 60 Anstatt ze raten.

Fehler

All Fehler hunn déi selwecht Form, déi den OpenAI Clienten schon verstoen. code Et ass e stabilen Numm, op deen Dir matze kann; message Et ass fir d'Menschen an kann changéieren.

Fehler vum Kierper

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

Déi zwee Ausnahmen:

• /api/v1/messages Antworten am Fehlerformat vun Anthropic, well dat ass wat Anthropic Clienten parse: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}De Typ folgt de Status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error oder overloaded_error (503).
• Eng Streaming-Anruff, déi fehlschlägt, ier se de éischte Byte kritt, kritt e gewöhnlechen JSON-Fehler mat dem Status iwwer, an net e Event-Stream.

D'Fehlermeldungen enthalen nie interne Details vun engem anere Service. d'Fehler vun engem Provider gëtt geännert, ier se Iech erreecht.

Limitéiert

Eng Link op e Bild muss op e öffentlechen Host weisen: eng Adress op engem privaten oder lokalem Netzwierk, oder op Nymbot's eegenen Siten, gëtt verweigert.

Wat de Feuer kann gesinn

D'API ass net privat an der Art wéi d'Apps sinn, an et ass wert genau iwwer wéi.

• Et ass net end-to-end encrypted. An den Apps gëtt eng Message op Ärem Apparat versiegelt op Schlëssel nëmmen Nymbot hält an reist als Gesondheet WrapEng API-Beschreiwung ass normal HTTPS: Et gëtt op de Wee zu Nymbot verschlüsselt, an de Nymbot-Server liest et an der Clear fir se ze handelen.
• Prompten an Antworten ginn net gespeichert. Wat gëtt gehalen ass d'Rechnung: fir all Recherche d'Zäit, Modell, Typ, Token zählt, Kosten, Balance, Schlëssel an ob et gelangt ass, fir 90 Deeg, wat ass wat Historiesch Qualitéit Eng Gebrauchsrekord vun der selwechter Recherche (Zeit, Typ, Modell, Token Zuel, Kosten, Dauer an ob et Websuche benotzt oder erfollegräich ass) gëtt och fir 90 Deeg gehalten, zesumme mat der App.
• Alles anescht fir eng Nym gehalten ass kleng a hier listéiert. Feuer Schlëssel Si sinn als Hash gespeichert, nie de Schlëssel, mat hirem Numm, engem kurzen Hinweis, Ausgabenkap, Reset Period, Expiratioun an wann se gemaach goufen an zuletzt benotzt; nëmmen déi neisten 50 annullierte Schlëssel sinn gehalten. Automatesch Top-up D'Walletverbindung gëtt verschlüsselt, mat senger Schwéierpunkt, Betrag an de Resultat vun der lescht Top-up. Video Jobs sinn fir 24 Stonnen gehal. Bezuelen pro Call bezuelt nëmmen eng Lightning-Zahlungshash fir 7 Deeg an e Hashed-Remboursement Token fir 30 Deeg, gekoppelt op keng Nimm.
• D'Applikatioun vun der App gëtt eliminéiert. A Gebuertsdag Wipe Annuléiert a löscht all API-Schlëssel, an löscht d'Vëlohistorik, d'Nutzungsprotokoll, d'Walletverbindung an d'Video Jobs.
• Den Provider vum Modell kann Är Recherche gesinnKatalog Modeller lafen bei hirem Maker; Standard Routen a Embeddings lafen op Cloudflare.
• Generéiert Medien sinn öffentlech. D'Bilder a Videoen, déi als Links gelieft ginn, ginn op öffentlech Blossom-Dateienhosts uploaden, wou d'Adresse vun enger Datei d'Hash ass. b64_json An eng generéiert Bild kënnt an der Reaktioun zréck an gëtt nie uploaden.
• Also sinn d'Bilder déi Dir e Generator huet. Et ass eng Foto déi Dir uploads EditiounOder schreift als data: URL an engem Generator image_url, ass op eng öffentlech Blossom Host éischt uploadéiert, sou datt de Generator kann et kréien, an dat selwecht gilt fir et. https:// D'Bilder an enger Chat-Anforderung gaangen dem Provider vum Modell, net zu Blossom.
• Eng Schlëssel ass mat Ärem Nym verbunden. Alles, wat e Schlëssel verbréngt, kënnt aus de Balance vum Nym, also ass d'API-Nutzung net AnonymitéitWann Dir d'API-Nutzung vun Ärem alldagleche Nymme getrennt wëllt, maachen d'Schlëssel aus engem separaten Nymme mat senger eigener Balance.

Wann Dir d'Schutz vun den Apps braucht, benotzen Dir d'Apps. D'API ass fir wann Dir d'Modeller an Ärem eegene Tools braucht.

All Endpunkt

“Nym” heescht eng Recherche, déi mat Ärem Nostr-Schlüssel ënnerschriwwen ass, déi an der Kontrakt fir KontoerklärungenFir Tools, déi och dës Formate sprechen, kuckt Tools an SDKs, an fir Coding Agenten wéi Claude Code, Codex an Cline, kuckt Tools ze codéieren.