Þekkingargrunnur / Framleiðendur

Eldsneyti yfirlit

Hugbúnaðurinn talar OpenAI og Anthropic snið, þannig að flestir verkfæri og SDK virka með því að breyta grunn URL og lykil.

Þessi síða er vélþýdd til hægðarauka. Enska frumritið er útgáfan sem á við.

Hvað er eldurinn

HTTP API á nymbot.ai sem svara sömu beiðnum sem OpenAI eða Anthropic viðskiptavinur sendir þegar. Þú færð:

• Chat fullnægingar, The Svör við eldur og Anthropic skilaboð, með flutningi, verkfærum, myndum, rökstjórnun og vefurskoðun, fyrir hvert líkan í Katalókið og fyrir Nymbot eigin bílstýring.
• Myndir, Vídeó, Talað, Transkript og innblástur.
• Þinn jafnvægi, Lightning upptökur, Sjálfvirk toppur úr veskinu þínu og a Sögur Hvað kostar hvert umsókn.

Það er borgað frá sömu tveimur jafnvægi Það er engin áskrift og engin ókeypis leyfi á API: Hver beiðni er greiddur fyrir frá kröfum sem þú keyptir.

Það sem API gerir er ekki að bæta við neitt af eigin Nymbot. skilaboðin þín fara til líkanar eins og þú sendir þær: engin Nymbot kerfi tilkynningu, engin minni, engin dagsetningu eða tungumál vísbendingar. Það sem kemur aftur er svarið af líkanum og athugasemd um hvað það kostar.

Grunnur URLs

Hvert endapunkt lifir undir /api/v1/Óþekkt leið kemur aftur 404 og þekkt leið sem kallað er með rangt aðferð kemur aftur 405Bæði eins og JSON.

API svarar kross uppspretta beiðnum frá hvaða vefsíðu sem er, þannig að vafra síða getur kallað það. Allt sem þú sendir til vafra er hægt að lesa af hverjum sem opnar það, svo bara gera það með lykli sem hefur lítið HöfuðEndpoints undirritað með nym þínum (keys, reikningarsammstæðing, NWC auto-top-up og endurgreiðslu) eru undantekningin: í vafra þeir svara aðeins Nymbot eigin síður. Skilaboð um beiðni.

Sendu hverjum JSON líkama með Content-Type: application/jsonÖll önnur tegund er hafnað með 415, svo einföld HTML formi eða a text/plain beiðni frá öðru vefsvæði getur ekki náð API. Með cURL -H "Content-Type: application/json" ásamt -d.

Eldur lykillinn

Nákvörur eru gerðar í app. opna Eldur í hliðarfljósi vefsvæðisins, eða í valmyndinni á Android og iOS, og ýta á Að búa til lykilGefðu því nafn og, ef þið viljið, kapp og útgjöldardag.

Skrifaðu það einhvers staðar áður en þú lokað skjalinu: Nymbot geymir aðeins fingraför af því, svo það getur ekki sýnt þér það aftur.

lykillinn lítur út eins og sk-nymbot- fylgt með 43 bréfum, stafi, skammtum og undirsvörum. The app listar hvern lykil með nafni sínu og stuttum vísbendingu eins og: sk-nymbot-Qm7x…c2Lw.

