Isisekelo solwazi / Izinzuzo

API ukubuyekeza

Izimodeli, ama-generator kanye ne-balance ezisetshenziselwa ku-app, kusuka ku-code yakho. I-API ibizwa ne-OpenAI ne-Anthropic, ngakho-ke amaningi izixhobo kanye ne-SDK zokusebenza ngokuguqulwa kwe-base URL kanye ne-key.

Leli khasi lihunyushwe ngomshini ukuze kube lula. IsiNgisi sangempela inguqulo esebenzayo.

Yini i-fire

I-API ye-HTTP nymbot.ai ithatha imibuzo efanayo i-OpenAI noma i-Anthropic client. Uyakwazi:

• Ukusebenza kwe-ChatI-The Ukusabela API futhi Izindaba ze-Anthropic, nge-streaming, izixhobo, izithombe, ukucubungula kanye nokufaka kwebhizinisi, ngalinye amamodeli ikhaya futhi ngenxa ye-Nymbot ye-auto-routing.
• Izithombe, Ividiyo, Ukusabela, Ukuhlobisa futhi Ukuhlobisa.
• Eyakho Ukuhlobisa, Ukuhlobisa Top-ups, Top-ups okuzenzakalelayo kusuka wallet yakho a ikhaya Okungenani okungenani okungenani okungenani okungenani.

It is a paid from the same two Ukuhlobisa Njengoba isicelo, ngentengo efanayo. Akukho ukubhaliswa, futhi akukho ukunambitheka mahhala ku-API: zonke izicelo zithunyelwe kusuka ku-credits etholakala.

Yini i-API akufanele ukongeza noma iyiphi into ye-Nymbot yayo. Izindaba zakho zithunyelwe imodeli lapho ungathumela: akukho isitimela se-Nymbot, akukho isitimela, akukho isitimela se-date noma isilwane. Yintoni esithunyelwe kuyinto impendulo se-model kanye nesithombe esizayo.

Izithombe ze-URL

Konke endpoint ibhizinisi ngaphansi /api/v1/I-Unknown Path Yenza Ukusuka 404 and a known path called with the wrong method returns 405Futhi njengoba JSON.

I-API isibuyekeza imibuzo ye-cross-origin kusuka ku-website eyodwa, ngakho-ke i-browser page ingathola. Yonke into esithunyelwe ku-browser ingathunyelwa ngamunye owaqala, kunjalo, ngakho-ke kuphela nge-keyili enezingeni elincane ikhayaI-endpoints eyenziwe nge-nym yakho (i-keys, i-account summary, i-NWC auto-top-up ne-refund redemption) zihlanganisa: ku-browser, zihlanganisa kuphela kumasayithi we-Nymbot. Izicelo ze-akhawunti ze-akhawunti.

Thumela wonke umzimba we-JSON nge Content-Type: application/json. Noma iyiphi uhlobo olulodwa nge 415, ngakho umugqa HTML okuzenzakalelayo noma a text/plain isicelo evela kumazwe elinye ayikwazi ukufinyelela i-API. Ngokusebenzisa i-cURL, ukufinyelela -H "Content-Type: application/json" Ngezinye -d.

isikhwama

Izici ziye ziye ziye ziye ziye ziye ziye ziye ziye ziye ziye ziye ziye zibe. Open ikhaya ku-side bar ye-web app, noma ku-menu ku-Android ne-iOS, futhi uxhumane Yenza Key. Faka igama futhi, uma ufuna, cap kanye usuku lokugqibela.

Ukubonisa ikhoyili. Ukuhlobisa indawo amaningi ngaphambi kokufaka ifolda: I-Nymbot ikhoyili kuphela, ngakho-ke akukwazi ukubonisa kwama-ke. I-keyili ebutholwe akukwazi ukuguqulwa; ukuguqulwa futhi ukwakha enye.

I-key ibonisa ukuthi sk-nymbot- Ngemuva kwe-43 ama-letters, ama-digits, ama-dashes kanye nama-underscores. I-app ibonisa zonke izibambo nge-imeyili kanye ne-hint e-short like: sk-nymbot-Qm7x…c2Lw.

