Ezagutza oinarria / Garapitzaileak

APIren orri-laburpena

Aplikazioan erabiltzen dituzun modeloak, generatorrak eta saldoa, zure propioko kodean. APIak OpenAI eta Anthropic formatuak erabiltzen ditu, beraz, tresna eta SDK gehienak URL oinarrizkoa eta gako bat aldatuz funtzionatzen dute.

Orrialde hau automatikoki itzuli da erosotasunerako. Ingelesezko jatorrizkoa da aplikatzen den bertsioa.

Zer da APIa

HTTP API bat nymbot.ai OpenAI edo Anthropic bezero batek eskatzen dituen eskaera berdinak erantzuten dituena. Hona hemen:

• Txataren betiketak, eta Erantzun-APIa eta Anthropic Mezuak, streaming-rekin, tresnekin, irudiekin, arrazoきekin eta web bilaketarekin, modelo guztietarako katalogoa eta Nymbot-en propioa auto-eriletzarako.
• Irudiak, bideo, hitzalkari, transkripzioa eta embeddedak.
• Zure saldoa, Lightning lehentasunezko kargak, zure portafoiatik automatikoako betikuntzak eta eta historia eskaera bakoitzak zer kostatzen duen.

Baiera bi beraiek ordaindu dute saldoak aplikazioa bezala, pretzio berdinetan. Ez dago harpidetarik eta ez dago API-an doako zenbatekotanik: eskaera bakoitza erosi dituzun kredituetan oinarrituta ordaintzen da.

APIak ez du Nymboten propioa den ezer gehitzen. Zure mezuak modeloari bidaltzen dizkizkigu bidali zitzazuen moduan: ez dago Nymboten sistemako promptik, ez memoria, ez data edo hizkuntza iradokizunik. Itzulitzen dena modeloaren erantzuna eta zenbat kostatu zenen ohar bat da.

URL oinarrizkoak

Endpoint bakoitza azpian bizi da /api/v1/. Bide ezagutu gabe bat itzultzen da 404 eta metodo okerrez deketutako bidea ezagunaak itzultzen du 405, JSON bezala ere biak.

APIak orrizaleko eskaerak erantzuten ditu edozein webgune possible izateko, beraz, nabigatzaileko orduan orria deitu dezake. Hala ere, nabigatzaile batera bidaltzen duzun guztia irakurri dezakeela apertura egiten duenak, beraz, hori soilik gako txiki bat duen batekin egin ezazu txapelaZure nym-ekin sinatu diren terminatuak (gakoak, kontuaren laburpena, NWC auto-top-up eta diru-etorrerak) salbidea dira: browser batean, Nymbot-en propioko webguneei soilik erantzuten diete. Ikusi kontu eskaerak sinatzen.

Bidali JSON lote guztia honekin Content-Type: application/json. Beste motatako edozein motatakoak zioz kidea da 415, beraz HTML formulario erraz bat edo 1 text/plain beste webgune batetik etortako eskaerak ez du APIra iritsi ezin. cURL bidez, pasatu -H "Content-Type: application/json" eta batera -d.

API gakoak

Tekegiak aplikazioan egiten dira. Ireki API web app-en aldebidean, edo Android eta iOS-ko menuan, eta sakatu Sortu gakoaIzan izen bat eta, nahi baduzu, mugak eta berakhirateko data bat.

Gakoari behin bakarrik erakutsiko zaio. Kopiatu leku seguru batean orria ixotu aurretik: Nymbotek gakoaren hatzemprezuren bat bakarrik gordetzen du, beraz, ez dizu berriro erakutsiko. Galdu den gako bat ez da berreskuratu daiteke; ustekoa izan eta beste bat egin.

Gako bat horrela ikusten da sk-nymbot- 43 letra, digitu, k졌다 eta adierazle izendatutako karakterren jarraian. Aplikazioak giltza bakoitza bere izenaren eta indizio labur baten bidez azaltzen du, adibidez: sk-nymbot-Qm7x…c2Lw.

