Base sa kahibalo / Mga Developer

Ang tanan makita

Ang mga modelo, mga generator ug balanse nga imong gamiton sa app, gikan sa imong kodin. Ang API naghisgot sa OpenAI ug Anthropic formats, aron ang daghang mga tool ug SDK magtrabaho sa pagmuha sa usa ka base URL ug usa ka key.

Kini nga panid gihubad sa makina alang sa kasayon. Ang English nga orihinal mao ang bersyon nga magamit.

Unsa ang API?

Ang HTTP API mao ang nymbot.ai nga nagpatin-aw sa sama nga mga panginahanglan sa usa ka OpenAI o Anthropic client nga karon nagpadala.

• Ang katapusan saAng Bukid Peanut Fire. ug Ang mensahe, uban sa streaming, mga tool, pictures, reasoning ug web search, alang sa matag modelo sa Ang Catalog Alang sa ubang mga dapit sa mao gihapon nga ngalan, tan-awa ang Nymbot.
• Mga Imahe, Ang video, Tungod niini, Ang transcript ug Ang.
• Ang imong Ang balanse, Ang tanan top-ups, Automatic top-ups gikan sa imong wallet Ang Ang historia Unsa ang kinatibuk-ang kinabuhi sa matag demand?

Adunay duha ka molupyo. Ang balanse Gikan sa usa ka subscription ug wala sa free allowance sa API: ang matag pagpangita gibutang gikan sa mga credits nga imong gikinahanglan.

Ang imong mensahe moabut ngadto sa modelo sa diha nga ikaw nagpadala kanila: walay Nymbot system prompt, walay memory, walay petsa o pinulongan sa pinulongan.

Ang mga URL

Ang tanan nga endpoints anaa sa /api/v1/Ang unknown path nagpatin-aw 404 Hapit nalukop sa kaumahan ang palibot sa Zapyškis.[5] 405Ang duha mao ang JSON.

Ang API nagpatin-aw sa cross-origin requests gikan sa bisan unsa nga site, aron ang usa ka browser page mahimo sa paghubad niini. Ang tanan nga imong magpadala ngadto sa usa ka browser mahimo sa pagtan-aw sa bisan unsa nga nagpadala niini, kay kini lamang sa usa ka key nga adunay usa ka gamay nga AngAng mga endpoints signed uban sa imong nym (keys, ang account summary, NWC auto-top-up ug refund redemption) mao ang usa ka pag-uswag: sa usa ka browser sila masabtan lamang sa mga website sa Nymbot. Pagtuon sa mga requests.

Gikan sa tanan ang JSON body. Content-Type: application/jsonAng ubang mga tawo wala moadto sa 415, ug ang usa ka simpleng HTML form o a text/plain Ang usa ka bahin sa usa ka bahin sa usa ka bahin sa usa ka bahin sa usa ka bahin sa usa ka bahin sa usa ka bahin. -H "Content-Type: application/json" Ang -d.

Ang tanang

Ang mga key gihimo sa app. Open Ang tanang sa sidebar sa web app, o sa menu sa Android ug iOS, ug tap Ang tanang keyIpahamtang ang usa ka ngalan ug, kung gusto mo, usa ka cap ug usa ka petsa sa pagpuasa.

Ang key mao ang gipakita sa usa ka pulong. Copy siya sa usa ka unsa unsa unsa nga lugar sa wala pa moabut ang sheet: Nymbot nag-alagad lamang sa usa ka fingerprint sa niini, aron kini dili makakita sa imong bag-o. Ang usa ka pag-usab key dili makahimo sa pag-usab; pag-usab kini ug paghimo sa usa ka lain-laing.

Ang key mao ang sk-nymbot- 43 ka letra, mga digit, dashes ug subscores. Ang app naglista sa matag key pinaagi sa iyang ngalan ug usa ka short hint sama sa: sk-nymbot-Qm7x…c2Lw.

