Okubelelwe elwazini / Iimveliso

API ukubuyekeza

Iimodeli, i-generator kunye ne-balance ezisetyenziswa kwi-app, kwi-code yakho. I-API ibizwa ne-OpenAI kunye ne-Anthropic, ngoko izixhobo ezininzi kunye ne-SDK zokusebenza ngokuguqulwa kwe-base URL kunye ne-key.

Eli phepha liguqulelwe ngoomatshini ukuze kube lula. Uqobo lwesiNgesi yinguqulelo esebenzayo.

Yintoni i-fire

I-API ye-HTTP nymbot.ai iingxelo efanayo i-OpenAI okanye i-Anthropic client. Uyakwazi ukufumana:

• Ukugqibela ChatYintoni Ukusabela API kwaye Imibuzo ye-Anthropic, kunye ne-streaming, izixhobo, iifoto, ukucaciswa kunye ne-web search, ngalinye iimodeli ezininzi Ukucaciswa kunye ne-auto-routing ye-Nymbot yayo.
• Ukucinga, ividiyo, Ukusabela, Ukucaciswa kwaye Ukucinga.
• Eyakho Ukucinga, Ukucinga Top-ups, Top-ups okuzenzakalelayo kwi wallet yakho i-A Ukucinga Yintoni iimali yeenkcukacha ngamnye.

Yintoni iingcebiso ziye zithunyelwe kwiiyure ezimbini Ukucinga Njengoko i-app, ngexabiso efanayo. Akukho i-subscription kunye ne-free allowance kwi-API: zonke iimfuno zithunyelwe kwi-credits eyenza.

Yintoni i-API ayikwazi ukongeza into ye-Nymbot yayo. Iingxelo zayo zithunyelwa kwimodeli xa uqhagamshelane: akukho i-Nymbot system prompt, akukho i-memory, akukho i-date okanye i-language hints. Yintoni i-reply ye-model kunye ne-note ye-cost.

Ukubuyekeza URL

Zonke iingxaki zihlala phantsi /api/v1/Umzila Olandelayo Ukulungiselela 404 yaye umzila oyaziwa ebizwa nge-methode engabonakali 405Zonke iintlobo ze-JSON.

I-API ithatha imibuzo ye-cross-origin ukusuka kwisayithi yehlabathi, ngoko i-browser page inokufumana. Yonke into efakwe kwi-browser inokufumana ngumntu onokufumana, kunjalo, ngoko kuza nje nge-key enezantsi UkucingaI-endpoints eyenziwe nge-nym yakho (i-keys, i-account summary, i-NWC auto-top-up kunye ne-refund redemption) zihlanganisa: kwi-browser zibonakalisa kuphela kwi-website ye-Nymbot. Qhagamshelana nezicelo ze-akhawunti.

Thumela yonke umzimba we-JSON Content-Type: application/jsonZonke iintlobo ezininzi ziquka 415, ngoko i-form HTML epheleleyo okanye a text/plain isicelo ukusuka kwisithili esinye ayikwazi ukufikelela kwi-API. Ngokusebenzisa i-cURL, ukufikelela -H "Content-Type: application/json" Ngexesha -d.

Izixhobo ze-fire

Iingcebiso ziyafumaneka kwi-app. Open Ukucinga kwi-side bar ye-web app, okanye kwi-menu kwi-Android kunye ne-iOS, kwaye Yenza Key. Wabelane i-imeyile kunye, ukuba ufuna, i-cap kunye nexesha lokugqibela.

I-key ifumaneka ngexesha elinye. Qhagamshelana kwindawo yokhuseleko ngaphambi kokufumana ifayile: I-Nymbot ibonelela kuphela i-fingerprint yayo, ngoko akakwazi ukunikezela kwakhona. I-key elidlulileyo ayikwazi ukufumana; uqhagamshelane kwaye uqhagamshele.

Umnqweno we-key kufuneka sk-nymbot- iiyure ze-43, iimpawu ze-digits, i-dashes kunye ne-undescores. I-app ibonisa yonke i-key ngegama yayo kunye ne-hint elincinci efana ne- sk-nymbot-Qm7x…c2Lw.