• Lykillinn tilheyrir nym þínu. Það eyðir jafnvægi þínu, og aðeins nym þinn getur gert, breytt eða afturkallað það. Sá sem er með lykilinn getur eytt því, svo meðhöndla það eins og lykilorð.
• Caps eru í sats. A lykill getur haft kostnaðarmál, og takmarkið er hægt að setja aftur á hverjum degi, á hverjum viku (mánudaginn) eða á hverjum mánuði (fyrstu) kl. 00:00 UTC. Það telur bæði jafnvægi, venjulegt kredit sem 10 sats og Pro kredit sem 100, þannig að það þýðir það sama hvað jafnvægi beiðni eyðir. 403 key_limit_reached, jafnvel þótt svarið hefði komið undir hápinn; mistök segir hversu mikið er eftir og hvenær hápinn endurheimtur. max_tokens A beiðni er borgað hvað það virkilega kostar og það telst gegn cap, svo ef veitirinn skýrir fleiri tokens en voru sett til hliðar, síðasta beiðni sem passa getur tekið lykilinn smá fyrir utan cap sitt; næsta er þá hafnað.
• Hægt er bara að hætta að eyða. A lykill á höfuðið getur enn athugað jafnvægi, lesið sögu sína, listað módel, telja tokens, topp upp og athugað myndband sem það hefur þegar byrjað.
• Expiry er valfrjálst. Eftir dagsetningu sem þú setur upp hættir lykillinn að vinna.
• Afsakið er strax og endanlegt. A afturkallaður lykill missir næsta beiðni. Það er enn á listanum, merkt afturkallað, þannig að kostnaður sögu hennar er enn skynsamlegt.
• Þú getur haft allt að 25 virka lykla, hver með eigin nafn.

Sama blöð sýnir hvern lykil að eyða þessum tíma og í heild, þegar það var síðast notað, bæði jafnvægi þína og nýleg API beiðnir. Að stjórna lykjum.

Að staðfesta beiðni

Sendu lykilinn í hvaða einn af þessum höfuðritum sem er. Þeir eru jafnvægi, svo notaðu það sem viðskiptavinur þinn sendir fyrirfram:

Mistakinn, óþekktur, endurgreiddur eða úthlutinn lykill 401Með kóða missing_api_key, invalid_api_key, revoked_api_key eða expired_api_keyListun módel, hljóðmódel og rödd, og greiðslu aðferðir þurfa ekki lykil.

Myndir, myndbönd, tal, útskrifa og innblástur geta einnig verið greiddar fyrir eina beiðni í einu yfir Lightning án lykla alls: senda beiðni án þess og borga reikninginn í 402 svarið. sjá Borga á beiðni án lykla.

Key management, reikningarsammstæðan og sjálfkrafa toppur eru undantekningarnar: þeir taka undirskrift frá nym þínum í stað lykilsins, þannig að lækkaður lykill getur ekki gert fleiri lykla. Skilaboð um beiðni.

Fyrsta beiðni þína

Setjið lykilinn í umhverfisbreytni og spyrðu þá módel eitthvað. 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 er eigin leiðbeining Nymbot, greiddur frá venjulegum jafnvægi. Setjið ID katalógusmyndir þar í staðinn, svo sem: anthropic/claude-sonnet-5, til að nota þennan líkan frá Pro jafnvægi. Listið módel Gefðu þér hvert ID.

Hvað kostar beiðni

API reiknar nákvæmlega eins og appinn gerir.

