Konesans baz / Devlopè

API vèsyon

Modèl yo, jeneratè ak balans ou itilize nan app a, soti nan kòd ou pwòp. API a pale sou OpenAI ak Antropic fòma, se konsa pi fò nan zouti ak SDKs travay pa chanje yon URL baz ak yon kle.

Paj sa a se machin-tradui pou konvenyans. Orijinal angle a se vèsyon ki aplike a.

Ki sa ki nan API se

Yon HTTP API sou nymbot.ai ki reponn a menm demann ki deja voye yon OpenAI oswa Anthropic kliyan. Ou jwenn:

• Chat konplètmannan Reply nan API epi Mesaj Antropik, ak streaming, zouti, imaj, rezonans ak rechèch sou entènèt, pou chak modèl nan Kataloz ak pou routaj otomatik nan Nymbot pwòp.
• imaj, Videyo, Diskisyon, Transkripsyon epi Pwodwi pou.
• Ou balans, Lightning nan top-ups, otomatik top-ups soti nan portefeuille ou Epi a Istwa Ki sa ki koute chak demann.

Li se peye soti nan menm de balans pa gen okenn abònman ak pa gen okenn frè sou API a: chak demann se peye soti nan kredi ou te achte.

Ki sa ki API a pa fè se ajoute anyen nan pwòp Nymbot la. Mesaj ou ale nan modèl la kòm ou te voye yo: pa gen okenn Nymbot sistèm rekòmandasyon, pa gen memwa, pa gen anyen dat oswa lang. Ki sa ki vini tounen se repons la nan modèl la ak yon note sou sa ki koute li.

Baze nan URLs

Tout Endpoint ap viv anba /api/v1/Yon chemen inik retounen 404 ak yon chemen konnen rele ak metòd la erè retire 405tou de tankou JSON.

API a reponn demann atravè orijin soti nan nenpòt sit, se konsa yon paj navigatè ka rele li. Tout bagay ou voye nan yon navigatè ka li pa nenpòt moun ki louvri li, sepandan, se konsa sèlman fè sa ak yon kle ki gen yon ti jan KòmanseEndpoints sigare ak nym ou a (klav, konvèsyon kont, NWC otomatik-top-up ak refòm rediksyon) yo se eksepsyon an: nan yon navigatè yo reponn sèlman sit Nymbot pwòp yo. Al gade nan Signature Konte Demand.

voye chak kò JSON ak Content-Type: application/jsonTout lòt kalite se refize ak 415, se konsa yon fòm HTML senp oswa yon text/plain demann soti nan yon lòt sit pa ka rive nan API la. Avèk cURL, pase -H "Content-Type: application/json" ansanm ak -d.

Fire kle nan

Klavye yo te fè nan app la. Open Fwa nan sidebar la nan aplikasyon entènèt la, oswa nan meni a sou Android ak iOS, epi touche Kreye yon kleJwenn yon non ak, si ou vle, yon kouvèti ak yon dat expiration.

Yon fwa kle a montre. Kopye li nan yon kote san danje anvan ou fèmen blòk la: Nymbot kenbe sèlman yon odyo nan li, se konsa li pa ka montre li nan ou ankò. Yon klavye manke pa ka retabli; revoke li ak fè yon lòt.

Yon kle sanble sk-nymbot- ki te swiv pa 43 letrin, cif, dashes ak underscores. Aplikasyon an lis chak kle pa non li yo ak yon pwen kout tankou: sk-nymbot-Qm7x…c2Lw.

