Nheyo yezivo / Vanakovaka micheto

Pfupiso yeAPI

Mamodheru, generators nebalance yaunoshandisa mune app, kubva kucode yako pachako. API inotaura mafomati eOpenAI naAnthropic, saka zvakawanda zvishandiso neSDK dzinoshanda nekuchinja base URL nekiyi.

Peji ino yakaturikirwa nemuchina kuti zvirerukire. ChiRungu chepakutanga ndiyo shanduro inoshanda.

API chii?

HTTP API imwe pa nymbot.ai izvinobatsira mibvunzo yakafanana neiyose inomirirwa ne OpenAI kana Anthropic client anozotiitirawo. Unowana:

• Kugadziridzwa kweMakurukuri, iye Mhinduro API uye Meseji dzeAnthropic, nekuwedzera kwemishandisirwo yemagadzirirwo, zvishandiso, mifananidzo, kufunga nekuongorora zviri pawebhu, kumhando dzese dzemodeli dziri mu bhuku rezvinhu uye yekuzvitorera kweNymbot pachayairwa.
• Mifanidzo, vhidiyo, shoko, kunyora zvinhu zviri kutaura uye Zvakaiswa mukati.
• Your kurwisana, Kuzadza kwemamiriyoni eLightning, kuzadza mari zvakare zvoga kubva muma wallet ako uye a nhoroondo kwekuti chikumbiro chimwe nechimwe chinodhura zvakadini.

Inobhadharwa kubva kune vamwe vaviri vakafanana mabudiriro emari se application, pamitengo iyoiyo. Hapana kuderera kwekushandisa (subscription) uye hapana zvikamu zvisina mubhadharo paAPI: chikumbiro chimwe nechimwe chinobhadharwa nemari yamakatenga (credits).

ZvaAPI isisati zvito ndezvekuti hausi kuwedzera chinhu cheNymbot pachayo. Meseji dzenyu inofambira kumodeli sezvamadzitora: hapana Nymbot system prompt, hapana yeuchapenzi, hapana zuva kana zvinhu zvekuziva mutauro. Chinhu chinodzoka ndechimhinduro yemodeli uye chinyorwa chinoratidza kuti zvakakudza zvakadii.

Ma URL ekutanga

Endpoint imwe neimwe inowanikwa pasi pem /api/v1/. Nzira isingazivikanwi inodzoka 404 uye nzira yakazivikanwa yakadaiyo yakadanidzwa nemanyorerwo asiri akakodzera inodzorera 405, zvose semJSON.

API inopindura zvikumbiro zvinobva kune imwe nzvimbo, saka peji yerunako inogona kuisvitsa. Zvisinei, zvose zvaunotumira kune runako zvinogona kuverengwa neanumbe anovhura izvozvo, saka ita izvozvo chete nechavechi ine chidiki bhaziMazwi ekupedzisira akanyorwa nemazita ako (machira, pfupiso yeakaunti, kudzishandisa zvakazvimirira neNWC uye kudzorera mari) ndivo anopfuura mitemo: mubhrowusa anopindura mawebhusaiti eNymbot chete. Onai kusaina zvido zvekuvhura akaunti.

Tumira JSON body imwe neimwe nayo ne Content-Type: application/jsonImwe chete imhando yechinhu inorambwa ne 415, saka fomu yemHTML yakaderera kana text/plain kukumbira kubva ku- imwe site haikwanisi kusvika kuAPI. Ne cURL, isa -H "Content-Type: application/json" pamwe chete na -d.

MaAPI keys

Maki anogadzirwa muapp. Vhura API mupanda wewebu app, kana mugwaro we Android ne iOS, wobata Gadzira kiyiUipe zita uye, kana uchida, kapu nemusi wekugumira.

Makanoko anoratidzwa kamwe chete. Upanike panovimbika musati wavhara peji iri: Nymbot inochengetedza chidimbu chechinhu ichocho chete, saka haizokwanisi kukuratidza zvakare. Makanoko akarasika haagoni kuvandudzwa; pazawo uye ugadzire mamwe.