• I-key iyatholakala ku-nym yakho. Kuyathengisa isilinganiso yakho, futhi kuphela i-nym yakho inokukwazi ukwenza, ukuguqulwa noma ukuguqulwa. Wonke umuntu owenze i-key inokuthumela, ngakho-ke usebenzise njenge-password.
• I-CAPS iyatholakala ku-SAT. I-key ingaba i-spending cap, futhi i-cap ingaba i-reset ngosuku zonke, ngosuku zonke (u-Monday) noma ngenyanga ngamunye (u-first), ku-00:00 UTC. I-credits angama-balances, i-credit ye-standard njenge-10 sats ne-Pro credit njenge-100, ngakho-ke i-credits angama-equivalent efana ne-balance e-request eyenziwe. Ngaphambi kokuphumelela kwe-request, i-cost eningi (okugqoka ku-credits ephelele) ibekwe ku-credit ye-cap. Uma akufanele, isicelo igxile 403 key_limit_reached, ngisho uma impendulo uya khona ngaphansi kwe-cap; ingcindezi ibonisa ukuthi kuningi futhi lapho i-cap iyahlaziywa. Ukunciphisa max_tokens I-request iyahlaziywa ukuthi kuyimali ngokuvamile futhi kuyilinganiswa nge-cap, ngakho-ke uma umphakeli ibhalisele i-token engaphezu kwama-token eyenziwe ngaphandle, isicelo esilandelayo esifanelekayo ingathola i-key kancane ngaphandle kwe-cap yayo; elilandelayo ishiwa.
• Umthombo wahlanganisa kuphela ukuthengiswa. I-key at its cap ungayifaka i-balance, ukubuyekeza i-history, ukubuyekeza amamodeli, ukubuyekeza ama-tokens, ukubuyekeza futhi ukubuyekeza i-video eyenza.
• Expiry kuyinto optional. Ngemva kokufaka idatha, i-key akufanele ukusebenza.
• Ukuguqulwa kunokwenzeka ngempumelelo futhi ekupheleni. Umlinganiselo wahlukaniswa akufanele isicelo esilandelayo. I-key ebizwa ngokuthi i-revoked, ngakho-ke idatha yayo yokusabalalisa kubalulekile.
• Uyakwazi ukufinyelela ku-25 izibambo ezisebenzayo, zonke nge-imeyili yayo. Ukuguqulwa kwe-reset ye-keyword uqala i-period entsha ku-zero.

Ibhokisi elifanayo ibonisa izindleko ze-key ngamunye kuleli khosi futhi ngokuvamile, lapho kusetshenziselwa lokugqibela, izilinganiso zakho, kanye nezidingo zakho ze-API ezidlulile. Iziqu ze-endpoints ezilandelayo zihlanganiswa ngezansi: Ukuphathwa Key.

Ukubhalisa isicelo

Thumela ikhoyili e-one of these headers. Lezi zihlanganisa, ngakho usebenzisa ukuthi ikhasimende yakho inikeza ngokuvamile:

Umthombo we-keyword eyenziwe, eyenziwe, eyenziwe noma eyenziwe 401Nge-Code missing_api_key, invalid_api_key, revoked_api_key noma expired_api_keyUkubhalisa amamodeli, ama-audio amamodeli kanye nama-voices, kanye namasu lokukhokha akudingeki.

Izithombe, ividiyo, imibuzo, i-transcription kanye ne-embeddings zingatholakala futhi ngenyanga eyodwa ngexesha nge-Lightning ngaphandle kwesisombululo: ushiye isicelo ngaphandle kwe-one futhi ushiye inkinobho ku-Lightning. 402 Ukuphendula Ukudlulisela ngokuchofoza ngaphandle kwe-key.

Ukuphathwa kwe-key, isibuyekezo se-akhawunti kanye ne-automatic top-ups zihlanganisa: zihlanganisa i-signature kusuka ku-nym yakho kunokuba i-key, ngakho-ke i-key eyenziwe ayikwazi ukwenza izibuyekezo ezininzi. Izicelo ze-akhawunti ze-akhawunti.