• Umnqweno umnqweno umnqweno umnqweno wakho. Oku kuthatha i-balance yakho, kwaye kuphela i-nym yakho inokukwazi ukwenza, ukuguqulwa okanye ukuguqulwa. Wonke umntu owenze i-key inokudibanisa, ngoko kuxhomekeka njenge-password.
• Iingxowa zihlanganisa. I-key ingaba i-spending cap, kwaye i-cap ingaba i-reset ngosuku zonke, ngexesha lonyaka (iMsombuluko) okanye ngenyanga lonyaka (i-first), ngexesha le 00:00 UTC. I-credits ezimbini zihlanganisa, i-credit ye-standard yi-10 sats kunye ne-credit ye-Pro yi-100 ngexesha elinye, ngoko kuxhomekeke i-credits eyenziwe ngexabiso. Phambi yokusebenza kwe-request, i-maxi ye-cost (i-rounded to whole credits) ibekwe kwi-credit eyenziwe ngexabiso. Ukuba ibekwe, i-request ibekwe ngexabiso. 403 key_limit_reached, nangona umxholo uya kuba phantsi kwe-cap; i-error ibonisa ukuba ixabiso efanayo kwaye xa i-cap ifumaneka. Ukunciphisa max_tokens I-request ibhaliswe ngexabiso yayo yaye kuxhomekeke kwi-cap, ngoko ukuba i-provider ibhalisele i-tokens ezininzi kunokuba ibhaliswe ngaphandle, isicelo esilandelayo esifanelekileyo inokufumana i-key ngaphantsi kwe-cap yayo; le ngexabiso esilandelayo ibhaliswe.
• I-cap esithathwe kuphela ukutshintshwa. I-key kwi-cap yaye unako ukuyifaka i-balance, ukuyifumana i-history, ukuyifaka iimodeli, ukuyifaka i-token, ukuyifaka kwaye ukuyifaka kwividiyo elidlulileyo.
• I-Expiry iye ye-optional. Emva kwexesha elidlulileyo, i-key ibhalisele ukusebenza.
• Ukuguqulwa kunokuba ngexesha lokugqibela kwaye ekugqibeleni. Umxholo we-revoked ungenza isicelo se-next. It ibekwe kwi-list, ibekwe yi-revoked, ngoko i-history yayo ye-spending yaye ibonakalayo.
• Ingaba unayo ukuya kwi-25 iingcebiso ezisebenzayo, ngamnye kunye nomnxeba yayo. Ukuguqulwa kwexesha le-reset ye-key uqala ixesha elitsha kwi-zero.

Ibhokisi elifanayo ibonisa ixabiso yeenkcukacha ngamnye kule ixesha kwaye ngokubanzi, xa isetyenziswe ngexesha elidlulileyo, zombini iibhanki zakho kunye nezicelo zakho ze-API ezidlulileyo. Iingxaki ze-endpoints ezilandelayo zithunyelwe phantsi: Ukulawula Key.

Ukubhalisa isicelo

Thumela i-key kwi-one of these headers. Zininzi i-equivalent, ngoko uthathe i-client yakho ifumaneka ngokufanelekileyo:

I-Returns ye-key ebangeni, engaziwayo, evulwe okanye ifumaneka 401Ngokutsho kweCode missing_api_key, invalid_api_key, revoked_api_key okanye expired_api_keyUkubhalisa iimodeli, iimodeli ze-audio kunye neengxaki, kunye neengxaki ze-payment ayidingi.

Iifoto, i-video, i-speech, i-transcription kunye ne-embeddings ziyafumaneka kwakhona ngexesha elinye nge-Lightning ngaphandle kwe-key: ukufumana i-request ngaphandle kwe-one kunye nokukhokha i-facture kwi-Lightning. 402 Qhagamshelana Ukubhalisa ngexesha elandelayo ngaphandle kwe-key.

Ukulungiselela i-key, i-account summary kunye ne-automatic top-ups ziquka iimeko: zithintela i-signature ye-nym yakho kunokuba i-key, ngoko i-key ebonakalayo ayikwazi ukwenza i-key ezininzi. Qhagamshelana nezicelo ze-akhawunti.

