Žinių bazė / kūrėjai

Ugnies apžvalga

Modeliai, generatoriai ir balansai, kuriuos naudojate programoje, iš savo kodo. API kalba OpenAI ir Anthropic formatais, todėl dauguma įrankių ir SDK veikia keičiant bazinį URL ir raktą.

Patogumui šis puslapis išverstas mašininiu būdu. Tinkama versija anglų kalba.

Kas yra ugnis

HTTP API naudojimas nymbot.ai kuris atsako į tuos pačius užklausas, kurias jau siunčia „OpenAI“ arba „Anthropic“ klientas.

• Pokalbių užbaigimasTačiau The Atsakymas į ugnį ir Antropinės žinutės, su srautu, įrankiais, nuotraukomis, argumentavimu ir žiniatinklio paieška, kiekvienam modeliui Katalogas ir dėl savo „Nymbot“ automatinio maršruto.
• Vaizdai, Vaizdo, Kalbos, transkripcijos ir Įdėklai.
• Jūsų balansas, Žaibo viršūnės, Automatinis viršelis iš jūsų piniginės ir a Istorijos Kiek kainuoja kiekvienas prašymas.

Mokama iš tų pačių dviejų balansų nėra prenumeratos ir nėra nemokamo leidimo API: kiekvienas prašymas mokamas iš įsigytų kreditų.

Ką API nedaro, tai pridėti ką nors iš Nymboto. Jūsų pranešimai patenka į modelį, kai juos išsiuntėte: jokių Nymboto sistemos užklausų, jokios atminties, jokių datos ar kalbos užuominų.

Pagrindinės URL

Kiekvienas taškas gyvena po /api/v1/Nežinomas kelias grįžta 404 ir žinomas kelias, vadinamas netinkamu metodu, grįžta 405Kaip ir JSON.

API reaguoja į kryžmines užklausas iš bet kurios svetainės, todėl naršyklės puslapis gali ją skambinti.Viskas, ką siunčiate į naršyklę, gali perskaityti kiekvienas, kuris ją atidaro, todėl tai darykite tik su raktu, kuris turi nedidelį GalvosGalutiniai taškai, pasirašyti su jūsų nym (raktai, sąskaitos santrauka, NWC automatinis viršijimas ir grąžinimo išpirkimas) yra išimtis: naršyklėje jie atsako tik į Nymbot svetaines. Pasirašyti sąskaitos prašymus.

Siųsti kiekvieną JSON kūną su Content-Type: application/jsonBet koks kitas tipas yra atsisakyta 415Pavyzdžiui, HTML forma arba text/plain užklausos iš kitos svetainės negali pasiekti API. su cURL, pereikite -H "Content-Type: application/json" Kartu su -d.

Gaisro raktas

Raktai yra sukurti programoje. atviras Ugnis svetainės programėlės šoninėje juostoje arba „Android“ ir „iOS“ meniu ir paspauskite Sukurkite raktąPateikite jam pavadinimą ir, jei norite, dangtelį ir galiojimo datą.

Kopijuokite jį saugioje vietoje prieš uždarydami lapą: „Nymbot“ saugo tik jo pirštų atspaudą, todėl jis negali jį jums parodyti dar kartą.

Raktas atrodo kaip sk-nymbot- po jų – 43 raidės, skaitmenys, žymės ir požymiai. programėlė kiekvieną raktą išvardija pagal pavadinimą ir trumpą užuominą, pvz., sk-nymbot-Qm7x…c2Lw.

