Tudásbázis / Fejlesztők

A tűz áttekintése

Az API az OpenAI és az Anthropic formátumokat használja, így a legtöbb eszköz és SDK az alap URL és a kulcs megváltoztatásával működik.

Ez az oldal a kényelem kedvéért gépi fordítással készült. Az eredeti angol nyelvű változat az érvényes.

Mi az a tűz

HTTP API használata nymbot.ai amely ugyanazokat a kéréseket válaszolja meg, amelyeket az OpenAI vagy az Anthropic kliens már elküld.

• Chat befejezésAz a Válasz Tűz és Antropológiai üzenetek, streaming, eszközök, képek, érvelés és webes keresés, minden modell a katalógus A Nymbot saját automatikus útválasztása.
• képek, videó, beszéd, transzkripció és Beágyazás.
• A te Egyensúly, Lámpás top-up, Automatikus top-up a pénztárcájából és a történelem Mennyibe kerül minden kérés?

Ugyanabból a kettőből fizetnek Egyensúly Nincs előfizetés és nincs ingyenes hozzájárulás az API-ra: minden kérést a megvásárolt kreditekből fizetnek.

Amit az API nem tesz, az a Nymbot saját üzeneteinek hozzáadása. Az üzeneteid a modellhez mennek, ahogy elküldted őket: nincs Nymbot rendszermegbízás, nincs memória, nincs dátum vagy nyelvi utalás.

Bázis URL

Minden végpont alatt él /api/v1/Ismeretlen út visszatér 404 és a rossz módszerrel elnevezett ismert út visszatér 405Mindkettő JSON.

Az API válaszol a kereszt eredetű kérésekre bármely webhelyről, így a böngésző oldala hívhatja. Bármi, amit egy böngészőbe küldesz, bárki elolvashatja, aki megnyitja, ezért csak olyan kulccsal végezze el, amely kis fejeA nymeddel aláírt végpontok (kulcsok, fiók összefoglaló, NWC auto-top-up és visszafizetési mentés) kivételt képeznek: egy böngészőben csak a Nymbot saját webhelyeire válaszolnak. Fiókkérelmek aláírása.

Küldjön minden JSON-testet Content-Type: application/jsonBármely más típus megtagadható 415, így egy egyszerű HTML-formátum vagy egy text/plain egy másik webhelyről érkező kérés nem érheti el az API-t. cURL-vel -H "Content-Type: application/json" Együtt a -d.

Tűz kulcsok

A kulcsok az alkalmazásban készülnek. megnyitva tűz a webalkalmazás oldalsávjában, vagy az Android és iOS menüben, és koppintson Hozzon létre kulcsotAdjon meg egy nevet, és ha tetszik, kaput és lejárati dátumot.

A kulcsot egyszer jeleníti meg. A lap bezárása előtt másold le biztonságos helyen: A Nymbot csak egy ujjlenyomatot tart meg róla, így nem mutathatja meg újra. Az elveszett kulcsot nem lehet visszaállítani; visszavonja, és hozzon létre egy másik.

A kulcs úgy néz ki, mint sk-nymbot- Ezt követi 43 betű, számjegy, táblázat és alpont. Az alkalmazás minden kulcsot a nevével és egy rövid utalással felsorolja, például: sk-nymbot-Qm7x…c2Lw.