• Gako bat zure nym-i dago. Zure saldoa gastatzen du, eta zure nym-ak bakarrik sortu, aldatu edo bertan behera dezake. Gakoa duen edozein pertsonak gastatu dezake horrekin, beraz, pasarte bezala tratatu.
• Caps-ak satetatik gora daude. Gako batek gastu-mugak izan ditzake, eta mugak reset egin daiteke egunero, astean behin (asteguneak) edo hilabetean behin (lehen eguna), 00:00 UTC orduan. Saldo biak kontatzen ditu: kreditu arrakastatsua 10 sats bezala eta Pro kreditu bat 100 bezala, beraz, esanahi bera du eskaerak saldo edozein gastatzen duen arren. Eskaera bat ez dagoela exekutatu baino lehen, kostatu dezakeen gehien (kreditu osoetara irunduz) mugatik geratzen denaren aurka ezdatzen da. Ez bada egokitzen, eskaera baztertzen da honen bidez: 403 key_limit_reached, nahiz eta erantzuna limitean zehar joan litzatekeen; erroak esaten du zerbait geratzen den eta limitea noiz berritzuko den. Txikotzea max_tokens kasu txarrun hori murrizten du. Eskaera batek benetako kostua kobratzen du eta horrek gehiegi ez pasatzeko limitean kontatzen da, beraz, hornitzaileak gordetako token kopuru baino gehiago raportatzen baditu, limitura egokitzen zen azken eskaketak limitea pixka bat pasar ahal izango du; ondoren, hurrengoa ukoztatuko da.
• Gastu gastu bakarrik geldi egiten du. Bere txapela duen giltzak oreka egiaztatu dezake oraindik, bere historia irakurri, modeloak zerrendatu, tokenak kontatu, saldoa kargatu eta hasi den bideo bat egiaztatu.
• Terminuak aukerakoa da. Zuk ezarri duzun dataren ondoren, giltza funtzionatzeari uzten dio.
• Aldaketa berehala eta amaierakoa da. Anulatutako gako batek bere hurrengo eskaera ez du burutu. Zerrendan geratzen da, anulatuta markatuta, beraz bere gastu historia hala ere esanahia du.
• 25 aktibo izango dituzke kunciak hamailetik, bakoitzak bere izena izan dezakeela. Zugazten duzun kunci baten reset aldia, aldia zeroan bermanatuko du.

Orrialde berean, bakoitzaren gastua ageri da hemenaldi honetan eta guztira, azkenekoak noiz erabili zen, zure saldo bi eta zure API eskaera berriak. Horren atzean dauden endpoint-ak honako hauetan dokumentatzen dira: gakoak kudeatzea.

Eskaera autentikatzea

Bidali gakoa header hauen artean edozeinetan. Berdinak dira, beraz, zure klientak ordezko moduan bidaltzen duen edozein erabili:

Gako falta, ezaguna, anulatua edo expiratu duena bueltatzen du 401, kodearekin missing_api_key, invalid_api_key, revoked_api_key edo expired_api_keyModelak, audio modeloak eta ahatsak, eta ordainketa metodoak ez dute giltza behar.

Irudiak, bideoak, hizkuntza, transkriptioak eta embeddingak ere ordaindu daitezke eskaera baten kostan Lightning bidez, ezerren bat gakorik gabe: bidali eskaera gabe eta faktura ordaindu 402 erantzuna. Ikusi eskaera bakoitzeko ordainketa txlarpe gabe.

Gakoen kudeaketa, kontu laburpena eta automatiko top-upak kasu bereziak dira: zure nym-etik sinatura hartzen dute gako baten ordez, beraz, filtratutako gako batek ez du beste gakoak sortu ahal. Ikusi kontu eskaerak sinatzen.

Zure lehen eskaera

Jarri gakoa ingurune-aldaketa batean, ondoren modelo bati zerbait galdetu. Urralde hauetan dagoen adibideek honetatik irakurtzen dute 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 Nymbot-en propioa da nora bideratzea, saldo estandarrearekin ordaindu oinarritik. Jarri hemen katalogo modelo baten id baten ordez, adibidez anthropic/claude-sonnet-5, Pro saldoan dagoen modelo horretatik erabiltzeko. Modelak zerrendatzea ID guztiak ematen ditu.

