Tietopohja / Kehittäjät

Palon yleiskatsaus

Mallit, generaattorit ja tasapainot, joita käytät sovelluksessa, omasta koodistasi. API puhuu OpenAI- ja Anthropic-muodoista, joten useimmat työkalut ja SDK:t toimivat muuttamalla perus-URL:ää ja avainta.

Tämä sivu on käännetty koneella käyttömukavuuden vuoksi. Englanninkielinen alkuperäinen versio on voimassa.

Mikä on API

HTTP API on käytössä nymbot.ai joka vastaa samoihin pyyntöihin, joita OpenAI- tai Anthropic-asiakas jo lähettää.

• Chat täydentääSe on Vastaukset API ja Antrooppiset viestit, suoratoisto, työkalut, kuvat, päättely ja web-haku, jokaiselle mallille Luettelo ja Nymbotin omasta automaattisesta reitityksestä.
• Kuvia, Videoita, puheesta, transkriptio ja Sisäänrakennukset.
• Sinun tasapainoon, Valoisa top-up, Automaattinen top-up lompakostasi ja a historiaa Mitä kukin pyyntö maksaa?

Se on maksettu samoista kahdesta tasapainoja Ei ole tilausta eikä ilmaista käyttöoikeutta API:lle: jokainen pyyntö maksetaan ostamistasi hyvityksistä.

Mitä API ei tee, on lisätä mitään Nymbotin omia viestejä. Viestit menevät malliin, kun lähetät ne: ei Nymbot-järjestelmähuomautusta, ei muistia, ei päivämäärää tai kielen vihjeitä.

Perus URL

Jokainen päätepiste elää /api/v1/Tuntematon polku palaa 404 ja tunnettu polku, jota kutsutaan väärällä menetelmällä, palaa 405Sekä JSON että JSON

API vastaa ristikkäisiin pyyntöihin mistä tahansa sivustosta, joten selaimen sivu voi soittaa siihen.Kaikki, mitä lähetät selaimeen, voi lukea kuka tahansa, joka avaa sen, joten tee se vain avaimella, jolla on pieni pääSinun nimelläsi allekirjoitetut päätepisteet (avaimet, tilin yhteenveto, NWC:n automaattinen ylittäminen ja hyvityksen lunastaminen) ovat poikkeus: selaimessa ne vastaavat vain Nymbotin omille sivustoille. Tilin allekirjoittamista koskevat pyynnöt.

Lähetä jokainen JSON-keho Content-Type: application/jsonMikä tahansa muu tyyppi on kielletty 415, joten yksinkertainen HTML-muoto tai a text/plain Pyyntö toiselta sivustolta ei pääse API:hen. -H "Content-Type: application/json" Yhdessä -d.

Tulipalo avaimet

Avaimet tehdään sovelluksessa.Open Paloa web-sovelluksen sivupalkissa tai Android- ja iOS-valikossa ja napauta Luo avainAnna sille nimi ja, jos haluat, kynä ja voimassaoloaika.

Avain näytetään kerran. Kopioi se jonnekin turvalliseen paikkaan ennen kuin suljet arkin: Nymbot säilyttää vain sormenjäljen siitä, joten se ei voi näyttää sitä sinulle uudelleen.

Avaimet näyttävät sk-nymbot- sen jälkeen 43 kirjainta, numeroa, taulukkoa ja alaviitteitä. Sovellus luettelee jokaisen avaimen nimen ja lyhyen vihjeen mukaan, kuten sk-nymbot-Qm7x…c2Lw.

