Wissensdatenbank / Entwickler

API Übersicht

Die Modelle, Generatoren und Balance, die Sie in der App verwenden, stammen aus Ihrem eigenen Code.Die API spricht die OpenAI- und Anthropic-Formate, so dass die meisten Tools und SDKs durch das Ändern einer Basis-URL und eines Schlüssels funktionieren.

Diese Seite wurde der Einfachheit halber maschinell übersetzt. Es gilt das englische Original.

Was das Feuer ist

Eine HTTP API ist nymbot.ai die die gleichen Anfragen beantwortet, die ein OpenAI- oder Anthropic-Client bereits sendet.

• Chat Vollendungen, die Antwort Feuer Und Anthropische Botschaften, mit Streaming, Tools, Bildern, Argumentation und Web-Suche, für jedes Modell in der Kataloge und für Nymbots eigenes Auto-Routing.
• Bilder, Das Video, Die Rede, Transkription Und Einbettungen.
• Dein Gleichgewicht, Über Lightning Top-Ups, Automatische Top-ups aus Ihrer Brieftasche und a Geschichte Was jede Anfrage kostet.

Sie werden aus den gleichen zwei Gleichgewicht Es gibt kein Abonnement und keine kostenlose Zulassung auf der API: Jede Anfrage wird aus den von Ihnen gekauften Credits bezahlt.

Was die API nicht tut, ist, etwas von Nymbots eigenem hinzuzufügen. Ihre Nachrichten gehen zum Modell, während Sie sie gesendet haben: keine Nymbot-Systemanrufe, kein Speicher, keine Datum- oder Sprachhinweise.

Basis URLs

Jeder Endpunkt lebt unter /api/v1/Der unbekannte Weg kehrt zurück 404 und ein bekannter Weg, der mit der falschen Methode genannt wird, kehrt zurück 405Beide sind JSON.

Die API antwortet auf Kreuz-Origin-Anfragen von jeder Website, so dass eine Browser-Seite es anrufen kann. Alles, was Sie an einen Browser senden, kann jedoch von jedem gelesen werden, der es öffnet, also tun Sie dies nur mit einem Schlüssel, der eine kleine KopfDie Endpunkte, die mit Ihrem Nymm unterzeichnet wurden (Schlüssel, Kontoübersicht, NWC-Auto-Top-up und Rückerstattung) sind die Ausnahme: In einem Browser antworten sie nur auf Nymbots eigene Websites. Kontoanfragen unterschreiben.

Senden Sie jeden JSON-Körper mit Content-Type: application/jsonJeder andere Typ wird abgelehnt 415, also eine einfache HTML-Form oder eine text/plain Anfrage von einer anderen Website kann die API nicht erreichen. mit cURL, pass -H "Content-Type: application/json" Zusammen mit -d.

Feuer Schlüssel

Schlüssel werden in der App erstellt. öffnen Feuer in der Seitenleiste der Web-App oder im Menü auf Android und iOS, und tippen Sie Schlüssel erstellenGeben Sie ihm einen Namen und, wenn Sie möchten, eine Kappe und ein Ablaufdatum.

Der Schlüssel wird einmal angezeigt. Kopieren Sie ihn an einen sicheren Ort, bevor Sie das Blatt schließen: Nymbot behält nur einen Fingerabdruck davon, so dass er es Ihnen nicht wieder zeigen kann. Ein verlorener Schlüssel kann nicht wiederhergestellt werden.

Ein Schlüssel sieht aus wie sk-nymbot- gefolgt von 43 Buchstaben, Ziffern, Dashs und Unterpunkten. Die App listet jeden Schlüssel nach seinem Namen und einem kurzen Hinweis wie sk-nymbot-Qm7x…c2Lw.