• Ang usa ka key anaa sa imong nym. Kini nag-usab sa imong balanse, ug lamang ang imong nym mahimo sa paghimo, pag-usab o sa pag-usab niini. Ang tawo nga nag-usab sa key mahimo sa pag-usab niini, kay trat kini sama sa usa ka password.
• Ang mga butang anaa sa sats. Ang usa ka key adunay usa ka gasto cap, ug ang cap mahimong reset sa matag adlaw, sa matag semana (Monday) o sa matag bulan (sa unang), sa 00:00 UTC. Kini moapil sa duha ka balanse, usa ka standard credit sama sa 10 sats ug usa ka Pro credit sama sa 100, aron kini mao ang sama sa bisan unsa nga balanse ang usa ka request gipaila. Unya ang usa ka request moapil, ang labing taas nga kini mahimong gipaila (sa pagbalhin ngadto sa tibuok mga credits) mao ang gipaila laban sa unsa ang mahitungod sa cap. Kung kini dili makabaton, ang requests nga gikuha sa 403 key_limit_reached, bisan kon ang solusyon makahimo sa ubos sa cap; ang bug-os nag-ingon kon unsa ang gidak-on ug kada ang cap reset. max_tokens Ang usa ka pag-atubangan mao ang kinatibuk-ang gastos ug nga gitawag sa cap, kay kon ang provider nag-report sa labaw pa kay sa mga tokens nga gitawag, ang pinakabag-o nga pag-atubangan nga makahimo makahimo ang key sa usa ka paagi sa iyang cap; ang susunod nga mao ang pag-atubangan.
• Ang usa ka bug-os nga kapisanan lamang nagpatin-aw sa gasto. Ang usa ka key sa iyang cap mahimo pa sa pag-check sa balanse, tan-awa ang iyang kasaysayan, listahan sa mga modelo, sayon sa tokens, top up ug tan-awa sa usa ka video nga kini nagpatin-aw.
• Ang ekspiry mao ang optional. Sa pag-set sa petsa, ang key nagpatuman sa pagtrabaho.
• Ang pagbansay mao ang immediate ug final. Ang usa ka revoiced key misulod sa iyang susunod nga request. Kini mao ang sa listahan, nga gitawag nga revoiced, aron ang iyang history sa gasto usab makahimo.
• Alang sa ubang mga dapit sa mao gihapon nga ngalan, tan-awa ang 25 ka mga key.

Ang sama nga pahina nagpakita sa pag-uswag sa matag key niini nga panahon ug sa tibuok, kada kini na-usab, ang imong balanse, ug ang imong kasundalohan sa API. Ang mga key.

Ipahamtang ang request

Ipahamtang ang mga butang alang sa pagpakig-uswag ug pag-uswag ug pag-uswag sa mga butang:

Ang usa ka missing, unknown, revoked o expired key returns 401Ang code sa missing_api_key, invalid_api_key, revoked_api_key Ang expired_api_keyAng listahan sa mga modelo, mga modelo sa audio ug mga vokal, ug mga paraan sa pagbayad dili kinahanglan nga key.

Mga pictures, video, speech, transcription ug embeddings usab mahimo sa pagbayad alang sa usa ka request sa usa ka panahon sa Lightning uban sa bisan unsa nga key sa tanan: pagpadala ang request sa wala sa usa ug pagbayad sa kalikasan sa 402 Ang Pagbayad alang sa pagtan-aw uban sa usa ka key.

Key management, ang account summary ug automatic top-ups mao ang usa ka eksensiya: sila makuha sa usa ka signature gikan sa imong nym sa ibabaw sa usa ka key, aron ang usa ka leaked key dili makahimo sa dugang mga keys. Pagtuon sa mga requests.

Ang unang request

Ipahamtang ang key sa usa ka environmental variable, ug unya misulti sa usa ka modelo sa usa ka butang. 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 mao ang Nymbot's own routing, pagbayad gikan sa usa ka standard nga balanse. I-set ang usa ka catalog model's id sa palibot niini, sama sa anthropic/claude-sonnet-5, aron sa paggamit niini nga modelo gikan sa Pro balanse. Ang mga modelo Ipahamtang ang ID.

Unsa ang gastos sa request?

Ang API bills sama sa paagi sa app.