• Avain kuuluu nimellesi. Se käyttää saldoasi, ja vain nimesi voi tehdä, muuttaa tai peruuttaa sen.
• Kappaleet ovat panostuksessa. Avaimella voi olla kulujen enimmäismäärä, ja enimmäismäärä voidaan asettaa uudelleen joka päivä, joka viikko (maanantai) tai joka kuukausi (ensimmäinen), klo 00:00 UTC. Se laskee molemmat saldot, vakio luotto 10 satsina ja Pro luotto 100, joten se tarkoittaa samaa riippumatta siitä, mihin saldo pyyntö kuluu. Ennen pyynnön suorittamista enimmäismäärä, jonka se voisi maksaa (yhdistettynä kokonaisiin hyvityksiin), asetetaan siihen, mikä on jäljellä capista. 403 key_limit_reached, vaikka vastaus olisi tullut capin alle; virhe kertoo, kuinka paljon on jäljellä ja milloin cap palauttaa. max_tokens Pyyntö veloitetaan siitä, mitä se todella maksaa ja joka laskee capia vastaan, joten jos palveluntarjoaja raportoi enemmän tokeneja kuin ne asetettiin syrjään, viimeinen pyyntö, joka sopii, voi ottaa avaimen hieman sen capin ohi; seuraava hylätään.
• Käytetty kappale pysäyttää vain kulutuksen. Avain päällään voi silti tarkistaa saldon, lukea sen historian, luetella malleja, laskea tokeneja, ylittää ja tarkistaa videon, jonka se on jo aloittanut.
• Expiry on valinnainen. Kun olet asettanut päivämäärän, avain lakkaa toimimasta.
• Peruuttaminen on välitöntä ja lopullista. Peruutettu avain epäonnistuu seuraavassa pyynnössä.Se pysyy luettelossa, merkitty peruutettu, joten sen menohistorialla on silti järkeä.
• Sinulla voi olla enintään 25 aktiivista avainta, joista jokaisella on oma nimensä. Avaimen palautusjakson muuttaminen aloittaa uuden jakson nollasta.

Sama arkki näyttää kunkin avaimen käytön tänä aikana ja kokonaisuudessaan, kun sitä viimeksi käytettiin, sekä saldot että äskettäiset API-pyynnöt. Avainten hallinta.

Pyynnön todentaminen

Lähetä avain mihin tahansa näistä otsikoista. Ne ovat vastaavia, joten käytä mitä tahansa asiakas lähettää oletusarvoisesti:

Puuttuva, tuntematon, peruutettu tai vanhentunut avainpalautus 401ja koodin kanssa missing_api_key, invalid_api_key, revoked_api_key tai expired_api_keyLuettelo malleista, äänimalleista ja äänistä sekä maksutavoista ei tarvitse avainta.

Kuvat, videot, puheet, transkriptiot ja upotukset voidaan myös maksaa yhdestä pyynnöstä kerrallaan Lightningin kautta ilman avainta ollenkaan: lähetä pyyntö ilman yhtä ja maksa lasku 402 Vastaus : Katso Maksaminen pyynnöstä ilman avainta.

Avainten hallinta, tilin yhteenveto ja automaattiset ylätilat ovat poikkeuksia: ne ottavat allekirjoituksen nimeltä avaimen sijasta, joten vuotettu avain ei voi tehdä lisää avaimia. Tilin allekirjoittamista koskevat pyynnöt.

Ensimmäinen pyyntösi

Laita avain ympäristömuuttujaan ja kysy sitten mallilta jotain. 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 on Nymbotin oma reititys, joka maksetaan tavanomaisesta saldosta. Aseta sen sijaan luettelon mallin ID, kuten anthropic/claude-sonnet-5, käyttää tätä mallia Pro tasapainosta. Luettelo malleista Antaa jokaiselle henkilöllisyyden.

Mitä pyyntö maksaa

API laskee täsmälleen samalla tavalla kuin sovellus.