• A kulcs az Ön nyoma. Kifizeti a mérleget, és csak a nym készítheti, módosíthatja vagy visszavonhatja azt. bárki, aki a kulcsot tartja, elköltheti vele, ezért kezelje úgy, mint egy jelszót.
• A tét a tét. A kulcsnak lehet kiadási korlátja, és a korlát minden nap, minden héten (hétfőn) vagy minden hónapban (első) 00:00 UTC-on állítható vissza. Mindkét egyenleget, egy standard hitelet 10 sats-ként és egy Pro-hitelet 100, így ugyanazt jelenti, bármilyen egyenleget költenek a kérelmek. 403 key_limit_reached, még akkor is, ha a válasz a kapu alatt jött volna; a hiba azt mondja, hogy mennyi maradt, és mikor állítja vissza a kaput. max_tokens A kérelmet azzal terhelik, amit valójában költenek, és ez a fedezet ellen számít, így ha a szolgáltató több tokent jelent, mint amennyit elhagytak, az utolsó kérés, amelyik illeszkedik, kissé meghaladhatja a fedezetet; a következőet elutasítják.
• A kihasznált tőke csak megállítja a kiadást. A fedélzeten lévő kulcs még mindig ellenőrizheti a mérleget, elolvashatja a történelmet, felsorolja a modelleket, számolja a tokeneket, felsorolja és ellenőrizheti egy videót, amelyet már elkezdett.
• Az Expiry opcionális. A beállított dátum után a kulcs leáll.
• A visszavonás azonnali és végleges. A visszavont kulcs elmulasztja a következő kérést. A listában marad, visszavont jelöléssel, így a kiadási előzménye még mindig értelme van.
• Legfeljebb 25 aktív kulccsal rendelkezhet, amelyek mindegyike saját nevet visel.

Ugyanez a lap mutatja az egyes kulcsok költségeit ebben az időszakban, és összesen, amikor utoljára használták, mind a mérlegeket, mind a legutóbbi API-kérelmeket. Kulcsok kezelése.

Kérés hitelesítése

Küldje el a kulcsot bármelyik fejlécben. Ezek egyenértékűek, ezért használja, amit az ügyfél alapértelmezés szerint küld:

Hiányzó, ismeretlen, visszavont vagy lejárt kulcsok 401A kóddal együtt missing_api_key, invalid_api_key, revoked_api_key vagy expired_api_keyA listázási modellek, hangmodellek és hangok, valamint a fizetési módok nem igényelnek kulcsot.

Képek, videók, beszédek, átiratok és beágyazások is fizethetők egy kérésre egy időben Lightning nélkül kulcsot egyáltalán: küldje el a kérést anélkül, és fizesse ki a számlát a 402 Válasz erre: Lásd Fizetés kulcs nélkül.

A kulcskezelés, a fiók összefoglalója és az automatikus felsőoktatás kivételek: a kulcs helyett a nym-től vesznek aláírást, így egy szivárgott kulcs nem hozhat létre több kulcsot. Fiókkérelmek aláírása.

Az első kérésed

Helyezze a kulcsot egy környezeti változóba, majd kérjen valamit egy modelltől. 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 a Nymbot saját útválasztása, a szabványos egyenlegből fizetve. helyezze el a katalógus modell azonosítóját, például anthropic/claude-sonnet-5, hogy használja ezt a modellt a Pro egyensúly. Modellek listázása minden egyes azonosítót.

Mennyibe kerül a kérelem

Az API pontosan úgy számláz, ahogy az alkalmazás teszi.