• Yon kle apwopriye nan nym ou. Li chanje balans ou, ak sèlman nim ou ka fè, chanje oswa revoke li. Tout moun ki kenbe kle a ka chanje ak li, se konsa trete li kòm yon senp.
• Kaps yo se nan sats. Yon kle ka gen yon kap koute, ak kap la ka resete chak jou, chak semèn (Monday) oswa chak mwa (premye), nan 00:00 UTC. Li kantite tou de balans, yon kredi estanda kòm 10 sats ak yon kredi Pro kòm 100, se konsa li vle di menm bagay la nenpòt ki balans yon demann pase. Anvan yon demann kouri, pifò ke li ta ka koute (kouri jiska kredi tout) se mete kont sa ki rete nan kap la. Si li pa kouvri, demann la se refize ak 403 key_limit_reached, menm si repons la te vini anba kap; erè a di ki kantite lajan ki rete ak lè kap la resèt. max_tokens Yon demann se chaje ki sa li reyèlman koute ak sa a konte kont kap, se konsa si founisè a rapòte plis token pase yo te mete deyò, dènye demann ki kouvri ka pran kle a yon ti kras pase kap li yo; sa a pwochen se Lè sa a, refize.
• Yon chape ki te itilize sèlman sispann chanjman. Yon kle nan tèt li ka toujou tcheke balans la, li istwa li yo, lis modèl yo, kantite token yo, top up ak tcheke sou yon videyo li te deja kòmanse.
• Expiry se opsyonèl. Apre dat la ou mete, kle a ap sispann travay.
• Revokasyon se imedyatman ak final. Yon klavye revoke manke pwogrè pwochen li yo. Li rete nan lis la, etidye revoke, se konsa istorik la nan depans li toujou vle di.
• Ou ka gen jiska 25 kle aktif, chak nan yo ak non pwòp li yo. Chanje peryòd reset la nan yon kle kòmanse yon peryòd nouvo soti nan zero.

Fèy la menm montre chanjman chak kle nan peryòd sa a ak nan total, lè li te dènyèman itilize, tou de balans ou yo, ak demand API dènye ou. Endpoints ki anba li yo dokimante anba a Manadjè kle.

Authenticate yon demann

voye kle a nan nenpòt nan tèt sa yo. Yo se ekivalan, se konsa sèvi ak sa kliyan ou voye pa default:

Yon retouche manke, inik, revoke oswa ki te fini 401avèk kòd la missing_api_key, invalid_api_key, revoked_api_key ou expired_api_keyListing modèl, modèl odyo ak vwa, ak metòd peman pa bezwen yon kle.

Foto, videyo, pale, transkripsyon ak embeddings kapab tou peye pou yon sèl demann nan yon fwa sou Lightning san yo pa kle nan tout: voye demann an san yo pa yon sèl ak peye faktè a nan 402 Reply nan Peye sou demann san yon kle.

jesyon kle, konvèti kont ak otomatik top-ups yo se eksepsyon an: yo pran yon siyifikasyon soti nan nym ou olye pou yon kle, se konsa yon kle lekte pa ka fè plis kle. Signature Konte Demand.

Premye demann ou

mete kle a nan yon varyab anviwònman, Lè sa a, mande yon modèl yon bagay. Egzanp yo nan tout paj sa yo li soti nan 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 se Nymbot pwòp routaj, peye soti nan balans la estanda. mete id yon modèl kataloz nan plas la, tankou anthropic/claude-sonnet-5, pou sèvi ak modèl sa a soti nan balans la Pro. Modèl lis Jwenn chak ID.

Ki jan yon demann koute

API a factures nan menm fason ki app a fè.