Muchiita sekuti sk-nymbot- kuripiswa nemavara 43, nhamba, mitsinya ne mapfundo. Chirongwa chinoenderera mberi neyi kiyi imwe neimwe nezita rayo uye yambiro pfupi yakadai se sk-nymbot-Qm7x…c2Lw.

• Kiyi inobva kune zita rako. Inoshandisa mari yako yakasara, uye ndeye nym yenyu chete inogona kuita, kuchinja kana kudzima izvi. Munhu wese ane kiyi anogona kushandisa nayo mari, saka iishandise semashoko ekupinda.
• MaCaps ari muSats. Kiyi inogona kuva nekuverengeredza kwemari inogona kushandiswa, uye kune kune kureverengeredzwa izvi kunogona kudzokororwa mazuva ose, svбоbu dzose (Muvhuro) kana mwedzi wega wega (zuva rekutanga), panguva inoti 00:00 UTC. Inoverengera mari dzose, standard credit se sats 10 uye Pro credit se 100, saka zvinoreva zvimwe muri kutarisa mari ipi inoshandiswa nekuverenga kwemudairo. Isati yaitwa mudairo, mari yakawanda inogona kushandiswa (yakaronedzwa kuenda pamusoro kucredits dzakazara) inobatanidzwa nekusara kwekuverengeredzwa kwemari. Kana isina kukwana, mudairo unorambidzwa ne 403 key_limit_reached, kunyangwe mhinduro yange yange yati pasi pemugrenge; chikanganiso chinotaura kuti pane zvakatsala zvakawanda uye kuti mugrenge uyu uchadzokorera rini. Kuderedza max_tokens kunoderedza izvo zvakaipisisa. Chikumbiro chinobhadhariswa zvakadhakwa nazvo uye izvozvo zvinotorwa muchikanganiso chemutengo wakatarwa, saka kana muvanduri akataura mavambo akawanda kupfuura aya akachengeterwa, chikumbiro chekupedzisira chakakwanisa chinogona kuitira kiyi kupfuura mutengo wakatarwa; chete chinotevera chinobviswa.
• Muganhuru wakapedzwa unomisa mari kushandiswa chete. Muchi wakasvika pamugumo unokwanisa kuongorora mari yakasara, kuverenga nhoroondo yacho, kuratidza mhando dzemodeli, kuverenga maitomunzi, kuwedzera mari, uye kuongorora vhidhiyo yakatanga kare.
• Kugumira hakusi kwekutambidzana. Mushure remusi waunogadzira, kiyii rinorega kushanda.
• Kugadziridza kwakatarisana nemubhadharo kwaitawo kurega kwaita kuitika nekukasira uye kusingagadzirisike. Chirongwa chakagadzirwa kudzidza chakanyorwa chakabatwa (revoked key) chinopindura nekusabudirira pakuita chikumbiro chinotevera. Chiri mumusoro wezvinobuda (list), chakanyorwa kuti chakabatwa, kuitira kuti nhoroondo yekushandisa kadaro isazovhiringidza.
• Unogona kuva nemakiwi akashanda akasvika makumi maviri nemashanu, mumwe nemumwe uine zita rake. Kuchinja nguva yekugadziriswa yemakiwi kunotanga nguva itsva kubva pachero.

Cherechi imwe chete inoratidza kushandiswa kwemakiroji ega ega panguva ino nepachose, nguva yakapera kushandiswa, mapfekero emari maviri aunayo, uye zvimbi zveAPI zvako zvava kuita ichi. Mapoinzi anozviita anotsanangurwa pasi pe kuchengetedza maki {@key}s.

Kutarisa chokwadi chekumbiriro

Tumira kiyi mune imwe chete yeizvi headers. Dzakafanana, saka shandisa yacho client yako inotuma nekuzvimirira:

Kiyi isingawanzvikanwa, yakarasika, yakadhonzwa kana yakapfuura nguva inodzorera 401, nekodi missing_api_key, invalid_api_key, revoked_api_key kana expired_api_keyKunyora mhando dze zvinhu, mhando dzemavhidhiyo, nemanzwi, pamwe nzira dzekubhadhara hakuna chinhu chinodiwa.

Mifananidzo, mavhidhiyo, kutaura, kunyora zvinotaurwa nembeidings zvinogonawo kubhadharwa imwe request panguva imwe kuburikidza neLightning pasina kiyi zvachose: tumira request isina kiyi uye ubhadhare invoice mu 402 pindura. Ona kubhadharira pachiitwa kwechikumbiro pasina kiyi.

Kugadziriswa kwemakiyi, pfupiso yeakaunti nekuwedzera mari kuzvimiririra ndizvo zvakasara: zvinoda saini kubva kunym yako pane kiyi, saka kiyi yakavanzwa haikwanisi kugadzira mamwe makiyi. Ona kusaina zvido zvekuvhura akaunti.

Chikumbiro chako chekutanga

Isa kiyi mune environment variable, ozopedzera kubvunza model chimwe chinhu. Mienzaniso yose mune mapeji aya inozviverenga kubva ku 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 ndiko kutenderera kweNymbot pachavo, inobhadharwa kubva pane yunogona kushandisa mari yaunogara uine. Isa idhi yemudhirowa wekatalog pane izvozvo, semuenzaniso wekuti anthropic/claude-sonnet-5, kushandisa rimodeli iroro kubva pane Pro balance. Kuratidza mhando dzemichina anopa id imwe neimwe.

Kurerutsa kuedza kunodhura zvakadii

API inobhadharisa sezvinobhadharisa neapp zvachose.