• Micsoda egyensúly nymbot/auto A kiadások szabvány egyensúly (10 sats a kredit). Minden más csevegési modell költi a A pro A szabványos képgenerátor és a szabványos hang standard krediteket költ; minden más generátor Pro-t költ. A beágyazott eszközök standard krediteket költenek. A transzkripció standard krediteket költenek, amikor a szabványos egyenleg fedezheti, és a Pro-kreditek egyébként.
• Mennyit is A csevegési kérelmet a modell által valójában olvasott és írt tokenekre mérik, a szolgáltató által közzétett árakon. Ez az ár 5% -os díjat tartalmaz, majd 1,5-szeresére szorozódik, így 1575-szeresét fizeted a szolgáltató listájának áráért. Ez az élő Bitcoin árára kerül átváltásra, és egy hitel ezredében kerül felszámításra. Pro képek, videók és beszédek generációonként, másodpercenként vagy karakterenként kerülnek árbevételre, és másodpercenként átírják az audio-t, ugyanazzal a díjjal és marginallal.
• Ez a minimum. Minden mérhető kérés, amely legalább 0,05 kredit költséget jelent: fél az alapértelmezett egyenlegre, 5 a Pro. A hitel töredékei átkerülnek, nem minden alkalommal kerekítik.
• Tartsa meg, majd állítsa be. Mielőtt egy kérés fut, a legtöbb költséget a mérlegedből tartod, attól függően, hogy mit küldtél és a legtöbb tokent írhat. Az egyszerű ASCII-n kívüli szöveget UTF-8 bájtjairól méretezik, és az ASCII-számok és a pontszámok egyenként tokenként számítanak, így bármely forgatókönyvben, kódban és számokban lévő szöveget teljes egészében tartják. A hold teljes kreditben van, legalább egy, így minden kérésnek legalább 10 ingyenes betétre van szüksége a standard mérlegre vagy 100 betétre a Pro-ra, hogy elinduljon. Csak a tényleges költséget számolják fel; a többit a befejezés után bocsátják ki. 402 insufficient_balance Ha a tényleges költség több, mint a mérleg fizethető, a teljes mérleget figyelembe veszik, a fennmaradó rész tartozik (owed_sats Ebben a nymbot objektum, és egy negatív egyenleg). Ami tartozik, először a következő kreditekből kerül kifizetésre, amelyek elérik ezt az egyenleget. Amíg nem kerül kifizetésre, semmit sem lehet költeni erre az egyenlegre: nem az API, nem válaszol az alkalmazásban, átutalás vagy ajándék.
• Nincs elég hitel. Ha a mérleg nem tudja fedezni a tartást, a kérelmet elutasítják 402 A hiba azt mondja, hogy melyik egyenleg rövid, hány tét szükséges a kéréshez és hány ingyenes. max_tokens Ez kisebb tartást jelent.
• A kudarcok. A kudarcot valló kérés nem kerül semmibe, hacsak a szolgáltató nem számlázta a kudarc előtt elvégzett munkát, vagy a webes keresést vagy a nymbot/auto A feladat ellenőrzése már futott; akkor ez az, amit fizetsz, legalább 0,05 kredit. Az általad levágott áramot a szolgáltató által jelentett tokenekért számolják fel: A Nymbot a szolgáltató áramát 25 másodpercig továbbra is elolvassa, miután elhagyja, hogy megkapja ezt a számot. Ha nem érkezik meg, a díjat megbecsülik attól, amit elküldtél és mit írtál, és egy ilyen okokból készült modellért, amely magában foglalja a tartás teljes kimeneti engedélyét.
• Web keresés 0,008 dollárba kerül egy keresés, amelyet sats-ra konvertálnak, amikor egy keresés fut, függetlenül attól, hogy a modell válaszol-e, vagy nem. Az olvasott oldalakat beviteli formában is elküldik a modellnek, így hozzáadják tokenjeiket.

Minden válasz megmondja, hogy mennyibe kerül. JSON válaszok hordoznak egy nymbot az objektum azzal a egyenleggel, amelyből kifizették, a hitelek és a részletek díját, és ami megmaradt:

A költség tárgy

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

A fizetett válaszok is hordozzák ezeket a fejléceket, ami az, ahol meg kell keresni a nem JSON válasz költségeit, például a beszédet:

Az árfolyamok millió token, már beleértve a díjat és a margin, a Modellek listája dollárban és dollárban, és Az árak listájaHa a Bitcoin ár nem olvasható, a fizetett kérések visszatérnek 503 price_unavailable Azokkal Retry-After: 60 A találgatás helyett.

hibák

Minden hiba ugyanazt a formát tartalmazza, amit az OpenAI ügyfelek már megértenek. code egy stabil név, amellyel egyezhet; message Az emberekért van, és megváltozhat.

Hiba test

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

Két kivétel:

• /api/v1/messages Válaszok az Anthropic hibaformátumában, mivel ez az, amit az Anthropic kliensek elemeznek: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}A típus követi a státuszt: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error vagy overloaded_error (503).
• Egy olyan streaming-kérelem, amely az első bájtja előtt kudarcot vall, rendes JSON hibaüzenetet kap a fenti állapotgal, nem pedig eseményáramlással.

A hibaüzenetek soha nem tartalmaznak egy másik szolgáltatás belső részleteit.

Korlátok