Isicelo sakho yokuqala

Yenza ikhoyili ku-environment variable, bese ucebisa imodeli into. Imibuzo kulo maphakathi kubhalwe kusukela 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 I-Nymbot ye-routing yayo, ifayilishwe kusuka ku-balance yama-standard. Yenza id ye-catalog model lapho, njenge anthropic/claude-sonnet-5, ukuze usebenzisa le model kusuka ku Pro isilinganiso. Ukuhlolwa Model Yenza zonke id.

Yini i-request cost

I-API inikeza ngokufanayo njenge-app.

• Yini isilinganiso? nymbot/auto Thumela i Imininingwane isilinganiso (10 sats a credit). Wonke amalungelo agodliwe Waze isilinganiso (100 isilinganiso isilinganiso). I-standard image generator ne-standard voice isilinganiso isilinganiso isilinganiso; wonke omnye isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso. I-transcription isilinganiso isilinganiso isilinganiso lapho isilinganiso isilinganiso isilinganiso ingathenga, futhi isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso isilinganiso.
• Okuningi Umhlahlandlela we-chat isetshenziselwa ama-tokens eyenziwa futhi ebhaliwe kwimodeli, ngesivinini esithunyelwe yedivayisi. Lezi zindiza zihlanganisa i-5% futhi isethulwa ngama-1,5, ngakho-ke uzothola i-1,575 amaxabiso yesithombe yedivayisi. Kubhalwe ku-sats ngesivinini se-Live Bitcoin futhi ibhalwe amayunithi amayunithi. Izithombe ze-pro, i-video kanye ne-speech zithunyelwe ngalinye, ngenyanga noma ngenyanga, kanye nokudluliselwa ngenyanga ye-audio, nge-fee kanye ne-margin efanayo. Isithombe se-standard i-flat 5 i-credit kanye ne-standard voice i-flat 3.
• Imininingwane Konke isicelo esilinganiselwe esebenza izindleko okungenani 0.05 credit: i-half a sat on the standard balance, 5 sats on Pro. Iziqu ze-credit zithunyelwe, akuyona ngokugqithiselwe njalo.
• Hlola, bese ukuyifaka. Ngaphambi kokuphuma isivumelwano, inani eningi kungase kunikezelwa kwebhizinisi yakho, ngokuvumelana ne-akhawunti yakho kanye ne-token engaphansi. Umbhalo ngaphandle kwe-ASCII enezinhloko kusuka ku-UTF-8 ibhaythi yayo, futhi izibalo ze-ASCII kanye ne-punctuation zihlanganisa njenge-token ngamunye, ngakho-ke umbhalo ku-script, ikhodi kanye nama-nombolo zihlanganisa ngokuphelele. I-hold kuyinto i-credits ephelele, okungenani enye, ngakho-ke wonke isivumelwano kufuneka i-at least 10 sats free on the standard balance or 100 sats on Pro to start. Only the actual cost is charged; the rest is released when it ends. A long request retains its hold for as long as it 402 insufficient_balance Ukubuyekezwa kwezimali, futhi okuyinto eyakhiwe kusetshenziselwa. Uma imikhiqizo efanayo kuyinto engaphezulu kwe-balance kungatholakala, yonke isilinganiso kusetshenziselwa, isilinganiso esihlalweni (owed_sats Ukusuka nymbot Object, and a negative balance). Yini kulindeleke iyahlawulelwa kuqala kusuka ku-credits ezilandelayo eziningana ne-balance. Ngaphandle kokuhlawulelwa, akukho into ku-balance ingatholakala: hhayi yi-API, isibuyekezo ku-app, i-transfer noma i-cadeau.
• I-credit engaphansi Uma isilinganiso ayikwazi ukucubungula i-hold, i-request iyahlekile 402 before anything runs. I-error ibonisa ukuthi isilinganiso esithile, inani le-sats isilinganiso kuyimfuneko no-free. A engaphansi max_tokens Ukubalwa okungenani okungenani.
• Ukukhangisa Umhlahlandlela owawumangalisayo akuyona yini, ngaphandle kokuba umphakeli owawumangalisayo umsebenzi owawumangalisayo ngaphambi kokuphumelela, noma ukubuyekeza web noma nymbot/auto Ukubuyekezwa kwebhizinisi kwenziwa; ke lokhu kungenzeka, okungenani 0.05 credit. Umthombo owaqhathanisa akhawunti yama-tokens abaphakeli: I-Nymbot ivela ukubuyekeza umthamo we-provider kuze kube 25 imizuzu emva kokufika ukufumana okuqukethwe. Uma akuyona, i-akhawunti iyatholakala kusuka ku-imeyile owaqhathaniswa ne-imeyile ebhaliwe, futhi ngenxa ye-model okuyinto izizathu ibandakanya yonke imithombo ye-output ye-hold. Umthwalo owaqhathanisa ukuthi ukuxhumanisa akuyona futhi i-akhawunti.
• Ukubuyekezwa I-$0.008 ye-search, eyenziwe ku-sats, lapho i-search isebenza, noma isampula isibopho noma isihlangu. I-pages esitholukile isihlangulwe kuma-model njenge-input, ngakho-ke zihlanganisa ama-tokens zayo.