Isicelo sakho yokuqala

Yenza i-key kwi-variable ye-environment, emva kokuba uqhagamshelane ne-model into. Iimeko ezininzi zilandelayo zithunyelwa kwi 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-routing ye-Nymbot yayo, ifumaneka kwi-balance ye-standard. Yenza i-ID ye-catalogue model apho, njenge- anthropic/claude-sonnet-5, ukuba usebenzise le model ukusuka Pro isilinganiso. Iimodeli zeLista Ukubonisa yonke id.

Yintoni iimfuno

I-API ihlawula ngexesha elifanayo efana ne-app.

• Yintoni isilinganiso? nymbot/auto Yenza i Umgangatho isilinganiso (10 sats a credit). Zonke iimodeli ezininzi ze-chat iimveliso isilinganiso (100 sats a credit). I-standard image generator kunye ne-standard voice isilinganiso isilinganiso isilinganiso; yonke enye isilinganiso isilinganiso Pro. I-embeddings isilinganiso isilinganiso. I-transcription isilinganiso isilinganiso isilinganiso xa isilinganiso esilinganiso ingathengiswa, kwaye isilinganiso esilinganiso isilinganiso isilinganiso. I-model list ibonise le isilinganiso leyo zonke iimveliso isilinganiso.
• Yintoni. I-chat request ifumaneka kwi-token eyenziwa kwaye ifumaneka kwimodeli, ngexabiso zithunyelwe ye-providers. Le ngxabiso iye yengxabiso le-5% yaye ngexabiso ngexabiso le-1.5, ngoko uthatha i-1.575 amaxabiso yexabiso ye-list ye-providers. Iye ifumaneka kwi-sats kwi-credit ye-bitcoin yaye ifumaneka kwiiyure ezininzi ye-credit. Iifoto ze-pro, i-video kunye ne-speech zithunyelwe ngexabiso ngexabiso, ngexabiso ngexabiso ngexabiso ye-audio, kunye nexabiso kunye ne-margin efanayo. Iifoto ye-standard i-flat 5 i-credits
• Ubuncinane Yonke isicelo esilinganiswayo esebenza iindleko i-0.05 credit: i-half a set on the standard balance, i-5 sats on Pro. I-Fractions ye-credit zithunyelwe, akufutshane ngexesha elinye.
• Yenza, emva kokuba ukufikelela. Kwixesha lokugqibela, i-request inokufumana iindleko ezininzi kwi-balance yakho, ngokuxhomekeke kwimibelelwano yakho kwaye i-token ezininzi iye zithunyelwe. I-text ngaphandle kwe-ASCII yenzelwe kwi-Bytes ye-UTF-8, kwaye i-ASCII kunye ne-punctuation zithunyelwe njenge-token, ngoko i-text kwi-script, i-code kunye neenombolo zithunyelwe ngokupheleleyo. I-hold yi-credits epheleleyo, ngexesha elinye, ngoko nayiphi na isicelo kufuneka i-10 sats ezamahala kwi-balance ye-standard okanye i-100 sats kwi-Pro ukuqala. Kwixhomekeka kuphela i-cost efanelekileyo; i-rest ifumaneka xa 402 insufficient_balance ifayibha, kwaye yintlawulo efakwe. Ukuba i-cost efanelekileyo kunokuba i-balance engaphezulu, i-balance epheleleyo ifayibha, i-cost efanelekileyo (owed_sats Kwimeko nymbot into, kunye ne-balance ye-negative). Yintoni efanelekileyo ibhaliswe okokuqala kwi-credits ezilandelayo ezivela kwi-balance elandelayo. Ngaphandle kokuba ibhaliswe, akukho into kwi-balance efanelekileyo: akukho yi-API, i-response kwi-app, i-transfer okanye i-donation.
• Yintoni i-credit engaphezulu Ukuba i-balance ayikwazi ukufumana i-hold, isicelo kuxhaswa 402 ngaphambi kokuphumelela. I-error ibonisa ukuba i-balance yinto eliphantsi, i-sats ezininzi i-request kufuneka kwaye i-sats ezininzi ziyafumaneka. A max_tokens Yintoni iingxaki ezincinane.
• Ukukhangisa Ukukhangisa isicelo esikhoyo, ngaphandle kwe-provider ifayile umsebenzi esebenzayo ngaphambi kokukhangisa, okanye i-web search okanye i-web search. nymbot/auto Ukubuyekezwa kwebhizinisi kwakhona; ngoko ke yintoni unayo, ubuncinane i-0.05 credit. Umfutho ufakwe ufakwe kwi-token ebhaliwe ngu-provider: I-Nymbot ibandakanya ukubuyekeza umfutho we-provider ngexesha elide ukuya kwi-25 iiveki emva kokuba ufakele ukuba ufumane. Ukuba akuyona, umfutho ufakwe ukusuka kwimfuneko esithunyweyo kwaye ngexabiso, kwaye ngexabiso leyo kuquka inkqubo epheleleyo yokuthumela ye-hold. I-request eyona i-connection ebandakanya kwaye ibandakanya.
• WEB Ukucinga ixabiso $0.008 isantya, ifayilishwe kwi-sats, xa isantya ifakwe, ukuba imodeli uxhumane okanye ungenza. Iiphepha ezaziwa zithunyelwa kwimodeli njenge-input, ngoko zithunyelwe i-tokens zayo.