• Ein Schlüssel gehört zu deinem Nym. Es verschwendet Ihr Gleichgewicht, und nur Ihr Nim kann es erstellen, ändern oder widerrufen.Jeder, der den Schlüssel hält, kann mit ihm verbringen, also behandle es wie ein Passwort.
• Caps sind im Satz. Ein Schlüssel kann eine Ausgabekapazität haben, und die Kapazität kann jeden Tag, jede Woche (Monday) oder jeden Monat (der erste) um 00:00 UTC wieder eingestellt werden. Es zählt beide Salden, ein Standardkredit als 10 Sats und ein Pro-Kredit als 100, so dass es das gleiche bedeutet, was auch immer das Saldo einer Anfrage ausgegeben wird. 403 key_limit_reached, auch wenn die Antwort unter der Kappe gekommen wäre; der Fehler sagt, wie viel übrig ist und wann die Kappe zurückgesetzt wird. max_tokens Eine Anfrage wird berechnet, was sie tatsächlich kostet und das zählt gegen die Kappe, also wenn der Anbieter mehr Token meldet, als sie beiseite gesetzt wurden, kann die letzte Anfrage, die passt, den Schlüssel ein wenig über seine Kappe nehmen; der nächste wird dann abgelehnt.
• Eine ausgegebene Kappe stoppt nur die Ausgaben. Ein Schlüssel an seiner Kappe kann immer noch das Gleichgewicht überprüfen, seine Geschichte lesen, Modelle auflisten, Token zählen, hochladen und ein Video überprüfen, das es bereits begonnen hat.
• Expiry ist optional. Nach dem Datum, das Sie festgelegt haben, hört der Schlüssel auf zu arbeiten.
• Der Widerruf ist unmittelbar und endgültig. Ein widerrufener Schlüssel verliert seine nächste Anfrage. er bleibt in der Liste, markiert mit widerrufen, so dass seine Ausgabenverlauf noch sinnvoll ist.
• Sie können bis zu 25 aktive Schlüssel haben, die jeweils ihren eigenen Namen haben. Wenn Sie die Wiederherstellungsperiode eines Schlüssels ändern, beginnt eine neue Periode bei Null.

Das gleiche Blatt zeigt die Ausgaben jedes Schlüssels in diesem Zeitraum und insgesamt, wenn es zuletzt verwendet wurde, sowohl Ihre Salden als auch Ihre jüngsten API-Anfragen. Verwaltung von Schlüsseln.

Authentifizierung einer Anfrage

Senden Sie den Schlüssel in einer dieser Überschriften. Sie sind gleichwertig, verwenden Sie also, was Ihr Client standardmäßig sendet:

Eine fehlende, unbekannte, widerrufe oder abgelaufene Schlüsselrückgabe 401Mit dem Code missing_api_key, invalid_api_key, revoked_api_key oder expired_api_keyDie Auflistung von Modellen, Audiomodellen und Stimmen sowie Zahlungsmethoden benötigt keinen Schlüssel.

Bilder, Video, Sprache, Transkription und Embeddings können auch für eine Anfrage gleichzeitig über Lightning ohne Schlüssel bezahlt werden: Senden Sie die Anfrage ohne eine und bezahlen Sie die Rechnung in der 402 Antwort: Siehe Bezahlung auf Anfrage ohne Schlüssel.

Schlüsselverwaltung, Kontoübersicht und automatische Top-ups sind die Ausnahme: Sie nehmen eine Signatur von Ihrem Nym statt eines Schlüssels, so dass ein gelöschter Schlüssel nicht mehr Schlüssel machen kann. Kontoanfragen unterschreiben.

Ihre erste Anfrage

Legen Sie den Schlüssel in eine Umgebungsvariable, dann fragen Sie ein Modell etwas. 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 ist Nymbots eigenes Routing, bezahlt aus dem Standardguthaben. anthropic/claude-sonnet-5, um dieses Modell aus dem Pro-Balance zu verwenden. Liste der Modelle Sie geben jede ID an.

Was kostet ein Antrag

Die API berechnet genau so, wie die App es tut.