• Yon balans ki. nymbot/auto Pwodwi pou estanda balans (10 sats yon kredi). Tout lòt modèl chat pase Pou balans (100 sats yon kredi). Jeneratè imaj estanda ak vwa estanda pase kredi estanda; chak lòt jeneratè pase Pro. Embeddings pase kredi estanda. Transkripsyon pase kredi estanda lè balans estanda ka kouvri li, ak kredi Pro anyen. List la modèl di ki balans chak modèl pase.
• Ki jan anpil. Yon demann chat se mete sou token yo modèl la reyèlman li ak ekri, nan pri a pibliye nan founisè a. Pri sa a gen yon frè ajoute 5% ak Lè sa a, li se multipli pa 1.5, se konsa ou peye 1.575 fwa pri a lis nan founisè a. Li se konvèti nan frè nan pri a Bitcoin viv ak chaje nan milye-ti nan yon kredi. Foto Pro, videyo ak pale se pri pou chak jenerasyon, pou chak sekondè oswa pou chak karaktè, ak transkripsyon pou chak sekondè nan odyo, ak menm frè ak marje. imaj la estanda se yon plat 5 kredi estanda ak vwa a estanda yon plat 3.
• minimòm nan. Tout demann mete ki kouri koute yon minimòm de 0.05 kredi: mwatye yon sit sou balans la estanda, 5 sats sou Pro. Fraksyon nan yon kredi yo pote sou, pa woule sou chak fwa.
• Lè sa a, kenbe. Anvan yon demann kouri, pi plis ke li ka koute se kenbe soti nan balans ou, ki baze sou sa ou te voye ak pi token li ka ekri. Tèks deyò ASCII senp se gwosè soti nan UTF-8 byte li yo, ak nimewo ASCII ak pousantaj konekte kòm yon token chak, se konsa tèks nan nenpòt skript, kòd ak nimewo yo kenbe pou plen. Tèks la se nan kredi tout antye, omwen youn, se konsa nenpòt demann bezwen omwen 10 sats gratis sou balans la estanda oswa 100 sats sou Pro yo kòmanse. Se sèlman pri a reyèl chaje; rest la se libere lè li fini. Yon demann long kenbe tèt li pou tan li kouri; si kredi ki te kenbe ap rete disponib de tout fason, yon flux mete ak yon 402 insufficient_balance Si lajan an reyèl se pi plis pase balans la ka peye, balans la tout antye se pran, rest la se peye (owed_sats nan nymbot Objè, ak yon balans negatif). Ki sa ki debite se peye premye soti nan kredi pwochen ki rive nan balans sa a. Anvan li te peye, pa gen anyen sou balans sa a ka pase: pa pa API a, repons nan app la, yon transfè oswa yon kado.
• Pa gen okenn kredi. Si balans la pa ka kouvri posesyon an, demann an se refize ak 402 anvan yon bagay kouri. Erè a di ki balans se kout, ki kantite sats mande bezwen ak ki kantite yo gratis. Yon ti max_tokens vle di yon ti tanperati.
• Kòmanse. Yon demann ki manke pa koute pa gen okenn, si founisè a te facture pou travay la li te fè anvan manke, oswa yon rechèch sou entènèt oswa nymbot/auto Task tcheke te deja kouri; Lè sa a, sa a se sa ou peye, omwen 0.05 kredi. Yon flux ou koupe se chaje pou token yo founisè a rapòte: Nymbot kontinye li flux la nan founisè a pou jiska 25 segonn apre ou ale pou jwenn kont sa a. Si li pa rive, chaj la se estime soti nan sa ou te voye ak sa ki te ekri, ak pou yon modèl ki rezon sa a li gen ladan tout admisyon pwodiksyon an nan rete a. Yon demann ki koneksyon la chita toujou fini ak se chaje.
• Web rechèch koute $ 0.008 yon rechèch, konvèti nan sats, lè yon rechèch te kouri, si modèl la Lè sa a reponn oswa échoue. Paj sa a li li se tou voye nan modèl la kòm entwodiksyon, se konsa yo ajoute token yo.

Tout repons di ki jan li koute. Repons yo JSON pote yon nymbot objekte ak balans la li te peye soti nan, frè a nan kredi ak sats, ak sa ki rete:

Objè nan pri

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

Peye repons yo tou pote tèt sa yo, ki se kote yo gade pou pri a nan yon repons ki pa JSON, tankou pale:

Tarif pou chak milyon token, deja ki gen ladan frè a ak marje, yo nan Modèl lis nan dolè ak sats, ak sou Pwodwi pou TelefònSi pri a nan Bitcoin pa ka li, demann peye retire 503 price_unavailable ak Retry-After: 60 Plis pase yo te panse.

Erè

Tout erè gen menm fòm, yon sèl OpenAI kliyan deja konprann. code se yon non ki estab ou ka matche ak; message se pou moun ak ka chanje.

Corps nan erè

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

Gen de eksepsyon:

• /api/v1/messages repons nan fòma erè nan Anthropic, paske sa a se sa ki kliyan nan Anthropic analize: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Tip la swiv estati a: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error ou overloaded_error (503).
• Yon demann difizyon ki échoue anvan premye byte li yo jwenn yon erè JSON nòmal ak estati a pi wo a, pa yon stream evènman. Yon échec après le stream a commencé est envoyée comme le dernier événement du stream, dans le format propre de ce bouton.

Mesaj erè pa janm gen detay enteryè nan yon lòt sèvis. Erè pwòp yon founisè se reworded anvan li rive nan ou.