Zer kostatzen duen eskaera bat

APIak aplikazioak egiten duen bezala kobratzen du.

• Zein saldo. nymbot/auto gastatzen du estandarrak saldoa (10 sats kreditu). Ez duzu beste chat modelo guztiek gastatzen denik Pro saldoa (100 sats kreditu). Irudi generatzaile estandarra eta ahots estandarrarenak kreditu estandardrak erabiltzen dituzte; beste generatzaile guztiak Proak erabiltzen dituzte. Embeddingsak kreditu estandardak erabiltzen ditu. Transkribapenak kreditu estandardak erabiltzen ditu saldo estandardak estekatu ahal baditu, eta Pro kredituak beste kasuan. Modeluen zerak zehazten du modelo bakoitzak zein saldoa erabiltzen duen.
• Zer kantxa. Txaketa-eskako baten kostua modeloak benetan irakurri eta idatzitako tokenen arabera neurtzen da, hornitzailearen tarifak erabiliz. Baiera hori %5eko lapurretzako tasatekin gehituta 1.5ko faktorearekin moltiplikatzen da, beraz, hornitzailearen zerrendako prezioa 1.575 aldiz ordaindu behar duzu. Bitcoinren eguneko prezioaren arabera satsetara bihurtzen da eta kreditu milidatik kargatzen da. Irudi profesionalak, bideoak eta hizkuntza kontzeptuak generazio bakoitzeko, segundu bakoitzeko edo karakter bakoitzeko prezioak dituzte, eta transkripzioa audio segundu bakoitzekoena da, lapurretza eta marjen berdinarekin. Irudi standarda 5 kreditu standard finko ditu eta ahots standarda 3 finko.
• Gutxienez. Eskako metratutako bakoitzak gutxienez 0,05 kredi balio du: erdia sat erabilera arruntean, 5 sat Pro-n. Kredien zatiak bileratu egiten dira, ez behin eta bertan gora arredatuz.
• Egon, eta sonra asbederatu. Eskaera bat ez denean korrika, gehienbesteko kostua zure saldoaren aldetik gordetzen da, bidal duzunaren eta itzali ditzakeen token gehienaren arabera. ASCII arrunteko kanpoko testua bere UTF-8 byteen arabera neurtzen da, eta ASCII digitak eta puntuak token bat bakoitz bezala kontatzen dira, beraz, script edozeinetan dagoen testua, kodea eta zenbakiak guztiz gordetzen dira. Erreserba kreditu osoetan egiten da, gutxienez bat, beraz, eskaera baten behar duenez, gutxienez 10 sats libre behar ditu saldo estandarrean edo 100 sats Pro-n has dezan. Kostu benetakoa bakarrik kobratzen da; geria dena askatu egiten da amaitzen denean. Eskaera luze batek bere erreserba exekutatzen den denbora guztira mantentzen du; gordetako kredituak disponibile izaten ez badira yinez ere, esteka bat gelditu egiten da... 402 insufficient_balance akatsaren buletina, eta sortutakoa kobratu egiten da. Balantzia baino kostu handiagoa bada, balantzia osoa hartzen da, gerratzea ordaindu beharrekoa izango da (owed_sats ...en nymbot objektua, eta saldo negatiboa). Salatu mustua da lehenengo ordaindu behar dena, saldu hori lortzeko heltzen diren hurrengo kredituetatik. Ordaindu arte, saldu horretan ez da ezer gastatu daitezkeela: ez API bidez, aplikaziorako erantzunak, transferentzia bat edo oparia.
• Kreditu nahikoa ez. Saldoak erreserba covering ezin badu, eskaera honen bidezka Gertatuko da: 402 zerbait ez martxan jartzen baino lehen. Akatsak saldu egiten du zein saldo den apurtua, eskaerak zein sat bedezeratza behar dituen eta zein da libreak. Txikiago bat max_tokens Kontenta txikiagoa esan nahi du.
• Ezustek. Egiaztatu ez den eskaerak ez du kostarik, easy bezeroak ez baditu huts egin aurretik egin duen lanagatik kobratu, edo web bilaketa bat edo... nymbot/auto tasak egiaztatu zenetik; orduan hori da ordaintzen duzun, gutxiago 0,05 kredi. Moztu duzun fluxu batek hornitzaileak jakinarazten dituen tokenengatik kobratzen zaizu: Nymbot etan bertan hornitzailearen fluxua irakurtzen jarraitzen du zure bota eta 25 segundorako baterako, kontua lortzeko. Ez bada iristen, kobratzea bidali duzun eta idatzitakoaren arabera estimatzen da, eta pentsatzen duen modeloentzat, gordunaren irteeraren zenbategi osoa sartzen da. Konexioa galtzen duen eskaera batek amaitzen du eta kobratzen zaio.
• Web bilaketa biltegiratze bakoitzeko 0,008$ kostatzen dira, satsetara bihurkratuta, bilaketa bat egindakoan, eta modeleak erantzun dezan edo ez, kontuan hartuta. irakurtzen dituen orriak ere modeleari sarrera gisa bidaltzen zaizkio, beraz, haien tokenak gehitu egiten dira.