• Mikä tasapaino nymbot/auto Käytä sitä standardiin tasapaino (10 sats a credit). Jokainen muu chat-malli käyttää Pro puolesta tasapaino (100 sats a credit). Standardi kuvan generaattori ja standardi ääni viettää standardi luottoja; jokainen toinen generaattori viettää Pro. Sisäänrakennukset viettää standardi luottoja. Transcription viettää standardi luottoja, kun standardi tasapaino voi kattaa sen, ja Pro luottoja muuten. Mallien luettelo kertoo, mitä tasapaino kunkin mallin viettää.
• Kuinka paljon Chat-pyyntö mitataan malliin, jonka malli on itse lukenut ja kirjoittanut, palveluntarjoajan julkaisemilla hinnoilla. Tällä hinnalla on 5% lisämaksu ja se kerrotaan sitten 1,5, joten maksat 1,575 kertaa palveluntarjoajan luettelon hinnasta. Se muunnetaan live-Bitcoin-hintaan ja veloitetaan tuhansina luottoina. Pro-kuvat, videot ja puheet hinnoitellaan sukupolvea kohti, sekuntia kohti tai merkkiä kohti, ja äänen transkriptio sekuntia kohti, samoilla maksuilla ja marginaaleilla. Standardi kuva on tasainen 5 standardikreditiä ja standardi ääni on tasainen 3.
• ja vähimmäismäärä. Jokainen mitattu pyyntö, joka kulkee, maksaa vähintään 0,05 luottoa: puolet istui vakiotaseen, 5 satsia Pro. Luoton murto-osat kuljetetaan yli, ei pyöristetty joka kerta.
• Pidä kiinni ja aseta sitten. Ennen kuin pyyntö käynnistyy, suurin osa siitä, mitä se voi maksaa, pidetään saldostasi sen perusteella, mitä olet lähettänyt ja eniten tokeneja se voi kirjoittaa. Teksti, joka on tavallisen ASCII: n ulkopuolella, on mitoitettu sen UTF-8-byteistä, ja ASCII-numerot ja pisteytys lasketaan tunnisteina, joten minkä tahansa käsikirjoituksen, koodin ja numeroiden tekstiä pidetään täysimääräisesti. Pidätys on kokonaisia hyvityksiä, vähintään yksi, joten jokainen pyyntö tarvitsee vähintään 10 ilmaiskierrosta tavallisella saldolla tai 100 ilmaiskierrosta Pro: lla aloittaakseen. Vain todelliset kustannukset veloitetaan; loput vapautetaan, kun se päättyy. Pitkä pyyntö säilyttää 402 insufficient_balance Mikäli lasku on suurempi kuin tasapaino voi maksaa, koko tasapaino otetaan, loput veloitetaan (owed_sats Niissä nymbot objekti, ja negatiivinen saldo). Mikä on velkaa maksetaan ensin seuraavista hyvityksistä, jotka saavuttavat tämän tasapainon. Kunnes se on maksettu, mitään tälle saldolle ei voida käyttää: ei API: n, sovelluksen vastaukset, siirto tai lahja.
• Ei riittävästi luottoa. Jos saldo ei pysty kattamaan hallussapitoa, pyyntö hylätään 402 Virhe kertoo, mikä tasapaino on lyhyt, kuinka monta satsia pyyntö tarvitsee ja kuinka monta on ilmaista. max_tokens Se tarkoittaa pienempää pidättelyä.
• ja epäonnistumisia. Epäonnistunut pyyntö ei maksa mitään, ellei palveluntarjoaja ole laskuttanut työstä, jonka se teki ennen epäonnistumista, tai web-haku tai nymbot/auto Tehtävän tarkistus oli jo käynnissä; sitten se on mitä maksat, vähintään 0,05 luottoa. Leikkaamasi virta veloitetaan palveluntarjoajan raportoimista tokeneista: Nymbot lukee palveluntarjoajan virtaa jopa 25 sekunnin ajan sen jälkeen, kun lähdet saadaksesi tämän laskun.
• WEB etsintä maksaa $ 0,008 haku, muunnettu sats, aina kun haku suoritettiin, onko malli sitten vastaa tai epäonnistuu.

Jokainen vastaus kertoo, kuinka paljon se maksaa. JSON-vastaukset nymbot kohde, josta se on maksettu, veloitus luottoina ja satsina, ja mikä on jäljellä:

Objektiivin kustannukset

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

Maksullisissa vastauksissa on myös nämä otsikot, jolloin etsitään sellaisen vastauksen kustannuksia, joka ei ole JSON, kuten puhe:

Miljoonan tokenin hinnat, jo mukaan lukien maksu ja marginaali, ovat Malliluettelo Yhdysvaltain dollareissa ja satsissa HintaluetteloJos Bitcoin-hintaa ei voi lukea, maksetut pyynnöt palautetaan 503 price_unavailable kanssa Retry-After: 60 Sen sijaan että arvailisi.

virheitä

Jokaisella virheellä on sama muoto, jonka OpenAI-asiakkaat jo ymmärtävät. code on vakaa nimi, johon voit sopia; message Se on ihmisille ja voi muuttua.

Virheellinen keho

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

Kaksi poikkeusta on:

• /api/v1/messages vastaukset Anthropicin virhemuodossa, koska tämä on mitä Anthropic-asiakkaat selvittävät: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Tyyppi seuraa tilaa: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error tai overloaded_error (503).
• Streaming-pyyntö, joka epäonnistuu ennen ensimmäistä merkkiä, saa tavallisen JSON-virheen, jossa on edellä oleva tila, ei tapahtumavirta.