Konke impendulo ithi. Izimpendulo ze-JSON zihlanganisa a nymbot umphakeli nge-balance eyenziwe, isitimela ku-credits kanye ne-sats, kanye ne-cost:

I-Cost Object

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

Ukubuyekezwa kwezibuyekezo zihlanganisa izibuyekezo ziye zihlanganisa, okuyinto lapho ukubuyekeza i-cost ye-response engaphandle kwe-JSON, njenge-speech:

Izindleko per million tokens, futhi kuhlanganise izindleko kanye margins, zihlanganisa Ukubalwa Model ngama-dollars kanye ne-sat, futhi ku- I-Price SheetUma ixabiso ye-Bitcoin ayikwazi ukucacisa, izivakashi ze-payment zithunyelwe 503 price_unavailable Nge Retry-After: 60 Ngaphandle kokuzihlanganisa.

Ngena ngemvume

Yonke ingxaki iyona elifanayo, eyodwa i-OpenAI amakhasimende akuyona. code is a stabil name you can match on; is a stable name you can match on message Kuyinto abantu futhi kungenzeka ukuguqulwa.

umzimba

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

Izinzuzo ezimbili:

• /api/v1/messages Ukuphendula ku-Anthropic ye-error format, njengoko lokhu i-Anthropic client ibonise: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. Umbhali uye uye uye uye uye uye uye: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error noma overloaded_error (503).
• I-streaming request eyenza ngaphambi kwe-byte yokuqala yenza i-JSON ephephile ngokuvamile ne-status engaphezulu, akuyona i-event stream. A failure emva kwe-stream eyakhelwe njenge-event enhle ye-stream, e-endpoint yayo.

I-Error Messages ayidingi zihlanganisa i-details ye-internal ye-service ye-other. I-Error ye-providers iyahlaziywa ngaphambi kokufika kwami.

Izinzuzo

I-link ye-image kufanele ibonisa ku-host ye-publish: idilesi e-network ye-private noma ye-local, noma kwi-website ye-Nymbot, ibheka. I-Provider pacing eyenziwa ku-app iyatholakala lapha futhi, ngakho-ke isibopho se-requests e-provider eyodwa kungenziwa ngokushesha kuncike kuncike.

Yintoni i-API angakwazi ukubona

I-API ayikho ekhukhwini ngokufanayo ne-apps, futhi kunzima ukuchitha ngokuphathelene kanjani.