Limite

Yon lyen nan yon imaj dwe montre nan yon òdinatè piblik: yon adrès sou yon rezo prive oswa lokal, oswa sou sit yo pwòp nan Nymbot, se refize. Patisyon founisè ki aplike nan app a aplike isit la tou, se konsa yon eksplozyon nan demann nan yon sèl founisè ka ralanti pi wo a rezoud.

Ki sa ki nan API ka wè

API a se pa prive nan fason ki apps yo se, epi li vo dwe egzak sou ki jan.

• Li se pa end-to-end encrypted. Nan aplikasyon yo, yon mesaj se selebre sou aparèy ou nan kle sèlman Nymbot kenbe ak vwayaje kòm yon Pwodwi pouYon demann API se HTTPS òdinè: li se enkripsyon sou wout la nan Nymbot, ak sèvè a nan Nymbot li li nan klè a fè fas a li.
• Prompts ak repons yo pa sove. Yo pase nan modèl la ak repons la pase tounen. Ki sa ki kenbe se bill: pou chak demann tan, modèl, kalite, kantite token, pri, balans, kle ak si li te siksè, pou 90 jou, ki se sa ki Istwa nan Yon dosye itilize nan menm demann an (tan, kalite, modèl, kantite token, pri, tan ak si li te itilize rechèch sou entènèt la oswa te siksè) se tou kenbe pou 90 jou, ansanm ak app la pwòp.
• Tout lòt ki te kenbe pou yon nim se ti ak lis isit la. Fire kle nan yo sove kòm yon hash, pa janm kle a, ak non yo, yon pwen kout, chanjman kap, reset peryòd, expiration ak lè yo te fè ak dènye itilize; sèlman dènye 50 kle revoke yo kenbe. Otomatik Top-up nan koneksyon portefeuille estoke encrypted, ak limit li yo, kantite lajan ak rezilta a nan dènye a top-up. travay videyo yo kenbe pou 24 èdtan. Demand ki peye pou chak apèl kite sèlman yon Lightning peman hash pou 7 jou ak yon hashed refòm token pou 30 jou, ki gen rapò ak pa gen okenn nim. Charges yon balans pa ka kouvri yo te kenbe kòm debite jiskaske yon top-up peye yo.
• Wiping app la retire li. A aparèy wipe revoke ak retire chak kle API, epi retire istorik la nan kesyon, dosye itilizasyon, koneksyon wallet ak travay videyo. balans la ak nenpòt ki frè ki toujou debite rete sou nime.
• founisè modèl la wè demann ouModèl kataloz kouri nan makè yo; wout estanda ak embeddings kouri sou Cloudflare.
• Medya ki te kreye se piblik. imaj ak videyo ki livrezon kòm lyen yo te uploade nan otè dosye piblik Blossom, kote adrès la nan yon dosye se hash li yo. Tout moun ki gen lyen an ka louvri li, ak Nymbot pa ka retabli li. Demande pou b64_json ak yon imaj ki te kreye vin tounen nan repons la epi yo pa janm ankouraje.
• Epitou yo se foto ou bay yon jeneratè. Yon foto ou upload nan Edit nan, oswa voye kòm a data: URL nan yon jeneratè image_url, se uploade nan yon òdinatè piblik Blossom an premye pou jeneratè a ka retire li, ak menm bagay la aplike pou li. Yon imaj voye pa https:// imaj nan yon demann chat ale nan founisè modèl la, pa nan Blossom.
• Yon kle se lye ak nym ou. Tout bagay yon kle pase soti nan balans an nan nim ou, se konsa itilize API se pa AnonimSi ou vle itilize API kenbe deyò nan chak jou nym ou, fè kle yo soti nan yon nym separe ak balans pwòp li yo.

Si ou bezwen pwoteksyon nan aplikasyon yo, itilize aplikasyon yo. API a se pou lè ou bezwen modèl yo nan zouti pwòp ou yo.

Tout Endpoints

“Nym” vle di yon demann sigare pa kle Nostr ou a, ki dekri nan Signature Konte DemandPou zouti ki deja pale fòma sa yo, wè Zouti ak SDKs, ak pou ajan kodaj tankou Claude Code, Codex ak Cline, wè Zouti kodaj.