Zonke imibuzo ibonisa iindleko. Imibuzo ye-JSON ibonelela nymbot i-object kunye ne-balance ebhalisiweyo, i-cost kwi-credits kunye ne-sats, kunye ne-cost:

I-Cost Object

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

Iimpendulo ze-Payed zinezihlanganisa i-headers ezilandelayo, apho ukufuna i-cost ye-response ye-non-JSON, njenge-speech:

Iimali ngamilioni ze-token, eziquka iimali kunye ne-margin, ziyafumaneka Uluhlu Model USD kunye ne-SAT, kwaye I-Price SheetUkuba ixabiso le-Bitcoin ayikwazi ukufumana, iimfuno ze-payment iyafumaneka 503 price_unavailable Ukucinga Retry-After: 60 Ngaphandle kokufunda.

Ukucinga

Zonke ingxaki iye yintoni elifanayo, eyona iinkcukacha ze-OpenAI ziyafumaneka. code i-name enokufanelekileyo enokufanelekileyo; message Yintoni umntu, kwaye unako 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
  }
}

Kwiimeko ezimbini:

• /api/v1/messages iingcebiso kwi-Error format ye-Anthropic, njengoko oku nto i-Anthropic client ibonise: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. I-type ibandakanya i-status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error okanye overloaded_error (503).
• I-streaming request eyahlukileyo ngaphambi kokuqala ye-byte yayo yenza i-JSON epheleleyo kunye ne-status ephantsi, ayikho i-event stream. I-fail after the stream has started is sent as the stream's last event, in that endpoint's own format.

Iingcebiso ze-error akukwazi ukufumana iinkcukacha ze-internal ye-service ye-other. I-error ye-providers iyahlaziywa ngaphambi kokufumana.

Ukucaciswa

Umxokozelo kwifoto kufuneka ibonisa kwi-host ye-publish: i-address kwi-network ye-private okanye ye-local, okanye kwi-website ye-Nymbot, ibonakaliswa. I-Provider pacing ebonakalayo kwi-app ibandakanyeka kwakhona, ngoko umxokozelo we-requests kwi-provider eyodwa kunokukhutshwa kunokufutshana kunokufutshana kunokufutshana.

Yintoni i-Fire Can See

I-API ayi-private njengoko i-apps, kwaye kunokwenzeka ukuba ngexabiso malunga ne-how.