• Unsa ang balanse? nymbot/auto Gikan sa Ang Standard balanse (10 sats a credit). Ang matag lain-laing modelo sa chat Ang balanse (100 sats usa ka credit). Ang standard image generator ug ang standard voice gasto sa standard credits; ang uban nga generator gasto sa Pro. Embeddings gasto sa standard credits. Transcription gasto sa standard credits kada ang standard balance mahimo sa pagtukod niini, ug Pro credits lainlaing. Ang list sa mga modelo nag-ingon nga balanse sa matag modelo gasto.
• Unsa ang Ang usa ka chat request mao ang mitawag sa mga tokens nga ang modelo sa katapusan nabasa ug gisulat, sa mga rate sa provider nga gipublikado. Ang presyo adunay usa ka 5% nga bayad ug unya gihubad sa 1.5, aron imong magbayad sa 1.575 ka beses sa listahan nga presyo sa provider. Kini mao ang konverted sa sats sa live Bitcoin presyo ug gitawag sa mga thousandths sa usa ka credit. Pro pictures, video ug speech mao ang priced per generation, per second o per character, ug transcription per second sa audio, uban sa sama nga bayad ug margin. Ang standard picture mao ang usa ka flat 5 standard credits ug ang standard voice usa ka flat 3.
• Ang minimum. Ang matag metric request nga moapil ang mga gastos sa ubos pa kay sa 0.05 credit: half a sat sa standard balance, 5 sats sa Pro.
• Pagtuon, ug sa katapusan Alang sa ubang mga dapit sa mao gihapon nga ngalan, tan-awa ang ASCII, nga mao ang usa ka labing maayo nga bahin sa pag-usab. Ang usa ka bahin sa pag-usab mao ang usa ka labing maayo nga bahin sa pag-usab. Ang usa ka bahin sa pag-usab mao ang usa ka labing maayo nga bahin sa pag-usab. 402 insufficient_balance Adunay nangutana, “O Mensahero ni Allah, kinsa ang makasulod sa Paraiso?”owed_sats Ang nymbot Ang kinatibuk-ang kinabuhi, ug usa ka negatibuk-ang balanse). Ang kinabuhi nagbayad sa unang gikan sa susunod nga mga kredito nga makabaton sa balanse. Unsa kini pagbayad, bisan unsa ang kinabuhi sa balanse sa pag-usab: dili sa API, mga replies sa app, usa ka transfer o usa ka regalo.
• Maayo ang credit. Alang sa ubang mga dapit sa mao gihapon nga ngalan, tan-awa ang 402 Ang bug-os nag-ingon kung unsa ang balanse mao ang short, unsa ang mga sats ang kinahanglanon ug unsa ang ilang mao ang free. max_tokens Maayo kaayo ang hold.
• Ang tanan. Ang usa ka pag-usab sa pag-usab dili mahimo, sa diha nga ang provider gibaligya alang sa mga trabaho nga iyang gihimo sa paagi sa pag-usab, o sa usa ka web search o sa pag-usab sa pag-usab. nymbot/auto Ang usa ka stream nga i-cut off gibutang alang sa mga tokens nga ang provider nag-report: Nymbot nagtan-aw sa pag-read sa provider nga stream alang sa upat ka 25 segundo sa diha nga ikaw moadto aron sa pagkuha sa pag-account. Kung kini dili makabaton, ang pag-account gibutang gikan sa mga butang nga i-send ug sa mga butang nga gitawag, ug alang sa usa ka modelo nga mga dahilan kini naglakip sa tibuok output allowance sa hold.
• Ang web search $0.008 usa ka pagtan-aw, konverted sa sats, sa diha nga usa ka pagtan-aw gihimo, kon ang modelo unya responda o mosugot. Ang mga panid nga nabasa mao ang magpadala sa modelo ingon sa input, aron sila magpadala sa mga token niini.

Ang matag responsiyon nag-ingon kon unsa ang gastos. JSON responses carry a nymbot Ang objekto sa balanse sa pagbayad gikan niini, ang bayad sa credits ug sats, ug unsa ang gibutang:

Ang objekto sa

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

Ang pagbayad nga mga pag-uswag usab adunay mga headers, nga mao ang diin sa pagtan-aw alang sa gastos sa usa ka pag-uswag nga dili JSON, sama sa pag-uswag:

Ang mga rate sa matag milyong token, nga karon naglakip sa fee ug margin, anaa sa Ang listahan Ang Dollar ug ang SATA, ug ang Ang presyo saKung ang presyo sa Bitcoin dili makakita, pagpatin-aw ang mga requests. 503 price_unavailable Ang Retry-After: 60 Ipahamtang ang tingog.

Ang error

Ang matag bug mao ang sama nga shape, usa ka OpenAI mga kliyente karon mahibalo. code Naa kay pasumbingay, naa kay pasumbingay message Naa kay pasumbingay!

Ang mga Corps

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

2 Ang tanang

• /api/v1/messages ang mga tubag sa antropic sa error format, tungod kay kini mao ang sa antropic mga kliyente parse: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Ang usa ka tawo nagtuo sa status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error Ang overloaded_error (503).
• Ang usa ka streaming request nga mosugot sa wala pa sa unang byte sa usa ka normal nga JSON error uban sa status sa ibabaw, sa wala pa sa usa ka event stream.

Ang mga mensahe sa bug wala naglakip sa internal detalye sa usa ka lain-laing serbisyo. Ang usa ka provider sa iyang error reworded sa wala pa moabot sa imong.

Ang limitahan