• Iri ririupenyu? nymbot/auto anopedza sezvakarongwa maringano (10 sats a credit). Mumwe nemumwe mamodheli echati anopedza Pro bhureki (100 sats a credit). Chishandiso chepachokwadi chekuita mifananidzo nematauriro zvinoshandisa zvishandiso zvakajairika; chimwe nechimwe chishandiso chinoshandisa Pro. Embeddings dzinoshandisa zvishandiso zvakajairika. Transcription inoshandisa zvishandiso zvakajairika kana bhureki rakajairika rikanogona kubhadhara, uye zvishandiso zvePro kana zvisizvo. Cherechedzo yemamodeli inotaura kuti bhureki ripi rinoshandiswa nemodeli imwe neimwe.
• Imari yakawanda sei. Kubvunzurudza kukurukurirana kunoverengwa nekushandiswa kwemashoko (tokens) amodeli yakarambidza nekuanyora, pamitengo yakanyorwa nemukurubatsiri. Mutengo uyu unowedzerwa mari yemushandisirwo inosvika 5% ndokubva waiswa ne 1.5, saka unobhadharwa mutengo unenge wakanangana ne 1.575 kune mutengo wemukurubatsiri. Unoshandurwa kuita sats panguva inenge iri pamutengo weBitcoin, uye unobhadharwa nenzvimbo dzekushandisa (credits) dziri mugumi rechiuru. Mifananidzo yakanyatsoti, mavhidhiyo, nematauriro zvinodhura zvichienderana nekugadzirwa, nezv секунды kana nemashoko, uye kunyora zvinyorwa zvinoenderana nezv секунды dzeanonzwa, nemari yemushandisirwo nemargin yakafanana. Mufananidzo wezvakajairika unodhura credits 5 dzakajairika, uye inzwi rezvakajairika rinoshandisa credits 3.
• Chakashomeya. Chimwe nechimwe chikumbiro chinenge chichishandiswa chinodhura zvimwe chete 0.05 credit: hafu sat pane balance yepedyo, 5 sats pane Pro. Zvikamu zvecredit zvinofambiswa zvakare, zvisingagadziriswi kumusoro nguva dzese.
• Mirega, wobva wozorora. Asati kuita chikumbiro, mari yakanyanya inogona kushandiswa inochengetwa kubva pane mari yako, zvichienderana nezvawakatumira nezvakanyanya kwazvo ma tokens anogona kunyorwa. Mashoko ari kunze kwe plain ASCII anoverengwa kubva ma bytes ake eUTF-8, uye nhamba dzeASCII nemitsetse yemavara inochera token imwe imwe, saka mashoko emutauro wese, code nezvirongwa zvinochengetwa zvakazara. Kuchengetwa kwacho kuri muma credits akazara, pakareba imwe chete, saka chikumbiro chipi zvacho chinoda kudarika sats 10 dzakachengetedzwa pane standard balance kana sats 100 pane Pro kuti chitevedze. Mari yakashandiswa chete ndiyo inobhadharwa; imwe yose inodzorerwa kana chikumbiro chapera. Chikumbiro chakareba chinochengetedza mari yacho kwenguva yacho chichimhanya; kana ma credits akachengetwa akasara asisatombogoneki, stream inomira nea 402 insufficient_balance chitadzo chechiitiko, uye zvakagadzirwa zvinobhadhariswa. Kana mutengo wechokwadi ukapfuura mari yakasara inokwanisa kubhadhara, mari yose yakasara inotorwa, zvinosara zvinobhadharwa (owed_sats mu nymbot chinhu, uye mutoro usina zvakanaka). Zvinotarisirwa kubhadharwa zvinobhadharwa chekutanga kubva pane zvimwe zvinopinda zvinosvika pane mutoro iyoyo. Kusvikira zvabhadharwa, hapana chinhu pane mutoro iyoyo chinogona kushandiswa: neAPI, mhinduro dzinowanikwa mubhuku rekushandisa (app), transfer, kana chipo.
• Hapana mari yakakwana. Kana mari iripo isingakwanisi kubhadhara hold, chikumbiro chinorambidzwa ne 402 asati zvinhu zvotanga kufamba. Error inoti ipeyo balance yakashomeka, kuti request inoda sats zingani uye kuti dzakawanda zvakadii dzakasununguka. Iri diki max_tokens zvireva kubata kushoma.
• Kukundikana. Chikumbiro chinonatsirwa chinorasikirwa nezvinhu zvakawanda, kunze kungoti mushandi akakubhadharisai nekushanda kwaakaita musati afa, kana kutsvagurudzo yewebhu kana... nymbot/auto basa check yainge yaitwa kare; saka ndicho chamunobhadhara, zvimwe zvipfuura 0.05 credit. Stream yamakaisa pasi inobhadharwa nema tokens anoziviswa neprovider: Nymbot inoramba ichiverenga stream yeprovider kwemasekonzi anopfuura 25 mushure mekunge mabatuka kuti iwane nhamba iyoyo. Kana isati yasvika, mari inobhadharwa inoshandiswa kuenzanisa zvinotuma nezvakanyorwa, uye kumodeli inofunga inobatanidza zvose zvinobuda zvakatarwa nehold. Request yekukwanisa yakadhonza connection inopedziswa uye inobhadharwa.
• Kutsvaga pawebhu zvinodhura $0.008 pese yekutsvaga, zvakashandurwa kuenda ku sats, panguva imwe neimwe yekutsvaga yakaitwa, kungave mutsauko wemodeli wakapindura kana akakundikana. Mapheji awanodoma anotumirwawo kumodeli semanyorerwo, saka anowedzera ma tokens avo.

Mhinduro imwe neimwe inotaura mutengo wayo. Mhinduro dzeJSON dzinotakura nymbot chikamu chine mhanya yakabhadharwa nayo, mari yakabhadharwa nemakirediti ne sats, uye zvakasara:

Chinhu chinenge chiri mutengo

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