Erantzun bakoitzak zer kostatu zen esaten du. JSON erantzunek ... bat daramate. nymbot ordaindu zen saldoare duen objektua, kreditu eta satsetan dagoen lapurketak eta zer geratzen den:

Kostu objektua

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

Ordainduko erantzuneek tratua hauek ere iruzkin egiten dituzte, eta horregatik behar da erantzunaren kostea bilatzeko, JSON ez den bat, adibidez, hizkuntza:

Token milioneko tarifak,akatsa eta marjinak barne hartuta, honako hau dira: modelen zerrenda dolaretean eta satetxean, eta padan prezio taula. Bitcoinren prezioa ezin badira irakurri, ordainduko eskaerak bueltatzen dira 503 price_unavailable rekin Retry-After: 60 edorren bidez baino.

Erroreak

Errore bakoitzak irudi berekoa du, OpenAI bezeroek jada ulertzen dutena. code estabileko izen bat da, konpondia egin dezakezun; message jendeentzat da eta alda daiteke.

Errore korpua

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

Two kasu bereziak:

• /api/v1/messages Anthropic-en erantzunak Anthropic-en errore formatuan, Anthropic-en bezeroek parseatzen dutena baita: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. Mota estatusaren ondoren dator: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error edo overloaded_error (503).
• Lehen bytea jaso baino lehenik huts egiten den streaming eskaerak, gorenko estatusarekin JSON errore arrunta bat jasotzen du, ez eventu fluxo bat. Fluxua hasi ondoren gertatutako hutsunea, fluxuaren azken evento gisa bidaltzen da, endpoint horren formatu propioan.

Errore-mezkinak ez dute inoiz beste zerbitzu baten barne-xehetasunak barne ezin. Hornitzaile baten errorea berriro idatzita dago zuengana iritsi baino lehen.

Mugak

Irudi baten estekak gordin publikera zuzendu behar du: pribatu edo lokalko sare bateko helbidea, edo Nymboten propioko webguneetakoa, uko egiten zaio. App-ean aplikatzen den hornitzailearen erritmoak hemen ere aplikatzen dira, beraz, hornitzaile baterako eskaera bat beharrekoak murriztea posible da, huts egin beharrean.

APIak zer ikus dezakeen

API ez da aplikazioak bezala pribatua, eta zein moduetan den zehatzago esatea worth da.