• Vienas raktas priklauso jūsų nym. Jis išleidžia jūsų balansą, ir tik jūsų nym gali jį padaryti, pakeisti ar atšaukti.
• Kapsulės yra įdėtos. Raktažodis gali turėti išlaidų viršutinę ribą, o viršutinę ribą galima iš naujo nustatyti kiekvieną dieną, kiekvieną savaitę (pirmadienį) arba kiekvieną mėnesį (pirmąjį), 00:00 UTC. Jis skaičiuoja abu balansus, standartinį kreditą kaip 10 sats ir Pro kreditą kaip 100, taigi tai reiškia tą patį, nesvarbu, kokį balansą išleidžia prašymas. 403 key_limit_reached, net jei atsakymas būtų atėjęs po gaubtu; klaida nurodo, kiek liko ir kada gaubtas iš naujo. max_tokens Prašymas apmokestinamas tuo, ką jis iš tikrųjų kainuoja, ir tai skaičiuojama prieš kapitoną, taigi, jei teikėjas praneša apie daugiau žetonų, nei buvo nustatyta, paskutinis prašymas, kuris tinka, gali šiek tiek viršyti raktą; kitas yra atmestas.
• Išleista kapsulė tik sustabdo išlaidas. Raktažodis savo viršuje vis dar gali patikrinti balansą, perskaityti jo istoriją, išvardyti modelius, suskaičiuoti žetonus, padidinti ir patikrinti vaizdo įrašą, kurį jis jau pradėjo.
• Išnykimas yra neprivalomas. Po nustatytos datos raktas nustoja veikti.
• Atšaukimas yra tiesioginis ir galutinis. Atšauktas raktas nepavyksta savo kitą prašymą.Jis lieka sąraše, pažymėtas atšauktas, todėl jo išlaidų istorija vis dar yra prasminga.
• Galite turėti iki 25 aktyvių raktų, kurių kiekvienas turi savo vardą.

Tame pačiame lape rodomas kiekvieno rakto praleidimas per šį laikotarpį ir iš viso, kai jis paskutinį kartą buvo naudojamas, tiek jūsų balansai, tiek jūsų neseniai pateikti API prašymai. Raktų valdymas.

Prašymo autentifikavimas

Siųskite raktą bet kurioje iš šių antraščių. Jie yra lygiaverčiai, todėl naudokite tai, ką klientas siunčia pagal numatytuosius nustatymus:

Trūkstamas, nežinomas, atšauktas arba pasibaigęs raktų grąžinimas 401Su šiuo kodu missing_api_key, invalid_api_key, revoked_api_key arba expired_api_keySąrašo modeliai, garso modeliai ir balsai bei mokėjimo būdai nereikalauja rakto.

Nuotraukos, vaizdo įrašai, kalba, transkripcija ir įterpimai taip pat gali būti mokami už vieną užklausą vienu metu per "Lightning" be jokio rakto: nusiųskite užklausą be vieno ir sumokėkite sąskaitą faktūrą 402 Atsakymas: Žiūrėti Mokėjimas pagal užklausą be rakto.

Rakto valdymas, sąskaitos santrauka ir automatiniai viršūnės yra išimtis: jie paima parašą iš jūsų nym vietoj rakto, todėl nutekėjęs raktas negali padaryti daugiau raktų. Pasirašyti sąskaitos prašymus.

Jūsų pirmasis prašymas

Įdėkite raktą į aplinkos kintamąjį, tada paprašykite modelio kažko. 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 yra „Nymbot“ pačios maršrutas, sumokėtas iš standartinio balanso. Vietoj to įdėkite katalogo modelio ID, pvz., anthropic/claude-sonnet-5, kad galėtumėte naudoti šį modelį iš Pro balanso. Modelių sąrašas Suteikia kiekvieną ID.

Kiek kainuoja prašymas

API atsiskaito tiksliai taip, kaip veikia programa.