• It is not end-to-end encrypted. Kwi-apps, umbhalo igcinwe ku-device yakho ukuze ama-keys kuphela i-Nymbot ibhekwa futhi isitimela njenge-Nymbot UkugqokaIsicelo se-API kuyinto se-HTTPS esivamile: ifakwe ku-Nymbot, futhi i-server ye-Nymbot ibheka ku-clar to handle it.
• Izimpendulo kanye nezimpendulo asekelwe. Thola nge-model futhi impendulo iyatholakala. Yinto etholakalayo kuyinto i-akhawunti: ngamunye isicelo isikhathi, imodeli, uhlobo, i-token count, izindleko, isilinganiso, isilinganiso, futhi uma kusebenza, iminyaka engu-90, okuyinto Waze History I-Usage Record ye-request efanayo (u-time, uhlobo, imodeli, izibalo ze-token, izindleko, isikhathi kanye noma isebenzisa ukubuyekezwa kwe-web noma ukwamukela) iyahambisana ne-app yayo, i-90 usuku.
• Yonke okuzenzakalelayo eyenziwe nge-nym kuyinto encane futhi ibhalwe lapha. isikhwama zithunyelwe njenge-hash, akuyona ikhoyili, nge-imeyili, i-hint elincane, i-spending cap, i-reset period, i-expiration and when they were made and last used; kuphela ama-50 ezintsha ezivela ikhoyili zithunyelwe. Okuzenzakalelayo Top-up Ukuxhumanisa isixhumanisi wallet ibhekwa encrypted, nge threshold yayo, inani kanye ne-resultat ye-ultimate top-up. Imisebenzi ye-video ibhekwa ngehora angu-24. I-request paid per call ibheka kuphela i-Lightning payment hash ye-7days kanye ne-hashed refund token ngehora angu-30, ehlanganisiwe ngaphandle kwe-nym. I-cost a balance couldn't cover ibhekwa njenge-debt kuze kube i-top-up ibhekwa.
• Ukukhishwa kwe-app kususa. A Ukusebenza Wipe ukuguqulwa futhi ukunciphisa zonke i-API key, futhi ukunciphisa i-history ye-query, i-usage records, ukuxhumanisa i-wallet kanye ne-video jobs. I-balance kanye nama-cost eyenziwe akuyona emali.
• Umphakeli we-model uyazi isicelo sakhoI-catalogue models isebenza ku-makers zabo; izindlela ezivamile kanye nezinhlangano zokusebenza ku-Cloudflare.
• I-media eyenziwe yi-public. Izithombe nezividiyo ezivela njenge-links zithunyelwe ku-Blossom file hosts, lapho idilesi ye-file iyona i-hash ye-hash. Noma wonke umlingani angakwazi ukufinyelela, futhi i-Nymbot ayikwazi ukufinyelela. Qaphela b64_json futhi isithombe esithuthukisiwe ifike ku-response futhi ayidlulisiwe.
• Ngaphezu kwalokho, kukhona izithombe uzothola generator. Izithombe ezidlulile ezidlulile ekhaya, noma ushiye njengoba a data: I-URL ku-generator ye-URL image_url, iyahlaziywa ku-Blossom ekhukhwini lokuqala ukuze umkhakha ungathola, futhi okufanayo. A picture sent by https:// Izithombe ezivela ku-chat request ku-model's provider, hhayi ku-Blossom.
• I-key iyahambisana ne-nym yakho. Konke umlinganiselo we-key ivela ku-nym yakho ye-balance, ngakho-ke ukusetshenziswa kwe-API ayikho Ngena ngemvumeUma ufuna ukusetshenziswa kwe-API ukugcina ngaphandle kwe-nym yakho yamanje, ukwenza izibambo kusuka ku-nym eyahlukile nge-balance yayo.

Uma ufuna ukhuseleko kwe-app, isebenzisa i-app. I-API iyatholakala lapho ufuna amamodeli kumadivayisi yakho.

Konke endpoints

“I-Nym” inikeza isicelo esithathwe nge-Nostr key yakho, efakwe ku Izicelo ze-akhawunti ze-akhawuntiUkuze izixhobo ezinguquko ezinguquko ezivamile, bheka Izinzuzo ze-SDKs, futhi ngenxa yama-coding ama-agents ezifana ne-Claude Code, i-Codex ne-Cline, bheka Imishini ye-Code.