Mhinduro dzakabhadharwa dzine zvimwe zvikamu izvi, izvo ndizvo zvinofanira kutsvakurwa kuti uone mutengo wemhinduro isiri JSON, semuenzaniso: kutaura:

Mari inobhadharwa pamichini yemaguta emiguta emillion, ichizove yakatsigira mari yekubhadhara nemarara, iri mu orodha yemamodeli muma madhorara nemasats, uye... pepa yemitengoKana mutengo weBitcoin usingagone kuverengwa, zvikumbiro zvakabhadharwa zvinodzoka 503 price_unavailable ne Retry-After: 60 pane kuitira kuti usafungidzira.

Zvikanganiso

Error rimwe nerimwe rine chitarisiko chimwe chete, icho vatengi vaOpenAI vachokwanisa kunzwisisa. code ndizvo zita rakasimba raunogona kubatanidza nazvo; message ndeye vanhu uye inogona kuchinja.

Muviri wechikanganiso

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

Zvikonzero zviviri zvinopfuura:

• /api/v1/messages mhinduro dziri mufomati wezvikanganiso zaAnthropic, sezvo ndicho chinotaurwa nemashoko eAnthropic: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Mhando inotevedzera chiumbo: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error kana overloaded_error (503).
• Chikumbidzo chestreaming chinonatsatwa usati watanga byte yekutanga chinowanikwa ne JSON error yepasina basa ine status yakanyorwa pamusoro, kwete event stream. Kukanganisa kumatambudziko ari kutoyamba kusvika kwaitwa kuchikumbidzo kumatambudziko ekupedzisira, nenhau yacho yacho inozivikanwa neendpoint iyoyo.

Meseji dzezvikanganiso hadzimbovapo nezvinhu zvakavanzika zvemumwe sevhisi. Zvikanganiso zvemunhu anopa sevhisi zvinogadziriswa mashoko asati asvika kwamuri.

Miganhu

Chikamu chelink yemufananidzo chinofanira kunge chiri pa muchina wevanhu: kureva kureva kwaunogona kusvika kuri pa network yakavharwa kana yepedyo, kana pama sites aNymbot pachake, zvinorambidzwa. Kuronga nguva kwezvikwaniso zvinoshandiswa mubhuku rino rinoshandiswa panowo, saka kuwanda kwezvikumbiro kune mupinzi mumwe chete kunogona kuderedzwa pane kuti zvikukanganisirei.

Zvinogona kuonekwa neAPI

API haisi yakavanzika sezvinongoita maapps, uye zvakakosha kuva neunyanzvi pamusoro pekuti zvakaita sei.