• Was für ein Gleichgewicht. nymbot/auto Verbringen Sie die Der Standard Balance (10 Sats a Credit). Jedes andere Chat-Modell für Der Standardbildgenerator und die Standardsprache verbringen Standardkredite; jeder andere Generator verbringt Pro. Embeddings verbringen Standardkredite. Transcription verbringt Standardkredite, wenn das Standardguthaben es abdecken kann, und Pro-Kredite andernfalls.
• Wie viel . Eine Chat-Anfrage wird auf die Token gemessen, die das Modell tatsächlich gelesen und geschrieben hat, zu den veröffentlichten Preisen des Anbieters. Dieser Preis hat eine Gebühr von 5% hinzugefügt und wird dann um 1,5 multipliziert, so dass Sie 1.575-mal den Listenpreis des Anbieters bezahlen. Es wird in den Live-Bitcoin-Preis umgewandelt und in Tausendstel eines Kredits berechnet. Pro Bilder, Video und Sprache werden pro Generation, pro Sekunde oder pro Zeichen und Transkription pro Sekunde von Audio, mit der gleichen Gebühr und Marge. Das Standardbild ist ein Flach 5 Standard-Credits und die Standard-Stimme ein Flach 3.
• Das Minimum . Jede gemessene Anfrage, die mindestens 0,05 Credits kostet: eine Hälfte auf dem Standardguthaben, 5 Sätze auf Pro. Fraktionen eines Credits werden übernommen, nicht jedes Mal abgerundet.
• Halte, dann setze dich ein. Bevor eine Anfrage läuft, wird das meiste, was sie kosten könnte, aus Ihrem Saldo gehalten, basierend auf dem, was Sie gesendet haben und den meisten Token, die sie schreiben können. Text außerhalb des einfachen ASCII wird von seinen UTF-8-Bytes geformt, und ASCII-Zahlen und Punktion zählen als jedes Token, so dass Text in jedem Skript, Code und Zahlen vollständig gehalten werden. Der Halt ist in ganzen Credits, mindestens eins, so dass jede Anfrage mindestens 10 Sätze kostenlos auf dem Standard-Guthaben oder 100 Sätze auf Pro benötigt, um zu starten. Nur die tatsächlichen Kosten werden berechnet; der Rest wird freigegeben, wenn er endet. Eine lange Anfrage behält ihre Haltbarkeit, solange sie läuft; wenn die gehaltenen Credits auf jeden 402 insufficient_balance Wenn die tatsächlichen Kosten höher sind als das Gleichgewicht bezahlen kann, wird das gesamte Gleichgewicht genommen, der Rest ist verschuldet (owed_sats In der nymbot Objekt, und ein negatives Gleichgewicht). Was geschuldet wird, wird zuerst aus den nächsten Credits gezahlt, die dieses Gleichgewicht erreichen. Bis es bezahlt wird, kann nichts auf diesem Gleichgewicht ausgegeben werden: nicht durch die API, antwortet in der App, eine Übertragung oder ein Geschenk.
• Nicht genügend Kredit. Wenn das Guthaben die Haltung nicht decken kann, wird der Antrag mit 402 Der Fehler sagt, welches Gleichgewicht kurz ist, wie viele Sätze die Anfrage benötigt und wie viele frei sind. max_tokens Eine kleinere Haltbarkeit bedeutet.
• Die Misserfolge. Eine fehlgeschlagene Anfrage kostet nichts, es sei denn, der Anbieter hat für die Arbeit berechnet, die er vor dem Scheitern getan hat, oder eine Websuche oder die nymbot/auto Ein Stream, den Sie abschneiden, wird für die Token berechnet, die der Anbieter berichtet: Nymbot liest den Stream des Anbieters bis zu 25 Sekunden nach dem Verlassen, um diese Zählung zu erhalten.
• WEB Suche kostet $ 0,008 eine Suche, umgewandelt in Sats, wann immer eine Suche ausgeführt wurde, ob das Modell dann antwortet oder fehlschlägt.

Jede Antwort sagt, was sie kostet. JSON-Antworten tragen eine nymbot Gegenstand mit dem Saldo, aus dem es gezahlt wurde, die Gebühr in Credits und Sats, und was bleibt:

Das Kostenobjekt

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

Bezahlte Antworten tragen auch diese Überschriften, wo Sie nach der Kosten einer Antwort suchen, die nicht JSON ist, wie z. B. Sprache:

Preise pro Million Token, bereits einschließlich der Gebühr und der Marge, sind in der Modellliste in Dollar und Satz, und auf Das PreisschildWenn der Bitcoin-Preis nicht gelesen werden kann, werden bezahlte Anfragen zurückgegeben 503 price_unavailable mit Retry-After: 60 Anstatt zu erraten.

Fehler

Jeder Fehler hat die gleiche Form, die OpenAI-Clients bereits verstehen. code ist ein stabiler Name, mit dem Sie übereinstimmen können; message Es ist für Menschen und kann sich ändern.

Körperfehler

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

Zwei Ausnahmen :

• /api/v1/messages Antworten im Fehlerformat von Anthropic, da dies das ist, was Anthropic-Clients analysieren: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Der Typ folgt dem 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).
• Eine Streaminganfrage, die vor ihrem ersten Byte fehlschlägt, erhält einen normalen JSON-Fehler mit dem Status oben, nicht einen Ereignisstrom.

Fehlermeldungen enthalten niemals interne Details eines anderen Dienstes.Ein eigener Fehler eines Anbieters wird neu formuliert, bevor er Sie erreicht.

Grenzen

