Ubumenyi shingiro Abakora porogaramu
Incamake ya API
Imideli, generators n'uburyo bwo kubarura (balance) ukoresha muri lya somo, biva muri code yawe bwite. API ivuga uburyo bwa OpenAI na Anthropic, bityo ibikoresho n'SDK nyinshi bikora binyuze mu guhindura base URL na key.
Uru rupapuro rwahinduwe imashini kugirango byorohe. Umwimerere wicyongereza ni verisiyo ikoreshwa.
API ni iki
HTTP API kuri nymbot.ai ibisubizo bijyanye n'ibibazo OpenAI cyangwa Anthropic client yari iriho isaba. Uhabwa:
- Kuzuza ibiganiro, uwo API z'Ibisubizo na Ubutumwa bwa Anthropic, na streaming, ibikoresho, amafoto, ubwenge n'ubushakashatsi kuri interineti, kuri buri model mu indabo kandi no ku miterere ya Nymbot yihutiramo inzira (auto-routing).
- Amafoto, video, ijambo, inyandiko y'ibivugwa na embeddings.
- Iwawe imibare y'amafaranga asigaye, Kuzuzanya Lightning, uko wiyongerera amafaranga mu buryo bwikora ukoresheje ikigega cyawe (wallet) n'a amateka uko buri gusaba kora amafaranga.
Bishyurwa kuva kuri ayo muntu babiri ako kanya. imibare y'amafaranga asigaye nka porogaramu, ku ibiciro bimwe. Nta mukoreshabushaka (subscription) kandi nta masezerano y'ubuntu kuri API: ubuherenge burishyurwa hakoreshejwe amayira (credits) waguze.
Icyo API itora ntabwo ari ukubyungabunga ikintu cyose cy'ubwite cya Nymbot. Ubutumwa bwawe bwohereza kuri model nk'uko wabwohereje: nta ntego y'uburyo bwa Nymbot (system prompt), nta kwibuka, nta mateka cyangwa ibimenyetso by'ururimi. Icyo kugaruka ni igisubizo cya model n'inyandiko ivuga igiciro cyakoreshejwe.
Amaneti y'ibanze
| Koresha | Inkingi ya URL |
|---|---|
| SDK za OpenAI n'ibikoresho bishobora gukoreshwa na OpenAI | https://nymbot.ai/api/v1 |
| SDK za Anthropic na Claude Code | https://nymbot.ai/api (SDK yongeraho /v1/messages ubwibwe |
Buri endpoint iba iherereye munsi ya /api/v1/. Inzira itazwi isubira 404 n'inzira izwi yitwa igihano cy'uburyo bukoreshejwe nabi isubiza 405, byose nk'uburyo bwa JSON.
API isubiza ibibazo biva ku rubuga ruruta urwo ikorera, bityo urubuga rw'ikirangirire rushobora kuyicita. Ariko, ibyo cyose ugiye gushyira kuri browser bishobora gusomwa n'umuntu wese uyifungura, bityo bikore gusa ukoresheje urufunguzo rufite ubushobozi buke agateganyoAho bigendera byashyiriweho umukono ukoresheje nym yawe (funguzo, incamake y'konti, NWC auto-top-up n'indishyi z'isubizwa ry'amafaranga) ni yo itari mu ntekerezo isanzwe: muri browser basubiza aho imbuga za Nymbot zikora gusa. Reba gusinya ubusabe bw'konti.
Kohereza buri JSON body hamwe na Content-Type: application/json. Ubwoko bwandi bwose
burabulwa na 415, rero imfomati ya HTML isanzwe cyangwa ⋯ text/plain ubusabe buturutse kuri
indi urubuga ntubasha kugera kuri API. Ukoresheje cURL, shyiraho
-H "Content-Type: application/json" hamwe na -d.
Amakuru y'ibanga ya API
Ibikoresho bikorwa muri app. Fungura API mu muryango (sidebar) w'urubuga rwa web, cyangwa mu menu kuri Android na iOS, maze ukande Kora ikigenzamitima. Iha izina kandi, niba ubishaka, uburiro n'igihe bizarangiriraho.
Icyubaka kigaragazwa rimwe gusa. Kikore mu mwanya witonze mbere y'uko uhagarika urupapuro: Nymbot ikurikirana isura yacyo gusa, bityo ntishobora kukwereka nanone. Icyubaka cyatakaye ntishobora kugaruka; kureke amashyari maze ukore ikindi.
Ifunguzo rimeze nk' sk-nymbot- biguranyirizwa inyuguti 43, imibare, imirongo n'
utubumbe. Porogaramu yerekana buri kintu ukoresheje izina ryaryo n'inyito ngufi nk'iri
sk-nymbot-Qm7x…c2Lw.
- Ikigeni kigira mu izina ryawe. Ibikoresha umutungo wawe, kandi nym yawe yonyine ishobora kugenza, guhindura cyangwa gukura ibyo, uwo wese ufite urufunguzo ashobora kubikoresha, bityo ubyitwaremo nk'uko ubyitwaramo ijambo ry'ibanga.
- Caps ziri muri sats. Urufunguzo rushobora kugira urugero rw'amafaranga ashobora gukoreshwa, kandi urwo rugero rushobora gusubizwa
buri munsi, buri cyumweru (ku wa Mbere) cyangwa buri kwezi (ku munsi wa mbere), saa 00:00 UTC. Rubara imibare yose,
uburyo bwa kawaida (standard credit) bwateganyijwe nk'amats 10 kandi ubw'icyiciro cyo hejuru (Pro credit) bwateganyijwe nk'amats 100, bivuze ko ari kimwe
kw'uburyo bwose ubusabe bukoresha. Mbere y'uko ubusabe bukabera, amafaranga menshi ashobora kugura
(asubijwe mu mibare yuzuye y'ibiciro) aganishwa ku mafaranga asigaye y'urugero. Niba atari bwo asubira,
ubusabe burasubizwa hakoreshejwe
403key_limit_reached, ndetse niyo igisubizo cyaba cyaje munsi y'urugero rwihariye; ikosa rivuga ingano isigaye n'igihe urugero ruzongera gutangira. Kugabanyamax_tokensbigabanya ibibazo bibi cyane. Ubushakashatsi burishyurwa ibyo bwakoresheje by'ukuri kandi ibyo biragabanura urugero rwashyizweho, bityo niba ugutanga serivisi atanga amagambo menshi kurusha ayateganyijwe, ubusabe bwa nyuma bwabashije kubukora bushobora gutuma uruhushya rurenga gato urugero rwashyizweho; ubusabe bukurikira rerahirwa. - Ikirango cyakoreshejwe gusa kigahagarika imikoreshereze. Icyapa cyageze ku mupaka kirashobora no kureba umubare asigaye, gusoma amateka, kugaragaza amamodeli, kubara tokens, kongera ibintu, no kureba videwo yari yatangiye.
- Igihe cyo guhagarara ni ihitamo. Nyuma y'itariki wateguye, urugero ruzahagarara gukora.
- Guhagarika birihuta kandi ni iby'iteka. Icyatanzwe ariko gakanzwe ntabwo gikora ubundi busabe bwose bukurikira. Kiguma muri uru rutonde, bwatanzwe amakuru ko canewe, kugira ngo amateka yacyo yo gukoresha akomeze asobanutse.
- Ushobora kugira amazinga (keys) akora kugeza kuri 25, buri rimwe rifite izina ryaryo. Guhindura igihe cyo gusubiramo (reset period) ry'azinga rimwe bitangiza igihe gishya guhera kuri zero.
Urutonde rumwe rugaragaza uko buri kintu cyakoresheje amafaranga muri iki gihe ndetse n'igihe cyose, igihe cyakoreshejwe nyuma, uburyo bwayo bwose bwo kubika amafaranga, hamwe n'ibyo waba wasabye kuri API ubu hasigaye. Aho ibyo bintu biba biri bishingiyeho bwanditswe hano: uburindamirizi bw'amfunguzo.
Kwemera ubusabe
Ogera umutungo (key) muri kimwe muri aya muryango w'ibaruwa (headers). Ni bwegereye, rero koresha uwo umukiriya wawe asanzwe akoresha:
| Umutwe | Yatumwe na |
|---|---|
Authorization: Bearer sk-nymbot-… | SDK za OpenAI, ibikoresho byinshi, Claude Code hamwe na ANTHROPIC_AUTH_TOKEN |
x-api-key: sk-nymbot-… | SDK za Anthropic |
api-key: sk-nymbot-… | Abakiriya bagenewe uburyo bwa Azure |
Icyegerezo kitariho, kitari kumenyekana, cyakozweho amategeko cyangwa cyageze ku mpera kigaragaza 401, hamwe n'ikode
missing_api_key, invalid_api_key, revoked_api_key cyangwa
expired_api_keyKugaragaza amashanyarazi (models), amashanyarazi y'amajwi n'amajwi, ndetse n'uburyo bwo kwishyura
si bisaba urugero rw'ijambo ry'ibanga (key).
Amafoto, videwo, ijambo, kwandika ibivugwa n'embeddings na byo bishobora kwishyurwa kuri buri gusaba rimwe ukoresheje Lightning utari ufite urugero rwa funguzo (key) na busa: tumba ubusabe utari na yo hanyuma wishyure inyemezabuguzi muri 402 isubizo. Reba wishyura kuri buri gusaba utabaye urugero.
Imiyoborere y'amashashi (Key management), incamake y'ibitubayeho (account summary) n'inyongeza y'amafaranga ikora ifakaje (automatic top-ups) ni ibyo bice byihariye: bikoresha umukono uva kuri nym yawe aho gukoresha ishashi, bityo ishashi imenyekanye ntishobora gukora izindi zashashi. Reba gusinya ubusabe bw'konti.
Umubwiriza wawe wa mbere
Shira urufunguzo muri variable y'aho ibintu bibikwa (environment variable), hanyuma usabe icyiciro cy'ubwenge bw'ubukorano (model) ikintu. Ingero zose muri
aya masepagina zikiba zikakura kuri 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 ni uburyo bwo kuyobora bwa Nymbot ubwabo, bwishyurwa hakoreshejwe umubare wa standard. Shyiramo ID ya model ya catalog aho, nk'urugero: anthropic/claude-sonnet-5, kugira ngo ukoreshe mo uwo muryango
kuva ku miterere ya Pro. Kugaragaza amamodeli aha buri imyirondoro
Igiciro cy'ubusabe ni iki
API ibishura neza nk'uko porogaramu (app) ibikora.
- Ni ubuhe bwuzuzanye?
nymbot/autoakoresha uwo ihame inganzuro (10 sats a credit). Ubundi bumwe mu mivugire y'imikorere ya chat model bupfusha Icyiciro cy'indashyikirwa inguzanyo (100 sats a credit). Generator isanzwe y'amashusho n'iyo y'amajwi isanzwe ikoresha inguzanyo isanzwe; generator zindi zose zikoresha Pro. Embeddings zikoresha inguzanyo isanzwe. Transcription ikoresha inguzanyo isanzwe igihe inguzanyo isanzwe ishobora kubishyura, kandi ikoresha Pro igihe bitabaye bwo. Urutonde rw'amajambo (models list) rugaragaza inguzanyo buri model ikoresha. - Ni bangahe? Uburebure bw'ibiganiro bishingiye ku mivugire n'ibyo model yasomye n'ibyo yasunze, hakurikijwe amarembo yashyizweho umukoresha. Icyo giciro kuva kigira 5% y'inyungu y'inyongero hanyuma kikongerwamo 1.5, bityo wishyura inshuro 1.575 ugereranyije n'igiciro cy'umukoresha. Kigeregeranywa mu sats hashingiwe ku giciro cya Bitcoin cy'uyu munsi kandi kishyurwa mu mibare ibiri y'ibipimo by'amadoro (credits). Amafoto y'indashyikirwa, videwo n'ijwi biterwa imibare y'uburyo byakozwe, amasegonda cyangwa inyuguti, ndetse n'iyo kwandika ibyo wumvise hashingiwe ku masegonda y'amajwi, hakurikijwe iyo nyongero n'inyongero z'inyungu. Ifoto isanzwe ifite amadoro 5 asanzwe, naho ijwi risanzwe rifite amadoro 3 asanzwe.
- Icyatangira. Buri gusaba kwishyurwa kwose kukora kumenyekana ko kuguhenze nibura 0.05 credit: igice cya sat imwe kuri konti isanzwe, sats 5 kuri Pro. Ibice by'intebe (fractions) by'icredit birakomeza kubika, ntibitunganywa (rounded up) buri gihe.
- Hagarara, hanyuma utuze. Mbere y'uko ubusabe bugaruka, amafaranga menshi ashobora kwishyurwa agumirizwa ku mbaraga yawe, hashingiwe ku byo wakoze n'ibigoresho byinshi byashobora kwandikwa. Inyandiko itari ASCII ishingiye ku bice bya UTF-8, kandi imibare n'ibimenyetso bya ASCII buri kimwe biba ari igice (token), bityo inyandiko mu rurimi runaka, code, n'imibare bose bagumirizwa mu buryo bwuzuye. Iyo gukomora kuryozwa mu mbaraga zikoreshwa zose, nibura imwe, bityo ubusabe bwose bukeneye nibura 10 sats zirahari kuri balance isanzwe cyangwa 100 sats kuri Pro kugira ngo butangire. Ikiguzi cy'ukuri gusa ni cyo gishyurwa; ibindi byose birasubizwa iyo ibintu birangiye. Ubusabe burambye buhumeka imbaraga zaryozwa mu gihe cyose burimo gukora; niba imbaraga zaryozwa zihagarike kuba zihari, imiyoboro ihagarara na yo na...
402insufficient_balanceikosa ryabaye, n'icyo cyaremewe cyishyuwe. Niba ikiguzi nyacyo kiri kinini kurusha ibyo umubare usigaye ushobora kwishyura, umubare wose uravurwa, ibirundanye biratangirwa kwishyurwa (owed_satsmunymbotintego, n'inguzanyo y'inyeganyezabugere, ibyenda bishyurwa mbere hakoreshejwe amafaranga mashya agera kuri iyo nguzanyo. Kugeza igihe byishyurwa, nta kintu na kimwe kuri iyo nguzanyo gishobora gukoreshwa: ntabwo bishoboka kuri API, ibisubizo muri app, kwimurira amafaranga cyangwa impano. - Ntabwo hari amashwari ahagije. Niba umubare w'amafaranga utariho utashobora kwishyura ibihagaritswe, ubusabe
burahindurwa bukabwa na
402mbere y'uko ibintu bibitangira. Ikosa rivuga ko ubufungane burerwaye, ingano ya sats isabwa n'iyari ifite. Ikiniyemax_tokensbisobanuye kugira aho ufunganye gito cyane. - Ibyatsitse. Ubusabe bwaje umwanzuro ubangiye ntibuzagura na busa, keretse niba uwayubonye yabonye amafaranga
ku kazi yakozwe mbere y'uko bwanga, cyangwa ubushakashatsi kuri interineti cyangwa...
nymbot/autoIsuzumacyapa ry'inshingano ryari ryamaze gukorwa; rero ni ryo wishyura, nibura 0.05 credit. Icyerekezo (stream) wamaze gukata kirishyurizwa ku mivugire (tokens) ubuhamya bwanditse (provider) bwanditse: Nymbot ikomeza gusoma icyerekezo cya provider amasegonda 25 nyuma y'uko uva kugira ngo ibone iryo numero. Niba itageze, ikiguzi gihabwa agaciro hashingiwe ku byo wari uremye n'ibyo byanditse, kandi kuri modele ikora imitekerereze, birimo ubushobozi bwose bw'ibisubizo byateganyijwe. Ubusabe aho ikurunga (connection) ikamera bugaruka, bukarangira kandi bikishyurwa. - Gushaka kuri interineti ibiciro ni $0.008 ku bushakashatsi bumwe, bishyizwe mu sats, igihe cyose bushakashatsi bukozwe, haba igihe icyiciro (model) cyasubije cyangwa cyatsindwe. Amapaji akoreshwa ashyirwa mu cyiciro nk'ibisubizo, bityo na yo akaba yongera umubare w'amagambo (tokens).
Buri gisubizo kivuga icyo kwishura. Ibisubizo bya JSON birimo nymbot ikintu kirimo
amafaranga yakoreshejwe, amafaranga yari muri credits na sats, n'aho hasigaye:
Icyiciro cy'ibiciro
"nymbot": {
"balance": "pro",
"charged_credits": 0.162,
"charged_sats": 16.2,
"balance_credits": 412.425,
"balance_sats": 41242.5
}
Ibisubizo byishyuwe na byo birakora ibi bice by'inyandiko (headers), aho wagombye kureba igiciro cy'igisubizo kitari JSON, nk'amagambo akoreshejwe mu kuvuga:
| Umutwe | Ibisobanuro |
|---|---|
X-Nymbot-Cost-Sats | Ubu busabe bibahe aha mu sats. |
X-Nymbot-Balance-Sats | Ni iki gisigaye kuri konti yakoreshejwe kwishyura, mu sats. |
X-Request-Id | Id y'ubusabe, kuri buri gisubizo. Uyivuge iyo ubonanye n'ubufasha. |
Ibiciro kuri miliyoni ya tokens, birimo n'ishami n'inyungu, biri muri
urutonde rw'amimodeli mu madolari na sats, kandi kuri
inyandiko y'ibiciro. Niba igiciro cya Bitcoin kitashobora gusomwa,
ibyo gusaba byishyurwa biragaruka 503 price_unavailable hamwe na
Retry-After: 60 aho kugira ngo ugerageze gukeka.
Amakosa
Buri kosa rifite ishusho imwe, iy'abakiriya ba OpenAI bamaze kubimenya. code ni
izina ritagira ihindagurika ushobora kugereranyaho; message ni ku bantu kandi ishobora guhinduka.
Umubiri w'amakosa
{
"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
}
}
| Imiterere | Ryari |
|---|---|
400 invalid_request_error | Umubiri si JSON yemewe (invalid_json), urwego rwemeye rurabuze (missing_required_parameter), agaciro k'ikintu ni nk'aho kagenze nabi, cyangwa ubusabe busaba ikintu icyiciro cyangwa endpoint idashobora gukora, nk'ibikoresho kuri nymbot/auto (unsupported_tool). param iyita urwego. Kandi upstream_rejected igihe umuha mbwirwayi yemeye ubusabe. |
401 authentication_error | Icyatuma bitatabaye biba ni uko urugero rurerure rutarimo, rutarazi, rwashizweho amategeko cyangwa rwakiriye igihe, cyangwa se ubusabe bwagize umukono burahemukiye cyangwa bukoreshejwe kabiri. |
402 insufficient_quota | Umubare w'amafaranga uri kuri konti ntushobora kwishyura ubusabe. Code insufficient_balance, hamwe na balance, required_sats na balance_sats. |
403 permission_error | Ubusabe butajyanye n'icyapa cya (key_limit_reached, hamwe na limit_sats, used_sats na reset_at), cyangwa konti ishobora kudakoresha serivisi (account_denied). |
404 not_found_error | Inzira itazwi (unknown_endpoint), igishushanyo mbonera kitariho (model_not_found), cyangwa funguzo itazwi, fagitire cyangwa vidiyo. |
405 | Inzira irahari ariko si mu buryo bumwe (method_not_allowed). Ibyo Allow Umutwe ugaragaza urutonde rw'uburyo yakira. |
413 | Umubiri cyangwa dosiye ni nini cyane (payload_too_large, file_too_large), cyangwa ifondu irambye cyane (audio_too_long). Reba imipaka. |
415 invalid_request_error | Umubiri ntuvugwa nk' application/json (cyangwa, ku mitembe yo kurega, multipart/form-data): unsupported_media_type. |
422 | Ijwi n'ururimi rutajyanye mu gihe cy'ijwi ryumvikana binyuze mu mwandiko (voice_language_mismatch, unsupported_language). |
429 rate_limit_error | Ubusabe bwinshi cyane kuri iyi key, kuva kuri aya mwandiko, cyangwa ukoresheje ibimenyetso by'icyemezo byaje kutemwo (rate_limit_exceeded), cyangwa uwatanga aremeza imipaka y'ingano y'ibintu igezeho (upstream_rate_limited). Tegereza amasegonda muri Retry-After. |
500 api_error | Hari ikibazo cyabaye ku ruhande rwa Nymbot (internal_error). |
502 api_error | Uwayaga ntiyahaye igisubizo (upstream_error), cyangwa inyemezabuguzi ya Lightning ishobora kudashoborwa kugerwaho (invoice_unavailable). |
503 api_error | Ubwuzuzanye bw'umuvuzi burenzeho (upstream_overloaded), igiciro cya Bitcoin nticyashobora gusomwa (price_unavailable), cyangwa igice cy'ishingano kirimo ikibazo (service_unavailable, media_hosting_unavailable). Retry-After avuga igihe cyo kugerageza bwa kabiri, aho bamennye. |
Ibihariwe bibiri:
/api/v1/messagesibisubizo mu buryo bwa error bwa Anthropic, kuko ari bwo abakiriya ba Anthropic basoma:{"type": "error", "error": {"type": "authentication_error", "message": "…"}}. Ubwoko bukurikira uko imiterere ibimeze:invalid_request_error,authentication_error,billing_error(402),permission_error,not_found_error,request_too_large,rate_limit_error,api_errorcyangwaoverloaded_error(503).- Ubusabe bwa streaming bwavunze mbere y'uko byte ya mbere igera bubaye ikosa rya JSON ryo busanzwe rifite imiterere (status) iri hejuru, atari event stream. Ikosa rishatse muri stream ryamaze gutangira rikoherezwa nk'ikosa rya nyuma rya stream, mu buryo bwihariye bwo muri iyo endpoint.
Ubutumwa bw'amakosa ntibigera bukubiyemo ibindi bisobanuro by'imbere by'ikigo ikora serivisi runaka. Ikosa ry'uwatanga serivisi rihindurwa imvugo mbere y'uko rigerera kuri wowe.
Imipaka
| Imipaka | Agaciro |
|---|---|
| Ubusabe kuri buri funguzo | 120 mu minota imwe. Hejuru yaho, 429 hamwe na Retry-After. |
| Ibisabwa bidafite urufunguzo | 120 ku munutiro kuri buri ahoho, ku miterere y'icyiciro, amajwi n'imihigo y'uburyo bwo kwishyura, isuzuma ry'amateganyanya yo gusubiza amafaranga, n'aho bita endpoints bishyuwe bikozwe nta kintu cyemewe cyangwa kwishyura. Hejuru yaho, 429 hamwe na Retry-After. |
| Ubwiyunge bwaje kugahunda nti bwabaye bwuzuye | 30 ku munutsi kuri aderesi ya buri waho ku bijyanye n'amfunguzo, ibikoresho by'imyandikire, ibimenyetso by'ubwishyu n'amajambo y'isubizanyambaga (refund tokens) adasuzumwa. Hejuru yaho, buri gusaba kuva kuri iyo aderesi ifite ikimenyetso kiba kigana 429 hamwe na Retry-After kugeza igihe cyarangiye. Ububiko bwerekwa mbere y'uko umubiri usomwa. |
| Ubuziti bushya | 60 ku isaha kuri buri nym na 120 ku isaha kuri buri aho ariho. |
| Injyanye z'inyongezo y'amafaranga | 60 ku isaha kuri buri nym na 120 ku isaha kuri buri aho ariho. |
| Ihuza ry'ama-wallet ya NWC | $10 ku isaha kuri buri nym na $30 ku isaha kuri buri aho ariho. Wallet relay igomba gukoresha wss:// ku rubuga rwa kawaida. |
| Isubizwa ry'ama-token | Ubusoko bwa mikeli 60 ku munota kuri buri token. |
| Aho utuye | Aho ya IPv6 address itwa /64 yose mu miterere yose y'ing限制 (limit) ya buri address, kandi IPv6 address yashyizwe mu buryo bwa IPv4 (IPv4-mapped IPv6 address) ikaba isubizwa nk'address ya IPv4. |
| Umubare w'ibitabo bwa JSON | 4 MB; 64 KB ku ibisabiro byashyiriweho umukono ukoresheje nym yawe. |
| Umubare w'ibice by'inyandiko y'ubusabe (utuzu tw'ibituma) | 32 MB. Ifoto ushobora guhinduramo ishobora kugera kuri 20 MB, dosiye y'amajwi ishobora kugera kuri 25 MB. Ibice byinshi ni 64, buri kice gifite ibice by'umutwe (part headers) bitarenze 8 KB, n'imipaka ya 1 kugeza kuri 70 y'inyuguti; ibindi bikaba ari 400 invalid_multipart. |
| Amafoto mu muryango umwe w'ubutumwa | 20. Buri kimwe ni 🇺🇳 https:// cyangwa http:// ikurikirwa kuri host ya burundu, cyangwa... data:image/… URL. |
| Amafoto kuri buri gusaba kurema | 1 kugeza kuri 4 (n) |
| Amakuru asohotse | Igenzura ku rugero rwo hejuru rw'umuvuduko w'umuvuduko w'icyiciro. Ikinyuranyo kinini max_tokens bisaganywa ko biterwa na byo, si uko bibanze. |
| Imvugo inyuze mu ijwi | Inyandiko z'imivugire isanzwe ni ibirundatika 800, naho kuri Aura 2 ari ibirundatika 2,000. |
| Iguhurira mu magambo | Iminota 30 y'amajwi, 25 MB. Amashusho arambye ntiyakirwa na 413 kandi ntibishyurwa, ndetse niyo agaciro k'uburebure bwayo kaba kuzi gusa nyuma ya Whisper imenyereye. |
| Embeddings | Amakuru 100 kuri buri gusaba. |
| Akazi ko gukora videwo | Bitazigwa mu gihe cy'amasaha 24 nyuma y'uko yagejejwe; igisubizo (render) kiba kiguye nyuma y'isaha imwe. Kuri bose ni rendering 10 bishobora gukorwa icyarimwe kuri nym imwe. |
| Amateka y'ibibazo | Bihagaze mu minsi 90. |
| Ibiciro by'ibiciro by'ingingo kuri buri nym | 25. Impunzi 50 zashyizweho zishaje gusa ni zo zikirwa. |
Ikirimo ishusho kigomba kwerekanwa kuri hositi yifatanyije n'isi yose: aho mu kigo cyangwa muri network y'imbere, cyangwa ku mbuga za Nymbot ubwayo, birabulirwa. Imihindagurikire y'umuvuduko w'isoko ikoreshwa muri porogaramu niyo ikoreshwa hano, bityo ibituma ubufatanye bw'ubushakashatsi bwinshi ku isoko rimwe bishobora kugabanirwa umuvuduko aho kubujijwe burundu.
Icyo API ishobora kubona
API si ibanga nk'uko porogaramu (apps) zimeze, kandi ni byiza kuvuga neza uburyo bimeze.
- Ntabwo ifite uburyo bwo guhisha amakuru kuva ku muntu ugera ku wundi. Muri porogaramu, ubutumwa buhunzwe kuri icyuma cyawe kugira ngo ubusore bwaryo bube bwubashije imfunguzo Nymbot gusa kandi bukabera uburyo gusiba impanoisanzwe ishyirwa mu buryo bw'ibanga mu nzira ijya kuri Nymbot, kandi seriveri ya Nymbot isoma mu buryo busanzwe kugira ngo ikore ibyo isabye.
- Ibisubizo n'ibibazo ntibitunganywa cyangwa kubikwa. Binyura muri model hanyuma igisubizo kigaruka. Icyajya kigumaho ni inyandiko y'amafaranga: kuri buri gusaba igihe, model, ubwoko, imibare y'amagambo (tokens), igiciro, amafaranga asigaye, urufunguzo (key) n'aho byagenze neza, mu minsi 90, ari na ko amateka y'ibibazo wibajije ikwereka. Inyandiko y'imikoreshereze y'ubusabe bumwe (igihe, ubwoko, imodeling, umubare w'amagambo, ikiguzi, igihe cyakoreshejwe n'aho yakoresheje uburyo bwo gushakisha kuri interineti cyangwa niba byagenze neza) na yo itegurwa mu minsi 90, ubusanzwe irimo n'iy'uburyo bwihariye bw'ikoranabuhanga rikoreshwa.
- Ibindi byose bifite izina rya nym ni bito kandi bishyizwe hano. Amakuru y'ibanga ya API bifatwa nk'umushyi (hash), ntibifatwa nk'urufunguzo (key), hamwe n' izina ryazo, ikimenyetso gito, urugero rw'amafaranga ashobora gukoreshwa, igihe byongera kugaruka, igihe biza gusa, n'igihe byaremewe n' igihe byakoreshejwe nyuma; amashumi atanu (50) ya mbere y'amfunguzo yafashwe niyo asigara; An kwiyongerera imari ukwayo Isano rya wallet ryahifadhiwe mu buryo bw'ibanga, hamwe n'urugero (threshold), amafaranga, n'uko ibyo byuzuye bwa nyuma byagenze. Ibikorwa by'amashusho bihifadhiwe amasaha 24. Ibisabwa byishyurwa kuri buri guhamagara bisiga agashushanyo k'ubwishyu bwa Lightning (Lightning payment hash) iminsi 7, n'ikimenyetso cy'gusubizwa amafaranga (hashed refund token) iminsi 30, bitari bishyize hamwe n'izina ry'umuntu. Amafaranga adashoborwemo kwishyurwa akomeje kubarwa nk'ayo ari ukwishyura kugeza igihe ibyo byuzuye byishyura.
- Gusiba porogaramu bishobora kuyisiba. A gusiba ibintu byose muri ibikoresho ahoherereza kandi akagira imiterere y’ibwonko bya API byose, kandi akagira imiterere y’amateka y’ibibazo byasabwe, ibyerekeye imikoreshereze, isano ry'uburyo bwo kwishyura n'imirimo y'amashusho. Amafaranga asigaye n'imishahara yose itarishyuwe bacyura kuri nym.
- Uwayateguye ubu buryo abona ubusabe bwawe, nk'uko bimeze kuva muri porogaramu. Imashini zo muri katalog zikora aho zabozwe; inzira zisanzwe n'embeddings zikora kuri Cloudflare.
- Ibirori binyuze kuri interineti birafatishwa n'abantu bose. Amafoto n'amashusho akagezweho nk'imikoresho y'imibare (links)
yashyizwe muri Blossom file hosts isobanutse, aho ahoho y'ifishi ari hash hash yayo. Umuntu wese ufite
iyo mikoresho (link) ashobora kuyifungura, kandi Nymbot ntabwo ishobora kuyivura ikindi gihe. Saba
b64_jsonkandi ifoto yakozwe n'ikoranabuhanga isubizwa mu mwandiko ariko ntigeza yishyurwa. - Ese amafoto uha ari igikoresho cyo kubaka? Ifoto urekuye kuri
guhindura, cyangwa ubinyuzije nk'a
data:URL muri uyunguruyeimage_url, ishyizwa kuri Blossom host yose abantu bashobora kubona mbere na mbere kugira ngo generator ishobore kuyikura, kandi n'ibindi bimeze nk'ibyo. Ifoto yoherejwe nahttps://Ilink yohererezwa nk'iyo link. Amafoto mu gusaba kuganira (chat request) ajya kuri uwo uhawe serivisi ya model, si kuri Blossom. - Ikirango kirehubungijwe na nym yawe. Icyo ari cyo cyose urugero rwakoresheje ruri mu miterere yawe, kiragabanuka ku miterere ya nym yawe, bityo gukoresha API si utazwi. Niba ushaka gukoresha API ubikuraho ku nshinga yawe isanzwe, kora amashanyarazi (keys) ukoresheje izina ryawe rya kinyamabanga rya wenyine rifite inguzanyo yaryo yihariye.
Niba ukeneye uburinzi bw'uburyo bwo gukoresha porogaramu (apps), koresha izo porogaramu. API ikoreshwa igihe ukeneye imikoreshereze y'imimodeli (models) mu bikoresho byawe bwite.
Buriya aho bose n'aho bose biterera
| Iherezo | Icyo ikora | Ubwemunyura |
|---|---|---|
GET /api/v1/models | Urutonde rw'amajambo yerekana imimodeli, hamwe n'ibiciro | Nta kiboneka |
POST /api/v1/chat/completions | Kuzuza ibiganiro | Isakoshi |
POST /api/v1/responses | API z'Ibisubizo | Isakoshi |
POST /api/v1/messages | Ubutumwa bwa Anthropic | Isakoshi |
POST /api/v1/messages/count_tokens | Icyerekezo cy'ibitekerezo by'ibitekerezo binjijwe | Isakoshi |
POST /api/v1/images/generations | Gukora amashusho | Ifunguzo cyangwa Imirasire y'umurinzi |
POST /api/v1/images/edits | Ahindura ishusho | Ifunguzo cyangwa Imirasire y'umurinzi |
POST /api/v1/videos, GET /api/v1/videos, GET /api/v1/videos/{id} | Atangiza, nizanya kandi ireba amavideo | Ifunguzo, cyangwa Imirasire y'umurinzi gutangira rimwe |
POST /api/v1/audio/speech | Kuvugisha inyandiko | Ifunguzo cyangwa Imirasire y'umurinzi |
GET /api/v1/audio/models, GET /api/v1/audio/voices | Amodeli z'amajwi n'amazwi | Nta kiboneka |
POST /api/v1/audio/transcriptions, POST /api/v1/audio/translations | Imvugo ikaba inyandiko, no mu Cyongereza | Ifunguzo cyangwa Imirasire y'umurinzi |
POST /api/v1/embeddings | Embeddings | Ifunguzo cyangwa Imirasire y'umurinzi |
GET /api/v1/credits/balance (cyangwa POST) | Imbaraga zombi | Isakoshi |
GET /api/v1/topup/payment-methods | Uburyo bwo kwishyura | Nta kiboneka |
POST /api/v1/topup/create/btc-lightning | Injyanye ya Lightning | Isakoshi |
GET /api/v1/topup/status/{invoice_id} | Guzungura no kubishyira kuri konti | Isakoshi |
GET /api/v1/queries/history | Icyo buri gusaba biterwa iki | Ifunguzo cyangwa nym |
GET /api/v1/account | Incamake y'ibyo ufatanye n'ibyo ufitanye | Nym |
/api/v1/keys | Gukora, guhindura no gusiba amashyirahamwe y'amashyirahamwe (keys) | Nym |
/api/v1/nwc-auto-topup | Kuzuzanya ibishoro ukwayo | Nym |
GET /api/v1/l402/refunds, POST /api/v1/l402/refunds/redeem | Ireba cyangwa usubize agaciro k'icyatanzwe mu buryo bw'amafaranga yari yasubijwe (refund token) | Token y'isubizwa ry'amafaranga; nym yo kwishyura |
"Nym" bishatse kuvuga ubusabe rwashyizwe umukono n'urugero rwa Nostr rwawe, rwasobanuye muri gusinya ubusabe bw'kontiKu bikoresho birimo bikoresha aya mafomati, reba ibikoresho na SDKs, kandi ku bagenzi b’ibigo by’iburyo bwa kode nk' Claude Code, Codex na Cline, reba ibikoresho byo gukora coding.