• Haisi kuchengetedzwa kubva kumunhu mumwe kusvika kumumwe. Mumapurogiramu, shoko rinovhimwa pamuchina wako nemaki anochengetwa naNymbot chete uye rinofamba se... kupaka chipo. API request inowanzova HTTPS: inenge yakavharwa (encrypted) pakufamba kuenda kuna Nymbot, uye server yaNymbot inozviverenga zvakajeka kuti ikwanise kuitira.
• Zvikumbiro nemhinduro hazvichengetedzwi. Inopinda mumodeli uye mhinduro inodzokera kumashure. Chave kuchengetedzwa iro biya: kumubvunzo wega wega nguva, modeli, mhando, hunani hwematoken, mutengo, mari yakasara, key uye kuti zvakabudirira here, kwemazuva anovanga 90, izvo ndizvo zvakaita mhuri yemibvunzo yakapfuura anokuratidza iwe. Rekodhi yekushandiswa ye chikumbiro chimwe chete (nguva, mhando, model, nhamba dzetoken, mutengo, nguva yakashandiswa uye kuti zvakashandisa kutsvaga pawebhu kana kuti zvakabudirira) inochengetwawo kwemazuva makumi manifold {90}, pamwe chete neyekwedhesu yeapp.
• Zvese zvakatsva zvaive nezita iri zvishoma uye zvanyorwa pano. MaAPI keys dzinosungwa sehash, kwete chikoshi, pamwe ne zita razo, zviratidzo zvishoma, magadzirirwo emari inogona kushandiswa, nguva yekunyorwa zvakare, nguva yekugumira uye nguva zvavakagadzirwa ne nguva yakasanganiswa; mangano maku 50 matsva emakiyi akadzimwa ndivo anochengetwa. An kuzvizadza zvakare zvoga kubatanidzwa kwewallet kuchengetedzwa kune encryption, neimhando yacho, mari, uye mhedzisiro yekupedzisira yekuzadza. Mabasa emavhidhiyo anochengetwa kwemahosi 24. Zvikumbiro zvakabhadharwa panguva imwe chete zvosiya Lightning payment hash chete kwemazuva 7 nemudandemutande wekudzorera mari (hashed refund token) kwemazuva 30, isina kubatanidzwa nemunhu. Mari dzisina kukwanisa kubhadharwa nebharaidzi dzinochengetwa sedzinosara dzichibhadharwa kusvikira kudzazwa kwemari kwadzidzorera.
• Kukanganisa app kudzidzimba nayo kunoibvisa. A kubvisa data mudziyo anoparadza uye anopedza API key dzose, uye anopedza rekodo rekubvunza, rekodo rekushandisa, kubatanidza kwewaleti nemabasa evhidhiyo. Mari yakasara pamwe nemari dzose dzisati dzibhadharwa dzinogara pane nym.
• Mubatsiri wemodeli anoona chikumbiro chako, sezvo zvinoitika kubva kuapp. Catalog mamodeli anomhanya kuneavagadziri avo; nzira dzakajairika neembeddings dzinomhanya paCloudflare.
• Zvishandiso zvakagadzirwa ndezvevanhu vose. Mifananidzo nevhidhiyo dzinopiwa semakona dzinokandwa pamafile hosts eBlossom akashama, uko kureveudzo yechinhu ndiyo hash yacho. Munhu wese ane link anogona kuivhura, uye Nymbot haizvigone zvakare kuzidzikisa. Nyora kuti b64_json uye mufananidzo wakagadzirwa unouya mumhinduro uye hauzombokwizwi kumatambudziko.
• Ko mufananidzo yamunopa ari generator here? Mufanidzo waunokanda ku shandura, kana kuti utumire sechinhu data: URL murunyorwa rweugadziri image_url, inosimudzwa paBlossom host yakavhurika kutanga kuti generator ikwanise kuitora, uye zvimwe zvakare kune izvi. Mufananidzo wakatumirwa na https:// link inopihwa sezvinenge link iyoyo. Mifananidzo mune chikumbiro chechat inofambira kumushandisi wemodel, kwete kuna Blossom.
• Kiyi yakabatidzaniswa ne nym yako. Zvese zvakashandiswa nekey zvinobva pane balance ye nym yako, saka kushandiswa kweAPI hakuna chisipoKana uchida kushandisa API yakasiyana nezita rako rinoshandiswa mazuva ose, ita kuti ma клю iwanikwe kubva pane rimwe zita rakasiyana rine mari yake pachake.

Kana uchida kuchengetedzwa nemapurogiramu (apps), shandisa mapurogiramu aya. API inoshandiswa kana uchida ma-models mumidziyo yako pachako.

Mapeji ose ekupedzisira

“Nym” zvinoreva chikumbiro chakatsainwa nechikwangadzo chako cheNostr, chakatsanangurwa mu kusaina zvido zvekuvhura akaunti. Kumidziro dzezvirongwa zvakatomboita izvi, onai zvishandiso nezvikwaniso zvekuvandudza michina (SDKs), uye kuti maageneti ekunyora mavara akafanana na Claude Code, Codex and Cline, ona zvirongwa zvekuwedzera kudzidza kwecoding.