Ang usa ka link ngadto sa usa ka imahe kinahanglan nga moabut sa usa ka public host: usa ka address sa usa ka private o local network, o sa Nymbot nga mga website, mao ang rejected.

Wa na ko kaila adtong mga ilimnona

Ang API dili private sa paagi sa mga apps, ug kini mao ang makahimo sa pagtuon bahin sa kung paano.

• Kini dili end-to-end nga encrypted. Sa mga apps, usa ka mensahe nga gibuhat sa imong device ngadto sa mga keys lamang ang Nymbot nagtan-aw ug gibuhat ingon sa usa ka Ang tanangAng usa ka API request mao ang ordinaryong HTTPS: kini mao ang encrypted sa dalan ngadto sa Nymbot, ug ang server sa Nymbot makakita niini sa clear aron sa pag-manage niini.
• Ang mga sumbanan ug mga reaksiyon dili makahimo. Unsay gibuhat mao ang bill: alang sa matag panginahanglan ang panahon, modelo, matang, token count, gasto, balanse, key ug sa pag-usab, alang sa 90 ka adlaw, nga mao ang Tungod niini, ang Ang usa ka log sa paggamit sa usa ka panglantaw (time, type, model, token counts, cost, duration ug bisan unsa nga naggamit sa web search o nasayud) usab gibuhat alang sa 90 ka adlaw, uban sa app sa iyang.
• Ang tanan nga lain-lain nga gitawag alang sa usa ka nym mao ang gamay ug gisulat dinhi. Ang tanang Kini mao ang usa ka hash, dili ang key, uban sa iyang ngalan, usa ka short hint, gasto cap, reset period, expiration ug kada sila gitukod ug ang katapusan nga gigamit; lamang ang pinakabag-o nga 50 revoked keys gibuhat. Ang mga top-up Ang paghubad sa wallet gibuhat sa encrypted, uban sa iyang threshold, halos ug ang resulta sa pinakaduol nga top-up. Video jobs gibuhat alang sa 24 ka oras. Ang mga requests pagbayad sa matag paghubad maglakip lamang sa usa ka Lightning pagbayad hash alang sa 7 ka adlaw ug usa ka hashed reimbursement token alang sa 30 ka adlaw, nga naghubad sa bisan unsa nga nym. Charges nga usa ka balanse wala makabaton nga gibuhat sa ingon sa kinahanglanon hangtod sa usa ka top-up pagbayad kanila.
• Gikan sa usa ka app ang gihimo niini. A Bukid Peanut Pag-usab ug pag-usab ang matag API key, ug pag-usab ang history sa query, mga log sa paggamit, koneksyon sa wallet ug mga trabaho sa video. Ang balanse ug ang bisan unsa nga mga gastos nga gikinahanglan mag-usab.
• Ang provider sa modelo makita ang imong requestAng mga modelo sa Catalog magsugod sa mga makina; ang standard routes ug embeddings magsugod sa Cloudflare.
• Ang mga media mao ang publikong. Ang mga imahe ug video nga gihimo sama sa mga link nag-upload sa public Blossom file hosts, diin ang address sa usa ka file mao ang iyang hash. Ang tanan nga adunay ang link mahimo sa pagpadala niini, ug ang Nymbot dili mahimo sa pagpadala niini. b64_json ug ang usa ka imahe nga gihimo gibuhat sa pag-atubangan ug wala pa mo-upload.
• Kini mao ang mga imahe nga moabut sa usa ka generator. Ang mga imahe nga upload sa AngDili sila gibuhat sa a data: Ang mga URL sa generator image_url, sa pag-upload sa usa ka publikong Blossom host sa una aron ang generator makahimo sa pagkuha niini, ug ang sama nagpatin-aw sa niini. https:// Ang mga imahe sa usa ka chat request moadto sa provider sa modelo, dili sa Blossom.
• Ang usa ka key anaa sa imong nym. Ang tanan nga gasto sa usa ka key moabut gikan sa balanse sa imong nym, aron ang paggamit sa API dili AngAlang sa ubang mga dapit sa mao gihapon nga ngalan, tan-awa ang ilang mga dapit sa ubang mga dapit sa mao gihapon nga ngalan.

Alang sa ubang mga dapit sa mao gihapon nga ngalan, tan-awa ang API.

Ang ilang endpoints

“Nym” mao ang usa ka request nga gitawag sa imong Nostr key, nga gibuhat sa Pagtuon sa mga requestsAlang sa mga instrumento nga anaa sa mga format, tan-awa ang Ang mga tool ug SDKs, ug alang sa mga coding agents sama sa Claude Code, Codex ug Cline, tan-awa ang Mga Tool sa Coding.