Ein Link zu einem Bild muss auf einen öffentlichen Host hinweisen: Eine Adresse in einem privaten oder lokalen Netzwerk oder auf den eigenen Websites von Nymbot wird abgelehnt.

Was das Feuer sehen kann

Die API ist nicht privat, wie die Apps sind, und es lohnt sich, genau zu sein, wie.

• Es ist nicht end-to-end verschlüsselt. In den Apps wird eine Nachricht auf Ihrem Gerät auf Schlüssel versiegelt, die nur Nymbot hält und als Geschenk WrapEine API-Anfrage ist gewöhnlich HTTPS: Sie wird auf dem Weg zu Nymbot verschlüsselt und der Server von Nymbot liest sie im Klartext, um sie zu behandeln.
• Prompts und Antworten werden nicht gespeichert. Was gehalten wird, ist die Rechnung: für jede Anfrage die Zeit, Modell, Art, Token zählt, Kosten, Gleichgewicht, Schlüssel und ob es gelungen ist, für 90 Tage, das ist, was Wünsche Geschichte Eine Nutzungsdatenbank derselben Anfrage (Zeit, Art, Modell, Token-Zählung, Kosten, Dauer und ob sie eine Websuche benutzt hat oder erfolgreich war) wird neben der eigenen Anwendung auch 90 Tage lang aufbewahrt.
• Alles andere, was für einen Nym gehalten wird, ist klein und hier aufgeführt. Feuer Schlüssel werden als Hash gespeichert, niemals den Schlüssel, mit ihrem Namen, einem kurzen Hinweis, Ausgabenkappe, Wiederherstellungsperiode, Ablauf und wann sie gemacht wurden und zuletzt verwendet wurden; nur die neuesten 50 widerrufenen Schlüssel werden beibehalten. Automatischer Top-Up Die Portemonnaie-Verbindung wird verschlüsselt gespeichert, mit der Schwelle, dem Betrag und dem Ergebnis des letzten Top-up. Video-Jobs werden für 24 Stunden gehalten. Zahlungsanfragen pro Anruf hinterlassen nur einen Lightning-Zahlungshash für 7 Tage und einen Hashed-Rückerstattungstoken für 30 Tage, verbunden mit keinem Nimm. Gebühren, die ein Gleichgewicht nicht decken konnte, werden wie verschuldet gehalten, bis ein Top-up sie zahlt.
• Das Löschen der App löscht sie. A Gerät WIPE widerruft und löscht jeden API-Schlüssel und löscht die Abfrageverlauf, Nutzungsdatenblätter, Brieftaschenverbindung und Videoaufträge.
• Der Anbieter des Modells sieht Ihre AnfrageKatalog-Modelle laufen bei ihren Herstellern; Standardrouten und Embeddings laufen auf Cloudflare.
• Generierte Medien sind öffentlich. Bilder und Videos, die als Links geliefert werden, werden auf öffentliche Blossom-Dateihosts hochgeladen, wo die Adresse einer Datei ihr Hash ist. Jeder mit dem Link kann sie öffnen und Nymbot kann sie nicht wieder herunterladen. b64_json und ein generiertes Bild kommt in der Antwort zurück und wird nie hochgeladen.
• So sind die Bilder, die Sie einem Generator geben. Ein Bild, das Sie hochladen Editoder senden Sie als a data: URL in einem Generator image_url, wird zuerst auf einen öffentlichen Blossom-Host hochgeladen, damit der Generator es abrufen kann, und das Gleiche gilt für es. https:// Bilder in einer Chat-Anfrage gehen an den Anbieter des Modells, nicht an Blossom.
• Ein Schlüssel ist mit Ihrem Nym verbunden. Alles, was ein Schlüssel ausgibt, kommt aus der Bilanz Ihres Nyms, so dass die API-Nutzung nicht AnonymeWenn Sie möchten, dass die API-Nutzung von Ihrem alltäglichen Nimm getrennt bleibt, erstellen Sie die Schlüssel aus einem separaten Nimm mit eigener Balance.

Wenn Sie den Schutz der Apps benötigen, verwenden Sie die Apps.Die API ist für den Fall geeignet, dass Sie die Modelle in Ihren eigenen Tools benötigen.

Jeder Endpunkt

“Nym” bedeutet eine Anfrage, die von Ihrem Nostr-Schlüssel unterzeichnet wurde, die in Kontoanfragen unterschreibenFür Tools, die diese Formate bereits sprechen, siehe Tools und SDKs, und für Codierungsagenten wie Claude Code, Codex und Cline, siehe Codierungswerkzeuge.