• Kokios pusiausvyros nymbot/auto Išleiskite Standartinė balansas (10 sats a credit). Kiekvienas kitas pokalbių modelis praleidžia Pro balansas (100 kreditų). Standartinis vaizdo generatorius ir standartinis balsas išleidžia standartinius kreditus; kiekvienas kitas generatorius išleidžia Pro. Įterpimai išleidžia standartinius kreditus. Transcription išleidžia standartinius kreditus, kai standartinis balansas gali jį padengti, o Pro kreditai kitaip. Modelių sąrašas nurodo, kurį balansą išleidžia kiekvienas modelis.
• O kiek Pokalbių prašymas matuojamas ant žetonų, kuriuos modelis iš tikrųjų perskaitė ir parašė, teikėjo paskelbtais tarifais. Ši kaina turi 5% mokestį ir tada padauginama iš 1,5, todėl mokate 1575 kartus nuo teikėjo sąrašo kainos. Jis konvertuojamas į sats už gyvą Bitcoin kainą ir apmokestinamas tūkstančiais kredito. Pro nuotraukos, vaizdo įrašai ir kalba yra kainuojami už kartą, už sekundę ar už simbolį, ir transkripcija už sekundę garso, su tuo pačiu mokesčiu ir marža. Standartinis vaizdas yra plokščia 5 standartiniai kreditai ir standartinis balsas yra plokščia 3.
• Tai minimalus Kiekvienas išmatuotas prašymas, kuris veikia kainuoja mažiausiai 0,05 kredito: pusė sėdėjo ant standartinio balanso, 5 sats ant Pro. Kredito frakcijos perkeliamos, o ne suapvalinamos kiekvieną kartą.
• Laikykitės ir tada nusistovėkite. Prieš paleidžiant užklausą, kuo daugiau ji gali kainuoti, laikoma iš jūsų balanso, atsižvelgiant į tai, ką siunčiate ir kuo daugiau žetonų ji gali parašyti. Tekstas už paprasto ASCII dydis yra iš UTF-8 bajtų, o ASCII skaitmenys ir taškų skaičiavimas skaičiuojami kaip kiekvienas žetonas, todėl bet kokio scenarijaus tekstas, kodas ir skaičiai laikomi pilnai. Laikoma visais kreditais, bent vienu, todėl bet kuriam prašymui reikia bent 10 nemokamų statymų standartiniame balanse arba 100 statymų "Pro", kad būtų galima pradėti. Tik faktinė kaina apmokestinama; likusi dalis išleidžiama, kai ji baigiasi. Ilgas prašymas išlaiko savo laikymą tol, kol jis veikia; jei laikomi 402 insufficient_balance Jei faktinė kaina yra didesnė nei balansas gali sumokėti, visas balansas yra paimtas, o likusi dalis yra skolinga (owed_sats į nymbot objektas ir neigiamas balansas). Tai, kas yra skolinga, pirmiausia mokama iš kitų kreditų, kurie pasiekia tą balansą. kol jis nėra sumokėtas, nieko apie tą balansą negalima išleisti: ne API, atsakymai programoje, pervedimas ar dovana.
• Nepakanka kredito Jei balansas negali padengti išlaikymo, prašymas atmetamas 402 klaida nurodo, kuris balansas yra trumpas, kiek satsų reikia užklausai ir kiek yra nemokama. max_tokens Tai reiškia mažesnį laikymąsi.
• ir nesėkmių. Nepavykęs prašymas nieko nekainuoja, nebent teikėjas sąskaitą už darbą, kurį jis padarė prieš nesėkmę, arba žiniatinklio paiešką ar nymbot/auto Užduočių patikrinimas jau buvo atliktas; tada tai yra tai, ką jūs mokate, bent 0,05 kredito. Srautas, kurį nukirpsite, yra apmokestinamas už žetonus, kuriuos praneša teikėjas: "Nymbot" skaito teikėjo srautą iki 25 sekundžių po to, kai paliekate, kad gautumėte tą skaičių.
• Internetinė paieška Kainuoja $ 0,008 paieška, konvertuojama į sats, kiekvieną kartą, kai buvo atlikta paieška, nesvarbu, ar modelis tada atsako ar nepavyksta.

Kiekvienas atsakymas nurodo, kiek jis kainuoja. „JSON“ atsakymai nymbot objektas su balansu, iš kurio jis buvo sumokėtas, mokestis kreditais ir įmokomis, ir tai, kas liko:

Kainų objektas

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

Mokami atsakymai taip pat turi šias antraštes, kuriose ieškoma ne JSON atsakymo kainos, pvz., kalbos:

Kainos už milijoną žetonų, jau įskaitant mokestį ir maržą, yra Modelių sąrašas doleriais ir įkainiais, ir Kainų lentelėJei "Bitcoin" kainos negalima perskaityti, grąžinami mokami prašymai 503 price_unavailable su Retry-After: 60 O ne spėlioti.

klaidų

Kiekviena klaida turi tą pačią formą, kurią jau supranta „OpenAI“ klientai. code yra stabilus vardas, kurį galite suderinti; message Jis skirtas žmonėms ir gali pasikeisti.

Kūno klaidos

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

Dvi išimtys:

• /api/v1/messages Atsakymai pateikiami „Anthropic“ klaidų formatu, nes būtent tai analizuoja „Anthropic“ klientai: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Tipas seka statusą: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error arba overloaded_error (503).
• Transliavimo užklausa, kuri nepavyksta prieš savo pirmąjį bajtą, gauna įprastą JSON klaidą su aukščiau nurodytu statusu, o ne įvykių srautu.