• Kwaye akukho end-to-end encrypted. Kwi-apps, umyalezo igcinwe kwi-device yakho ukuba i-keys kuphela ye-Nymbot ifumaneka kwaye ifumaneka njenge-Nymbot UkugqibaI-API ye-request yi-HTTPS embalwa: ifakwe ngexesha lokufika ku-Nymbot, kwaye i-server ye-Nymbot ibhekwa kwi-clear ukuyifaka.
• Imibuzo kunye nemibuzo ayikho. Zifumaneka kwimodeli kunye ne-response. Yintoni eyenziwa yi-akhawunti: ngalinye isicelo ixesha, i-model, i-type, i-token counting, i-cost, i-balance, i-key kunye nokufumana, iintsuku ze-90, nto leyo Qhagamshelana nathi Ukubonisa. I-record ye-usage ye-request efanayo (i-time, i-type, i-model, i-token count, i-cost, i-duration kunye ne-whether it used web search or succeeded) ibandakanya iintsuku ze-90, kunye ne-app yayo.
• Yonke into eyahlukileyo ye-nym i-small and listed here. Izixhobo ze-fire Zifumaneka njenge-hash, akukwazi ukufumana i-key, kunye ne-name, i-hint, i-spending cap, i-reset period, i-expiration and when they were made and last used; kuphela i-50 ezidlulileyo ziye zithunyelwe. Okuzenzakalelayo Top-up ukuxhumanisa i-wallet ifakwe ngokubethelwa, kunye ne-threshold, inani kunye ne-resultat ye-ultimate top-up. Iingxowa ze-video zithunyelwe kwiiyure ze-24. Iingxowa ze-payment ye-call zithunyelwa kuphela i-Lightning payment hash ye-7 iintsuku kunye ne-hashed refund token ye-30 iintsuku, ezihlangene ne-no nym. Iingxowa ze-balance ayikwazanga zithunyelwa njengoko zithunyelwe kuze kube ne-top-up zithunyelwe.
• Ukugqiba i-app ilawula. A izixhobo Wipe Ukukhusela kunye nokukhusela zonke i-API key, kunye nokukhusela i-history yeengxaki, iingxaki zokusetyenziswa, ukuxhumanisa i-wallet kunye neengxaki ze-video. I-balance kunye neengxaki ezininzi ezininzi ezidlulileyo ziyafumaneka kwi-nym.
• Umthengisi we-model uyazi isicelo yakhoIimodeli ze-catalogus zokusebenza kwi-makers zabo; iindlela ze-standard kunye ne-embeddings zokusebenza kwi-Cloudflare.
• Izixhobo ezisetyenzisiweyo ziyafumaneka ngokubanzi. Iifoto kunye neevidiyo ezidlulileyo njengezixhumanisi zithunyelwe kwiifayile ze-Blossom ezisemthethweni, apho i-address ye-file yinto ye-hash. Umntu omnye unayo i-link iya kufumana, kwaye i-Nymbot ayikwazi ukufumana kwakhona. Qhagamshelana b64_json kwaye umfanekiso ebonakalayo ifumaneka kwi-response kwaye ayidlulisiwe.
• Kwakhona iifoto ezifumana i-generator. Iifoto ezidlulileyo ezidlulileyo Ukucinga, okanye ushiye njenge a data: I-URL kwi-generator image_url, ifakwe kwi-host ye-Public Blossom yokuqala ukuze i-generator inokufumana, kwaye lo mnye kufanelekileyo. A image sent by https:// Iifoto kwi-chat request ziya ku-model's provider, ayikho kwi-Blossom.
• I-key ye-nym yakho ifumaneka kwi-nym yakho Yintoni iinkcukacha ze-key zithunyelwa kwi-balance ye-nym yakho, ngoko ukusetyenziswa kwe-API ayikho I-AnonymousUkuba ufuna ukusetyenziswa kwe-API ukuba ziyafumaneka ngaphandle kwe-nym yakho yobugcisa, nqakraza iingcebiso kwi-nym eyahlukileyo kunye ne-balance yayo.

Ukuba ufuna ukhuseleko kwi-apps, uthathe i-apps. I-API kunokwenzeka xa ufuna iimodeli kwi-tools yakho.

Zonke iinkcukacha

“Nym” kuthetha umxokozelo wamaNostr yakho, efumaneka kwi Qhagamshelana nezicelo ze-akhawuntiKuba izixhobo ezidlulileyo zixhomekeke kwiifomati zezi, bheka Izixhobo & SDKs, kunye neengxaki ze-coding efana ne-Claude Code, i-Codex kunye ne-Cline, bheka Izixhobo ze-Coding.