• Hvaða jafnvægi nymbot/auto eyða þeim Normað jafnvægi (10 sats a kredit). Allir aðrir spjallmóður eyðir fyrir jafnvægi (100 sats a kredit). The venjulegur myndaframleiðandi og venjulegur rödd eyða venjulegum kreditum; hver annar myndaframleiðandi eyðir Pro. Embeddings eyða venjulegum kreditum. Transcription eyðir venjulegum kreditum þegar venjulegur jafnvægi getur náð því og Pro kreditum annars. Listið af módelum segir hvaða jafnvægi hver líkan eyðir.
• Hversu mikið Spjall beiðni er mælað á tákn sem líkan er í raun lesin og skrifað, á útgáfu áætlunaraðila. Þessi verð hefur 5% gjald bæta og er þá multiplied með 1.5, þannig að þú borgar 1.575 sinnum lista áætlunaraðila verð. Það er breytt í sats á lifandi Bitcoin verð og greiða í þúsund þúsund af kredit. Pro myndir, myndbönd og tal eru verðlaun á kynslóð, á sekúndu eða á eðli, og transkript á sekúndu af hljóð, með sömu gjald og marg. Tölvan er flat 5 staðlaða kredit og staðlaða rödd er flat 3.
• Að minnsta kosti. Hvert mælað beiðni sem hlaupa kostar að minnsta kosti 0,05 kredit: hálft setti á staðlaða jafnvægi, 5 sats á Pro. Fraktur af kredit er flutt, ekki hrundið upp í hvert skipti.
• Haltu áfram, þá settum við. Áður en beiðni fer fram, er það sem mest það gæti kostað er haldið frá jafnvægi þínu, á grundvelli þess sem þú sendir og flestum tokens sem það getur skrifað. Texti utan eðlilegra ASCII er stærð frá UTF-8 byttum sínum og ASCII tölur og punktur teljast sem token hver, þannig að texti í hvaða handrit, kóða og tölur eru haldnir í fullu. Haldið er í heildum kröfum, að minnsta kosti eitt, þannig að hvaða beiðni þarf að minnsta kosti 10 sats frjáls á venjulegum jafnvægi eða 100 sats á Pro til að hefjast. Aðeins raunveruleg kostnaður er reiknað; restin er gefin út þegar hún endar. Lengi beiðni heldur haldi sínu svo lengi sem 402 insufficient_balance Hægt er að taka þátt í því sem gerðist, og ef raunverulegur kostnaður er meiri en jafnvægi getur borgað, þá er allt jafnvægi tekin, restin er skuldin (owed_sats í the nymbot Object, og neikvæð jafnvægi). Það sem skuldar er greitt fyrst út af næstu kreditum sem ná þeirri jafnvægi. Áður en það er greitt, ekkert á þeim jafnvægi er hægt að eyða: ekki af API, svör í forritinu, flutning eða gjöf.
• Ekki nóg kredit. Ef jafnvægið getur ekki náð haldi, er beiðni hafnað með 402 mistök segir hvaða jafnvægi er stutt, hversu margir satsar beiðni þarf og hversu margir eru ókeypis. max_tokens Það þýðir minni haldi.
• að mistök. Fyrirspurn sem misheppnar kostar ekkert, nema veitirinn gjörði reikning fyrir vinnuna sem það gerði áður en það misheppnaðist, eða vefur leitar eða nymbot/auto verkefni skoðun hafði þegar verið keypt; þá er það sem þú borgar, að minnsta kosti 0.05 kredit. Flæði sem þú skera er gjaldþrota fyrir tokens sem veitir tilkynnt: Nymbot heldur áfram að lesa flæði veitirinnar í allt að 25 sekúndur eftir að þú yfirgefur til að fá það reikning. Ef það kemur ekki, er gjaldþrota áætlað frá því sem þú sendir og hvað var skrifað, og fyrir líkan sem ástæður það inniheldur alla útgangsleyfingu haldi.
• Vefsíða leit kostar $ 0,008 leitar, umbreytt til sats, hvenær leitar var gerð, hvort sem líkan svaraði eða missti.

Hver svör segir hvað það kostar. JSON svör bera nymbot hlut með jafnvægi sem það var greitt úr, gjald í kröfum og sats, og hvað er eftir:

Kostnaður fyrir hlutina

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

Greidd svör eru einnig með þessum höfundum, sem er þar sem að leita að kostnaði viðbrögð sem er ekki JSON, svo sem tal:

Verð á milljón tokens, þegar þar á meðal gjald og marg, eru í Listi fyrir módel í dollara og sats, og á VerðlaunartækiðEf Bitcoin verð er ekki hægt að lesa, greiða beiðnir koma aftur 503 price_unavailable með Retry-After: 60 Í stað þess að giska.

Mistök

Hver mistök hefur sömu mynd, einn OpenAI viðskiptavinir þegar skilja. code er stöðugt nafn sem þú getur passað á; message Það er fyrir fólk og getur breyst.

Mistök líkamans

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

Tveir undantekningar :

• /api/v1/messages svör í mistök formi Anthropic, þar sem það er það sem Anthropic viðskiptavinir rannsaka: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Tíminn fylgir stöðu: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error eða overloaded_error (503).
• Streaming beiðni sem missir áður en fyrsta byte hennar fær venjulegt JSON mistök með stöðu hér að ofan, ekki atburðarstreymi.