Klaidų pranešimai niekada neturi kitos paslaugos vidinių detalių.

apribojimai

Nuotraukoje pateikiama nuoroda turi nurodyti į viešą hostą: adresas privačiame ar vietiniame tinkle arba „Nymbot“ svetainėse yra atmestas. „Provider“ tempas, kuris taikomas programoje, taip pat taikomas čia, todėl prašymų į vieną teikėją sprogimas gali būti sulėtintas, o ne nepavyko.

Ką gali pamatyti ugnis

API nėra privatus, kaip yra programos, ir verta tiksliai pasakyti, kaip.

• Jis nėra end-to-end užšifruotas. Programose pranešimas yra užantspauduotas jūsų įrenginyje tik raktus Nymbot laikoma ir keliauja kaip Dovanų dėžutėAPI prašymas yra įprastas HTTPS: jis yra užšifruotas kelyje į „Nymbot“, o „Nymbot“ serveris jį skaito aiškiai, kad jį tvarkytų.
• Atsiliepimai ir atsakymai nėra saugomi. Tai, kas išsaugoma, yra sąskaita: kiekvienam prašymui laikas, modelis, tipas, žetonų skaičiavimas, kaina, balansas, raktas ir ar tai pavyko, 90 dienų, o tai yra tai, ką Ieškoti istorijos Tą pačią užklausą (laiką, tipą, modelį, žetonų skaičiavimą, kainą, trukmę ir tai, ar ji naudojo žiniatinklio paiešką ar sėkmingai) taip pat saugo 90 dienų, be pačios programos.
• Visa kita, laikoma nym, yra maža ir išvardyta čia. Gaisro raktas yra saugomi kaip hash, niekada raktas, su jų vardu, trumpas užuomina, išlaidų viršelis, atkūrimo laikotarpis, galiojimo laikas ir kai jie buvo padaryti ir paskutinį kartą naudojami; išsaugomi tik naujausi 50 atšauktų raktų. Automatinis viršutinis Užklausos, sumokėtos už skambutį, palieka tik „Lightning“ mokėjimo šachmatą 7 dienas ir 30 dienų šachmatinį grąžinimo žetoną, susietą su niekuo.
• Ištrinant programėlę ją ištrinate. A Prietaisas WIPE atšaukia ir ištrina kiekvieną API raktą ir ištrina užklausų istoriją, naudojimo įrašus, piniginės ryšį ir vaizdo įrašų darbus.
• Modelio teikėjas mato jūsų prašymąKatalogų modeliai veikia jų kūrėjams; standartiniai maršrutai ir įterpimai veikia „Cloudflare“.
• Sukurta žiniasklaida yra vieša. Nuotraukos ir vaizdo įrašai, pateikti kaip nuorodos, yra įkeliami į viešus Blossom failus, kur failo adresas yra jo hash. Kiekvienas, turintis nuorodą, gali ją atidaryti, o Nymbot negali vėl jį atsisiųsti. b64_json ir sukurtas vaizdas grįžta į atsakymą ir niekada nėra įkeliamas.
• Taip pat yra nuotraukos, kurias jūs suteikiate generatoriui. Nuotrauka, kurią įkeliate į EDITarba siųsti kaip a data: URL į generatorių image_url, pirmiausia įkeliamas į viešą Blossom hostą, kad generatorius galėtų jį paimti, ir tas pats taikytina. https:// Nuotraukos pokalbių prašyme eina į modelio teikėją, o ne į Blossom.
• Raktas yra susietas su jūsų nym. Viskas, ką raktas išleidžia, ateina iš jūsų nym balanso, todėl API naudojimas nėra AnoniminėJei norite, kad API naudojimas būtų laikomas atskirai nuo jūsų kasdienio nym, sukurkite raktus iš atskiro nym su savo balansu.

Jei reikia apsaugoti programas, naudokite programas. API yra tada, kai jums reikia modelių savo įrankiuose.

Kiekviena pabaiga

“Nym” reiškia užklausą, pasirašytą jūsų Nostr raktą, aprašytą Pasirašyti sąskaitos prašymusĮrankių, kurie jau kalba šiuos formatus, žr. Įrankiai ir SDK, ir kodavimo agentams, tokiems kaip Claude Code, Codex ir Cline, žr. Kodavimo įrankiai.