Virheilmoitukset eivät koskaan sisällä toisen palvelun sisäisiä yksityiskohtia.

rajoituksia

Linkki kuvaan on osoitettava julkiselle isännälle: osoite yksityisellä tai paikallisella verkostolla tai Nymbotin omilla sivustoilla hylätään.

Mitä tulipalo voi nähdä

API ei ole yksityinen tapa, jolla sovellukset ovat, ja kannattaa olla täsmällinen siitä, miten.

• Se ei ole end-to-end salattu. Sovelluksissa viesti suljetaan laitteellesi vain Nymbotin pitämille ja matkustaville avaimille. Lahjakortti WrapAPI-pyyntö on tavallinen HTTPS: se on salattu matkalla Nymbot, ja Nymbotin palvelin lukee sen selkeästi käsitellä sitä.
• Ilmoituksia ja vastauksia ei tallenneta. Ne kulkevat mallin läpi ja vastaus kulkee takaisin.Se, mitä pidetään, on lasku: jokaisen pyynnön osalta aika, malli, tyyppi, token laskee, kustannukset, tasapaino, avain ja onko se onnistunut, 90 päivän ajan, mikä on mitä Haluamme historiaa Samasta pyynnöstä (aika, tyyppi, malli, tokenien lukumäärä, kustannukset, kesto ja onko se käyttänyt web-hakuja tai onnistunut) säilytetään myös 90 päivän ajan sovelluksen omien kanssa.
• Kaikki muu, mitä pidetään nymissä, on pieni ja lueteltu täällä. Tulipalo avaimet tallennetaan hashina, ei koskaan avaimena, niiden nimellä, lyhyellä vihjeellä, kulutuskappaleella, palautusajanjaksolla, voimassaolon päättymisajalla ja kun ne tehtiin ja viimeksi käytettiin; vain uusimmat 50 peruutettua avainta säilytetään. Automaattinen top-up Lompakon yhteys tallennetaan salattuina, sen kynnyksellä, summalla ja viimeisen ylityksen tuloksella. Videotyöt pidetään 24 tuntia. Puhelua kohti maksetut pyynnöt jättävät vain Lightning-maksuhashin 7 päivän ajan ja 30 päivän ajan hashed-palautusmerkin, joka liittyy mihinkään.
• Sovelluksen poistaminen poistaa sen. A Laite Wipe peruuttaa ja poistaa jokaisen API-avaimen ja poistaa kyselylomakkeen, käyttötietueen, lompakkoyhteyden ja videotyöt.
• Mallin tarjoaja näkee pyyntösi, kuten se tekee sovelluksesta. luettelomallit toimivat niiden valmistajilla; vakio reitit ja upotukset toimivat Cloudflare.
• Luotu media on julkinen. Linkkeinä toimitetut kuvat ja videot ladataan julkisiin Blossom-tiedostojen isännöihin, joissa tiedoston osoite on sen hash. Kuka tahansa, jolla on linkki, voi avata sen, eikä Nymbot voi ottaa sitä uudelleen. b64_json ja luotu kuva palaa vastauksessa ja sitä ei koskaan ladata.
• Niin ovat kuvat, jotka annat generaattorille. Kuvia, joihin lataat Edita, tai lähetä a data: URL-osoite generaattorissa image_url, ladataan julkiselle Blossom-isännälle ensin niin, että generaattori voi noutaa sen, ja sama pätee siihen. https:// Kuvat chat-pyynnössä menevät mallin palveluntarjoajalle, ei Blossomille.
• Avain on kytketty nym. Kaikki, mitä avain kuluttaa, tulee nimesi tasapainosta, joten API: n käyttö ei ole AnonyymiäJos haluat pitää API: n käytön erillään päivittäisestä nymistäsi, tee avaimet erillisestä nymistä, jolla on oma tasapaino.

Jos tarvitset sovellusten suojaa, käytä sovelluksia. API on käytettävissä, kun tarvitset malleja omissa työkaluissasi.

Jokainen päätepiste

“Nym” tarkoittaa pyyntöä, joka on allekirjoitettu Nostr-avaimella, joka on kuvattu Tilin allekirjoittamista koskevat pyynnötTyökaluja, jotka jo puhuvat näistä muodoista, katso Työkalut ja SDK:t, ja koodausagenttien, kuten Claude Code, Codex ja Cline, katso Koodaustyökalut.