• Ez da amaieratik amaierara enkriptatuta. Aplikazioetan, zure gailuan mezu bat sigilatuta dago, Nymbot-ek soilik jakingo dituen giltzekin, eta honako hau bezala bidaltzen da: opakatu berria. API eskaera ohiko HTTPS bat da: Nymbot-era doanean enkriptatuta dago, eta Nymbot-en zerbitzarik argi eta garbi irakurtzen du prozesatzeko.
• Promptak eta erantzunak ez dira gordetzen. Modulotik pasatzen dira eta erantzunera bueltatzen dira. Gatazkak gordetzen dira: eskaera bakoitzerako denbora, modeloa, mota, token kopuruak, kostua, saldoa, gakoa eta arrakastatsua izan ote den, 90 egunetarako, eta hau da bilaketa historia zuek erakusten dizuet. Eskakera bera den erabilera-erregistro bat (oraera, mota, modeloa, token kopurak, kostua, iraupena eta web bilaketa erabili zuen ala arrakastatsua izan zen) gordetzen da 90 egunetan zehar, aplikazioaren propioaren alongsidean.
• Nym batentzat gordetzen den beste guztia txikiak dira eta hemen agertzen dira. API gakoak hash gisa gordetzen dira, ez inoiz lauzia, haien izenarekin, ohar labur batekin, gastotzeko gehieneko limitearekin, reset aldierarekin, berakhiratze datarekin eta egin eta azken erabiltze datarekin; ezabatu diren 50 azken loteak bakarrik gordetzen dira. An igoera automatikoa portafolio konexioa gordetzen da estruturatuta, bere mugak, kopurua eta azken kargatzearen emaitzarekin batera. Bideo lanak 24 ordu baterako gordetzen dira. Deiaren arabera ordaindu ote den eskaeretan, Lightning ordainketaren hash bat soilik geratzen da 7 egunetarako eta itzulpen token hash bat 30 egunerako, ez duinifikatuaturik. Saldoa ez zuen estekatzea ahalik, zorretan geratzen dira karga horiek, kargatze batek ordain dakarren arte.
• Appa ezabotzeak ezabatu egingo du. A gailua ezabatu API giltza guztiak anulatzen eta ezabatzen ditu, eta bisitako historia, erabilera erregistroak, portafolio konexioak eta bideo lanak ezabatzen ditu. Saldoa eta ordaindu beharreko lapurrak nym-en geratzen dira.
• Modeloaren hornitzailea zure eskaera ikusten du, aplikazioan egiten den bezala. Katalogo modelak egileetan dabil; ibilbide arrakastatsuek eta embedding-ek Cloudflare-n dabil.\"
• Generatutako media publikoa da. Lotura gisa entregatutako irudiak eta bideoak Blossom hostatzaile publikoetan igotzen dira, non agiri baten helbidea bere hash-a den. Lotura duen edozeinek ireki dezake, eta Nymbot ezin du berriro kendu. Eskatu b64_json eta erantzunekoak irudi generatua bat dator eta ez da inoiz igotzen.
• Beraz, ematen dituzun irudiak generatzaile bat dira? Igarotzen duzun irudi bat editatu, edo ... gisa bidali data: URL generatzaile baten barnean image_url, Blossom host publiko batera igotzen da lehenik, generatzaileak hartu dezan, eta bera ere bere kasua da. Xez bidaltzen den irudi bat https:// lotura hori horretzat pasatzen da. Txat-eskaera bateko irudiak modeloaren hornitzailearengana doaz, ez Blossom-era.
• Gako bat zure nym-ekin lotuta dago. Gako baten gastapen guztia zure nym-aren saldonetik ateratzen da, beraz API erabilerak ez da anonimo. APIa zure eguneroko nym-etik bereiz eta gordetzeko nahi baduzu, soilak zure saldo propioa duen nym separate batetik egin ezazu.

Aplikazioen babesa behar baduzu, aplikazioak erabili. APIa zure propioko tresnaetan modeloak behar dituzunean erabiltzen da.

Puntu amaiera guztiak

“Nym” esaldia zure Nostr gakoak sinadura bat esan nahi du, honetan deskribatua: kontu eskaerak sinatzen. Format hauek jakingien dituzten tresnarako, begiratu tresnak eta SDKak, eta Claude Code, Codex eta Cline bezalako programazio agententzat, begiratu kodatze tresnak.