A képre mutató hivatkozásnak egy nyilvános tárhelyre kell mutatnia: a privát vagy helyi hálózaton, vagy a Nymbot saját webhelyein lévő címet elutasítják.

Mit láthat a tűz

Az API nem privát, ahogyan az alkalmazások vannak, és érdemes pontosan megmondani, hogyan.

• Nem végső soron titkosított. Az alkalmazásokban egy üzenet van lezárva a készüléken a kulcsok csak Nymbot tart és utazik, mint egy Ajándék WrapAz API-kérelem hétköznapi HTTPS: titkosítva van a Nymbot felé vezető úton, és a Nymbot kiszolgálója olvassa el a világosban, hogy kezelje azt.
• Az üzenetek és válaszok nem kerülnek tárolásra. Amit megtartanak, az a számla: minden kérés esetében az idő, a modell, a fajta, a token számok, a költségek, a mérleg, a kulcs, és ha sikerül, 90 napig, ez az, amit Kíváncsi történelem Ugyanazon kérés (idő, típus, modell, token szám, költség, időtartam, és hogy használta-e a webes keresést, vagy sikeres volt) használatának nyilvántartása 90 napig is megmarad, az alkalmazás sajátja mellett.
• Minden más, amit egy nym számára tartanak, kicsi és itt szerepel. Tűz kulcsok tárolják hashként, soha a kulcsot, nevükkel, rövid utalással, kiadási korlátokkal, visszaállítási idővel, lejáratukkal és mikor készültek és utoljára használták; csak a legújabb 50 visszavont kulcsot tartják meg. Automatikus top-up A pénztárca-kapcsolatot titkosítva tárolják, küszöbértékével, összegével és az utolsó felfüggesztés eredményével.A videó munkák 24 órán át tarthatók.A hívásonként fizetett kérelmek 7 napig csak egy Lightning fizetési hashet és 30 napig egy hashált visszatérítési tokent hagynak, amelyek nem kapcsolódnak semmilyen összeghez.A kiegyenlítésen kívüli díjak mindaddig fennmaradnak, amíg egy felfüggesztés nem fizet.
• Az app törlése eltávolítja. A Wipe készülék visszavonja és törli az összes API-kulcsot, és törli a lekérdezések előzményeit, a felhasználási rekordokat, a pénztárca-kapcsolatot és a videó munkákat.
• A modell szolgáltatója látja a kérésétA katalógusmodellek a gyártóiknál futnak; a szabványos útvonalak és beágyazások a Cloudflare-en futnak.
• A generált média nyilvános. A linkként szolgáltatott képek és videók feltöltődnek a nyilvános Blossom-fájl-tárhelyekre, ahol a fájl címe a hash. Bárki, akinek van a linkje, megnyithatja, és a Nymbot nem tudja újra letölteni. b64_json és egy létrehozott kép visszatér a válaszban, és soha nem tölthető fel.
• Így vannak a képek ad egy generátor. Egy kép, amit feltölthetsz Edit, vagy küldje el a data: URL egy generátorban image_url, először egy nyilvános Blossom hostra kerül feltöltésre, hogy a generátor visszaszerezze, és ugyanez vonatkozik rá. https:// A csevegési kérelemben szereplő képek a modell szolgáltatójához kerülnek, nem a Blossom-hoz.
• Egy kulcs kapcsolódik a nymhez. Minden, amit egy kulcs költi, a nym egyensúlyából származik, így az API használata nem anonimitásHa azt szeretné, hogy az API használata elkülönüljön a mindennapi nym-től, készítse el a kulcsokat egy külön nym-ből saját egyensúlyával.

Ha szüksége van az alkalmazások védelmére, használja az alkalmazásokat.Az API akkor használható, amikor a modelleket a saját eszközeiben kell használnia.

Minden végpont

“Nym” azt jelenti, hogy a kérelmet az Ön Nostr kulcsa írta alá, a Fiókkérelmek aláírásaAzokat az eszközöket, amelyek már beszélik ezeket a formátumokat, lásd: Eszközök és SDK, és kódoló ügynökök, mint például Claude Code, Codex és Cline, lásd Kódoló eszközök.