Mistök skilaboð innihalda aldrei innri upplýsingar um aðra þjónustu.

Takmarkanir

Hlekkur á mynd þarf að vísa til opinberra gestgjafa: heimilisfang á einka- eða staðbundnum netinu eða á eigin vefsvæðum Nymbot er hafnað.

Það sem eldurinn sér

API er ekki einkalíf á þann hátt sem apps eru, og það er þess virði að vera nákvæm um hvernig.

• Það er ekki end-to-end dulkóðað. Í forritum er skilaboð settur á tækið þitt til lykla sem aðeins Nymbot er með og ferðast sem Góður WrapAPI beiðni er venjulegt HTTPS: það er dulkóðað á leiðinni til Nymbot, og þjónn Nymbot les það í hreinu til að takast á við það.
• Hreyfingar og svör eru ekki geymdar. Það sem er haldið er reikninginn: fyrir hverja beiðni tíminn, líkan, tegund, token telur, kostnaður, jafnvægi, lykill og hvort það tókst, í 90 daga, sem er það sem Vilja sögu Niðurstöður um notkun á sömu beiðni (tími, tegund, módel, tákn, kostnaður, lengd og hvort hún notaði vefurskoðun eða tókst) er einnig haldin í 90 daga, ásamt eigin forritinu.
• Allt annað sem haldið er fyrir nym er lítið og listast hér. Eldur lykillinn eru geymdar sem hash, aldrei lykillinn, með nafni þeirra, stuttum hlekki, kostnaðartak, endurheimta tímabil, upphaf og hvenær þeir voru gerðir og síðast notaðir; aðeins nýjustu 50 afturkallaðar lykla eru haldnir. Sjálfvirkur top-up Vídeó störf eru haldnir í 24 klukkustundir. beiðnir greiddar á símtal yfirgefa aðeins Lightning greiðslu hash í 7 daga og hashed endurgreiðslu token í 30 daga, tengd við engin nym. Gjafir sem jafnvægi gæti ekki deilt eru haldnir eins og skuldir þar til toppur greiðir þá.
• Að slökkva á app er að eyða því. A Vörur Wipe endurheimtir og eyðir hverri API lykli og eyðir spurningahistóríkinni, notkunargögnum, tengslum við veskinu og myndböndum.
• Framkvæmdastjóri sýnir beiðni þína, eins og það gerir frá forritinu. Catalog líkanir hlaupa á framleiðendum sínum; venjulegar leiðir og innblástur hlaupa á Cloudflare.
• Meðal fjölmiðla er opinber. Myndir og myndbönd sem veittar eru sem tenglar eru flutt upp á opinberar Blossom skrá hosta, þar sem heimilisfang skrá er hash hennar. Sérhver sem hefur tengilinn getur opnað það og Nymbot getur ekki tekið það niður aftur. b64_json og myndaður mynd kemur aftur í svarið og er aldrei hlaðið upp.
• Svo eru myndirnar sem þú gefur generator. Mynd sem þú sækir upp á Edit að, eða senda sem a data: URL í generator image_url, er hlaðið upp til opinberra Blossom gestgjafa fyrst svo að myndavélin geti hlaðið það upp, og það sama gildir um það. https:// Myndir í spjall beiðni fara til framleiðanda módelsins, ekki til Blossom.
• Lykill er tengdur við nym þinn. Allt sem lykill eyðir kemur úr jafnvægi nym þinn, svo API notkun er ekki AnónusEf þú vilt API notkun haldið í burtu frá daglegu nym þinn, gera lykla frá sérstökum nym með eigin jafnvægi.

Ef þú þarft vernd forritanna skaltu nota forritin. API er til þegar þú þarft módel í eigin verkfæri.

Hvert endalok

“Nym” þýðir beiðni undirritað með Nostr lykli þínu, sem lýst er í Skilaboð um beiðniFyrir verkfæri sem þegar tala um þessar sniði, sjá Tól og SDKs, og fyrir kóðaðgerðir eins og Claude Code, Codex og Cline, sjá Coding verkfæri.