Gara qabiyyee isaatti darbaa
Nymbotitti deebi'uuf

Bu’uura beekumsaa Uumtoota

Ibsa API

Moodeelota, genareetotaa fi balansii appii keessatti fayyadamtu, koodii keessan irraa kan dhufe. API'n foormaatota OpenAI fi Anthropic dubbata, kanaaf meeshaaleen fi SDK'n hundi URL bu'uraa fi kii (key) jijjiiruun hojjetu.

API maali?

HTTP API tokko irratti nymbot.ai ersa gaaffiiwwan OpenAI ykn Anthropic kilaayintii tokko dura ergaa ture sana deebisu. Ati argatta:

Namoota lamaan sana irraa kaffaltiin ni raawwatama Sakkoo akkuma appii sanaatti, gatii wal fakkaatuun. Walitti fufiinsa (subscription) fi bilisaan fayyadamuu (free allowance) API irratti hin jiru: gaaffii (request) hundi kiree ati bitatte irraa kaffalama.

Wanti API'n hin goone Nymbot irraa waan tokko dabaluu dha. Erriin keessan akka isin ergitanitti moodelichaaf ni dhiyaatu: prompt sirna Nymbot hin jiru, yaadannoon hin jiru, guyyaa ykn qajeelfama afaaniitiin hin dabalamu. Wanti deebi'u deebii moodelichaa fi odeeffannoo gatii kaffalamuu dha.

URL-wwan bu'uraa

HojjedhuURL Bu'uuraa
SDK-wwan OpenAI fi meeshaalee OpenAI waliin kan wal simatanhttps://nymbot.ai/api/v1
Anthropic SDKwwan fi Claude Codehttps://nymbot.ai/api (SDK'n isaan dabalee /v1/messages ofuma isaa)

Endpoint hundi ... jala argama /api/v1/Daandii hin beekamne deebi'a 404 fi karaa beekamu mala dogoggoraatiin waamame deebisa 405, lamaan ummas akka JSON.

API'n gaaffiiwwan bakka adda addaa irraa dhufan deebii kenna, kanaaf garuu fuula brauzaraa tokkoon itti bilbiluu danda'ama. Haa ta'u malee, waan ati braazaraatti ergitu hunda eenyutuunyyuu yoo banne dubbisuu danda'a, kanaafuu kiyya xiqqoo qabu qofaan godhi huccuu. Bakkeewwan xumuraa (endpoints) maqaa keetiin (keys, summary herregaa, NWC ofisii gadi bu'uun auto-top-up fi deebisanii fudhachuu refund redemption) mallatteeffaman dhimma addaa dha: bifa 'browser' tiin immoo weebsaayitoota Nymbot qofatti deebii kennu. Ilaali gaaffiiwwan herrega mallatteessuu.

JSON body hunda kanaan ergi Content-Type: application/json. Gosa biraa kamiyyuu dhorkama/furaama 415, kanaaf foormii HTML qofa moo a text/plain gaaffiin marsariitii biraa API'icha hin gahu. cURL fayyadamanii, darbi -H "Content-Type: application/json" wajjin -d.

Tooftaa API

Tooftaan (Keys) appii keessatti hojjetamu. Banu API appii weebii sanaa irratti, ykn meenii Android fi iOS irratti, achiis tuqi Muuxi/Muxee uumiMaqaa kenniif, yoo barbaaddes, makaa fi guyyaa xumuraa kenni.

Ijiin tokko qofaan ni mul'ata. Fuula kana cufuu dura bakka nagaa ta'etti hiiki: Nymbot mallattoo qubeessaa (fingerprint) isaa qofa qaba, kanaafuu yommuu ittiin deebisanii siif agarsiisuu hin danda'u. Ijiin dhabame deebisanii argachuu hin danda'amu; iji sana haqii iji biraa hojjedhu.

Kalaan akkamitti fakkaata sk-nymbot- harca 43 xurreeffii, lakkoofsaa, daashii fi hiika (underscore) kan deebisanii. Appiin hiika (key) kamiyyuu maqaa fi qajeelfama gabaabaa akkuma kana jedhuun tarreessa. sk-nymbot-Qm7x…c2Lw.

  • Muuddee tokko nym keetiif kan ta'u dha. Inni baajata kee baasa, fi kan inni uumu, jijjiiru ykn haqee nym kee qofadha. Namni moota (key) qabu kamiyyuu kanaan baasuu danda'a, kanaafis akka jecha iyyataatiin (password) eeggadhu.
  • Caps satiis dha. Tooftaan furtuun hamma maallaqa itti fayyadamaa (spending cap) qabaachuu danda'a, hamma sunis guyyaa guyyaatti, torbanitti (Wiixata) ykn ji'atti (guyyaa jalqabaa), sa'aatii 00:00 UTC irratti deebisanii fiduu danda'u. Inni baasii lamaan irratti lakkaa'a: kireetii garaa garaa (standard credit) akka 10 satsii fi kireetii Pro akka 100tti, kanaafuu gaaffiin kireetii kam irratti fayyadamu inni tuqaa qaba jedhamee hin jijjiiramu. Gaaffiin tokko hin hojjeatin dura, hamma inni kaffalamu (kireetiitti qofatti garaa garaatti ol kaafamee) hamma hamma kireetii jiruun walitti qabata. Yoo hamma kireetii jiruun wal hin deemu ta'e, gaaffiin sun dhabamee (refused) jedhamee deebisama. 403 key_limit_reached, deebiin sun hamma dhibbeentaa (cap) jala jiraatus; dogoggorri sun hamma dhibbeentaan (cap) hammaataa qabu fi yoom akka deebi'u agarsiisa. Gadloo suuphuu max_tokens kun rakkoo xaxamaa sana ni hir'isa. Gaaffiin gatii dhugaa inni baasuun qabuun kaffalama, kun immoo danda'ummaa (cap) irratti ni lakkaa'ama; kanaaf, yoo ogeessi tokeniiwwan qophaa'anii ol gabaase, gaaffiin dhumaa kan danda'ame sun damee (key) dandeettii isaa xiqqoo ol dabarsuu danda'a; kan itti aanu immoo ni dhorkama.
  • Kappeeti dadhabe tokko fudhachuun maallaqa dhabuu qofa dha. Kalaan qofaanis waldaa isaa sakatta'uu, seenaa isaa dubbisuu, moodellotaan lakkoofsuu, tookenota lakkoofsuu, kaffaltii dabaluu fi viidiyoo inni jalqabe sakatta'uu danda'a.
  • Xumura dhumatti (Expiry) filannoo qofa. Guyyaa ati murteessiteen booda, furtuun hojjechuu dhaabdi.
  • Harkifamu ni danda'ama, akkasumas yoomiyyuu fi xumura dha. Kulloonni dhowwaman (revoked) gaaffii isaanii itti aanu irratti ni dadhabu. Tarree keessa ni hafaannu, mallattoo dhowwamuu qabuun, akkasumas seenaan maallaqa itti fayyadamaa isaanii itti fufiinsa qabaachuu isaa mirkaneessuuf.
  • Kiiwwan hojii irra jiran hanga 25 qabachuu dandeessa, kan tokkooleen iyyuu maqaa isaanii qabu. Jijjiiruu kii fi yeroo irra deebii (reset period) isaa gochuun yeroo haaraa eessaa (zero) jalqaba.

Waraqni tokko tokko kanaan walitti dhufeenya kaffaltii furtuu kamiyyuu yeroo kanaa fi walumaagala, yoom akka ammaatii fayyadaman, balansii keessan lamaan, fi gaaffiiwwan API dhiheenya kanaa agarsiisa. Endpoint-oonni isaa duubatti jiran qajeelfama kana jala ibsamu: iiqiloota bulchuu.

Gaaffii mirkaneessuu

Muuxii (key) kana mataffaa (header) kana keessaa tokko keessatti ergi. Isaan wal-qixxii dha, kanaafuu kan client kee yankaa dabe (default) fayyadami:

GubbaaErgamee kennaa
Authorization: Bearer sk-nymbot-…OpenAI SDKs, meeshaalee hedduu, Claude Code waliin ANTHROPIC_AUTH_TOKEN
x-api-key: sk-nymbot-…SDK-wwan Anthropic
api-key: sk-nymbot-…Clientii akka bifa Azureaatiin qophaa'an

Kiyii hin jirre, hin beekamu, kan haqame ykn kan xumurame deebisiisa 401, koodii waliin missing_api_key, invalid_api_key, revoked_api_key yookaan expired_api_keyMoodleota, moodelota sagalee fi sagaleewwan, akkasumas maloota kaffaltii tarreessuun furtuu hin barbaadu.

Fakkiiwwan, viidiyoo, dubbii, barreeffama sagalee fi embeddings yeroo tokkoon gaaffii tokko Lightning irratti kiippii tokko malee kaffaluun ni danda'ama: gaaffii kiippii malee ergi fi kaffaltii keessatti... 402 deebii. Ilaali Furtii malee ergaa tokkoon kaffaluu..

Bulchiinsa furtuu, gabaasni herregaa fi kaffaltiiwwan ofumaan deeman yakka qofa: isaan furtuu toora keetii (nym) mannaa mallattoo fudhatu, kanaaf furtuu dhuunfatame furtuu dabalataa uumuu hin danda'u. Ilaali gaaffiiwwan herrega mallatteessuu.

Gaaffii kee jalqabaa

Koodii sana bakka bu'aa naannoo (environment variable) keessatti kaa'i, sana booda moodeela tokko gaaffii gaafadhu. Fakkeenyi hundi barruulee kanneen keessa jiran kan dubbisan... 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 karaa Nymbot kan mataa isaa, kaffaltiin isaas balansi qulqulluu (standard balance) irraa kan kaffalamudha. Bakka sana irratti id lafa model kaatalaatiin (catalog model) kan akka, dhiyeessi anthropic/claude-sonnet-5, moodeela sana fayyadamuuf balance Pro irraa. Moodeelota tarreeffachuu id hunda kenna.

Gaaffiin tokko gatii meeqa?

API-n kaffaltiin isaa akka appii sanaatti sirriitti kaffaltii qaba.

  • Gamoo kam? nymbot/auto dabarsu kaayyoo hisaaba (10 sats kireemii tokkoof). Modelliin chat biroo hundi isa... Pro hisaaba (100 sats a credit). Kaayyoo fakkii bu'uuraa fi sagalee bu'uuraan kireetii bu'uuraa fayyadama; kan biroo hundi kan Pro fayyadama. Embeddings kireetii bu'uuraa fayyadama. Transcription yoo hisaaba bu'uuraan gargaaru kireetii bu'uuraa fayyadama, yoo hin taane immoo kireetii Pro fayyadama. Tarree moodeelotaa kireetiin moodeelli hundi ittiin fayyadaman kan agarsiisu dha.
  • Hamma meeqa. Gaaffiin chatii tokko tokenii moodeelii sun dubbisee fi barreessetti madaallii qaba, karaan itti kaffalamus gatii dhuunfaan dhiyeessamaa (provider) irratti hundaa'a. Gatiin sun kaffaltii 5% qaba, sana booda immoo gara 1.5tti baay'ifama, kanaaf gatii dhiyeessamaa irratti 1.575 jecha kaffaltiin ni dabala. Gatiin kun gatii Bitcoin yeroo ammaa irratti hundaa'ee gara satsitti jijjiirama, akkasumas kutaa kireditii (credit) kummatama tokkoon kaffalama. Suuraawwan ogummaa qaban, viidiyoowwan fi dubbiiwwan gatiin isaanii akkaataa uumamaa (generation), akkaataa sekondaa ykn akkaataa qubeetti madaalamu, akkasumas hiikkaan sagalee sekondaa tokkoof madaalamu, kaffaltii fi margin sana qabuun dhiyeessama. Suuraan amansiisaa (standard) kireditii 5 amansiisaa yoo ta'u, sagaleen amansiisaas kireditii 3 amansiisaa dha.
  • Hiddan dacha. Gaaffiin hundi kanasimaa (metered) kan hojjetu hundi kireetii 0.05 yoo xiqqaate kaffaluu barbaada: baalansa standard irratti saatii (sat) walakkaa tokko, Pro irratti satii 5. Kutaa kireetii xiqqaate (fractions) yeroo hunda gara fuulduraatti dabarfamu, yoo hin guddifamne.
  • Dhaabbadhu, erisii boqodhu. Erga gaaffiin hojjetamee dura, kaffaltii guddaa inni danda'u kan ergite irratti hundaa'uun saldoo kee keessaa qabsiifama. Barreeffamni ASCII qofaa hin taane isaa baay'ina bytes UTF-8 isaa irraa hundaa'ee madaalama, akkasumas lakkoofsota fi mallattoolee ASCII tokkoon tokkoon tokko token jedhamanii lakkaawamu, kanaaf barreeffamni afaan kamiyyuu, koodii fi lakkoofsota guutummaatti qabsiifama. Qabsiifamni kun kireedittii guutuu, tokko irraa garaa garaati, kanaaf gaaffiin kamiyyuu eegaluuf saldoo sadii (standard) irratti yoo xiqqaate 10 sats ykn Pro irratti 100 sats ni barbaada. Kaffaltii dhugaa qofa kaffaltiin ni fudhata; isa kaan immoo erga xumuramee booda deebi'ee siif siif dhiifama. Gaaffiin dheeraan yeroo hamma hojjetutti qabsiifama isaa eega; yoo kireeditiin qabsiifame tokko tokkoan deebi'ee argachuu dhiise, stream-iin tokko kanaan dhaabbata 402 insufficient_balance fashalaan uumame, kan uumameef immoo kaffaltiin ni fudhatama. Yoo gatiin dhugaa balansiin kaffaluu danda'u caalu ta'e, balansiin guutumtuu ni fudhatama, hundi isaa immoo ni kaffalamuu qaba (owed_sats keessatti nymbot objektiif, fi walii-gala nagaa hin qabne). Maal akka dhabame ta'e kanaan dura kireetiin (credits) itti dhufuun kaffalama. Hamma kaffalamuutti, walii-gala sana keessatti waan tokko ala hin dabarsamu: API-n, deebiin appii keessatti, dabarsaa (transfer) ykn kennaa (gift).
  • Kreditii gahaa hin jiru. Yoo herregaan (balance) qabiyyee (hold) hin dabarsin, gaaffiin [...] waliin رفضatama (refused) 402 waan tokko dura raawwatamuu dura. Dogoggorriichi waldaa kamii akka hin jirre, gaaffichi sat'i meeqa akka barbaadu fi meeqa akka qabu dubbata. Inni xiqqaatu max_tokens holdii xiqqaadha jechuudha.
  • Fashalaa. Gaaffiin hamma hin dhumatin kan hin milkoofne gatii hin kaffalan, yoo dhuunfaan hojii inni dura hojjeteef kaffaltii si gaafate malee, ykn barbaacha weebii ykn... nymbot/auto hojii hojii duraan raawwatameera; sana booda kaffaltiin kee sun, ijoon 0.05 credit ta'a. Viidiyoo/Stream ati kutteef kaffaltiin tokenii kan weenchaan (provider) gabaaseen dhiyaata: Nymbot lakkoofsa sana argachuuf yoo ati baatees hanga sekondii 25tti stream weenchaa sana dubbisa. Yoo inni hin dhumne, kaffaltiin sun wanta ati ergite fi wanta barreeffame irraa tilmaamama, akkasumas moodeela yaada qabuuf (reasoning model) kaffaltiin gabaasni guutuu kan qabame dabalata. Gaaffii qunnamtiin isaa kutte jedhamee iyyuu, hojiin isaa xumurama, kaffaltiin isaas ni dhiyaata.
  • Barbaacha Weebii qarshii barbaacha tokko irratti $0.008, satsitti jijjiiramuun, yeroo barbaacha tokko raawwatamu, moodeelli sun deebii kenne ykn dadhabe, kaffalamu. Fuulota inni dubbisu kanais akka odeeffannoo (input) moodeelli sunitti eramu, kanaaf tokummaa (tokens) isaanii dabalu.

Deebiin hundi gatii isaa ni hima. Deebiin JSON tokko ni qaba... nymbot walitti qabxii baasii kaffaltii irraa dhufe, kireeditii fi satsitti kaffaltii bu'aa, fi maaltu hafe:

Bakka kaffaltii (cost object)

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

Deebiin kaffaltii ragaa ta'an headerwwan kanneen qabu, kun immoo bakka kaffaltii deebii kan akka dubbii (speech) ta'ee JSON hin taane itti argamuudha:

GubbaaHiika
X-Nymbot-Cost-SatsGaaffiin kun sats meeqa gatii kaffala?
X-Nymbot-Balance-SatsBaasii kanaan kaffaltiin irraa raawwatame irratti, satsii keessatti maaltu hafe?
X-Request-IdIdii gaaffii sanaaf, deebii hundaan. Yoo deeggarsa barbaadde ergaa kana dubbisi.

Gatiin tokenii miiliyoona tokkoof, kaffaltii fi marginii of keessaa kan qabate, ... keessatti argamu. Tarree moodeelotaa doolara fi satsiin, fi irratti liista gatii. Yoo gatiin Bitcoin dubbisuu hin dandeenye, gaaffiiwwan kaffaltii barbaadan deebisu 503 price_unavailable waliin Retry-After: 60 hin tilmaamin dura.

Dogoggora

Dogoggorri hundi bifa wal-fakkaataa qabu, kan maamiloonni OpenAI duraan hubatan. code maqaa itti fufiinsa qabu kan walitti hidhuun danda'amu dha; message namootaaf kan ta'udha fi jijjiiramuu danda'a.

Qaama Dogoggoraa

{
  "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
  }
}
HaalaYoom
400 invalid_request_errorQaamichi JSON sirrii miti (invalid_json), bakki dirqamaatiin barbaadamu hin jiru (missing_required_parameter), qiimni tokko dogoggora, yookaan gaaffiin waan moodeelli yookaan endpoint'n hin hojjenne gaafata, kan akka meeshaalee (tools) on nymbot/auto (unsupported_tool). param maqaafi daataa. Akkasumas upstream_rejected yeroo dhiyeessituun gaaffii sana رفضee (diddee).
401 authentication_errorKiiin hin jiru, hin beekamu, haqee yookaan xumurameera, yookaan gaaffiin mallatteeffame dogoggora yookaan irra deebii fayyadamaa'e dha.
402 insufficient_quotaBaasiin gaaffii kana hin danda'u. Code insufficient_balance, waliin balance, required_sats fi balance_sats.
403 permission_errorGaaffiin qabxii kanaan wal hin simatu (key_limit_reached, waliin limit_sats, used_sats fi reset_at), yookaan herregaan tajaajila sana fayyadamuu dhiisuu danda'a (account_denied).
404 not_found_errorDaandii hin beekamne (unknown_endpoint), moodelii hin jirre (model_not_found), yookaan furtuu hin beekamne, inwooyisii yookaan viidiyoo.
405Daandii jiru garuu mala sanaan miti (method_not_allowed). Kan Allow Header-ni malaalee inni fudhatu tarreessa.
413Qaamni ykn fayiiliin sun baay'ee guddaadha (payload_too_large, file_too_large), yookaan waraabni baay'ee dheeraa yoo ta'e (audio_too_long). Ilaa daangaa.
415 invalid_request_errorQaamni akka... hin ergamu application/json (yookaan, bakka ol-fe'uuf itti fayyadamaniif, multipart/form-data): unsupported_media_type.
422Sagalee fi afaan barreeffama gara sagaleetti jijjiiru keessatti wal hin taane (voice_language_mismatch, unsupported_language).
429 rate_limit_errorIyyannoonni baay'ee dha kuta kanaan, teessoo kanaan, ykn ragaalee mirkaneessuun kan dadhaban waliin (rate_limit_exceeded), ykn dhiyeessaan (provider) daangaa yoo kaa'e (upstream_rate_limited). Sekondii keessatti eegi Retry-After.
500 api_errorNymbot biraan rakkoon uumame (internal_error).
502 api_errorTajaajila kennuun deebii hin kenne (upstream_error), ykn kaffaltii Lightning invoice ta'uu hin dandeenye (invoice_unavailable).
503 api_errorTajaajila kennuun baay'ee hojii uumameera (upstream_overloaded), gatiin Bitcoin dubbisuu hin danda'amu (price_unavailable), ykn kutaan tajaajilaa tokko hojii dhaabeera (service_unavailable, media_hosting_unavailable). Retry-After yoom irra deebii akka kennamu jedha, bakka beekamu.

Inneksiinoonni lama:

  • /api/v1/messages deebiiwwan bifa dogoggora Anthropic tiin, sababni isaas kan maamiltoota Anthropic xiinxalu dha: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. Gosa eenyummaa eenyummaa dhimma irratti hundaa'e hordofa: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error yookaan overloaded_error (503).
  • Gaaffiin streaming duraa byte jalqabaa dura yoo fashale, error JSON walii akka armaan olii qabuun dhiyaata, stream event miti. Erga stream jalqabamee booda yoo fashale immoo, akka event dhumaa streamichaatti, bifa endpointichaatiin erga.

Ergaan dogoggoraa tokko tokko odeeffannoo keessoo tajaajila biroo hin qaban. Dogoggorri tajaajila tokkoo kan mataa isaa si ga'uu dura bifa biraatiin hiikama.

Daangaa

LimitiiFaayidaa
Dhimmoota furtii irratti hundaa'andakika tokkoof daqiiqaa 120. Sana ol, 429 waliin Retry-After.
Gaaffiiwwan furtuu maleeXiinxala dhuunfaaf daqiiqaa tokko irratti teessuma (address) tokko 120, moodeelii, tarreewwan sagalee fi maloota kaffaltii, qorannoo tookenii deebii kaffaltii (refund token checks), fi bakka xumura (endpoints) kaffaltiin gaafatamuu danda'u keyii ykn kaffaltii malee waamaman irratti. Sana ol, 429 waliin Retry-After.
Ragaa mirkaneessuun dadhabeJegummaa, mallattoo, odeeffannoo kaffaltii fi tookenii deebisii kaffaltii (refund tokens) kan hin mirkaneessineef, teessoo (address) tokkoof daqiiqaa tokko irratti 30 qooda. Sana ol, teessoo odeeffannoo (credential) dharreessu irraa dhufe kan hundeeffate hundi... 429 waliin Retry-After daqiiqni hin dhumatin dura. Erga qaamni dubbifamee booda ragaaleen ni qulqullaa'u.
Durii haaraasa'aatii tokkoof nym tokkoof 60 fi teessoo tokkoof 120.
Invoosiiwwan kaffaltii dabalataasa'aatii tokkoof nym tokkoof 60 fi teessoo tokkoof 120.
Walitti dhufeenya waletii NWCsa'aatii tokkoof nym tokkoof 10 fi teessuma tokkoof sa'aatii tokkoof 30. Wallet relay-n itti fayyadamuu qaba wss:// portii isaanii sirnaa irratti.
Tokeniiwwan deebisi (Refund tokens)Tokko tokkoof daqiiqaa tokko irratti gaaffii 60.
TeessotaAddress IPv6 tokko hunda ifa limitii addressii irratti /64 guutuu ta'ee lakkaa'ama, addressii IPv6 kan IPv4-n mappii ta'e immoo akkuma addressii IPv4 isaa lakkaa'ama.
JSON qaataa xumuraa ergaa4 MB; 64 KB dhimmoota nym keetiin mallatteeffamanef.
Qaama gaaffii multipart (uploadiiwwan)32 MB. Fakkii edituu kan ta'u hanga 20 MB danda'a, faayila sagalee hanga 25 MB. Hamma tokkoon kutaa 64, isaan tokkoon immoo imbaatara kutaa (part header) hanga 8 KB qabaachuu danda'a, fi daangaa qubaa 1 hanga 70 ta'e; yoo ta'e immoo 400 invalid_multipart.
Fakkiiwwan gaaffii chat tokko keessatti20. Hunda keessaa tokko tokko... https:// yookaan http:// liinkii hostii uummataa, ykn... data:image/… URL.
Fakkiiwwan gaaffii uuminsa tokkoof1 hanga 4 (n)
Tokkanootii bu'aaMaximumii moodeela ituun dhumata. Tokko guddaan max_tokens hamma sana gadi lakkifama, garuu hin fudhatamu.
Sagalee galchisuuSagalee qofaa (standard voice) irratti qubee 800, Aura 2 irratti qubee 2,000.
BarreeffamuuSagalee daqiiqaa 30, 25 MB. Galmeen dheeraan ni رفضama (ni didama) kan jedhuun... 413 akkasumas hin kaffalamu, yeroo dheerina isaa Whisper dhaga'ee booda qofaan beekamu danda'us.
EmbeddingsGaaffii hundaaf galmee 100.
Hojiiwwan ViidiyooErga ergamaniitti sa'aatii 24f qabamuu; sa'aatii tokko booda renderii kennama. Nym tokkoof yeroo tokkotti rendering 10 hamma dhumatti.
Seenaa gaaffiiGuyyaa 90f kuufame.
Furtuulee hojii irratti jiran kan nym25. Kileyiiwwan haqeeffaman haaraa ta'an 50 qofatu kuufama.

Hojii fakkii tokkoof linkii kennamu kan qajeelaa ta'e hostii uumamaa (public) irratti qabaachuu qaba: teessoon (address) vaalasii ykn network dhuunfaa, ykn karaa weebsaayitoota Nymbot qofaa irratti argamu, ni رفضama. Pacing dizaayinii tajaajilaa (provider pacing) appii keessatti hojiiru kan asis irratti hojjetu dha, kanaafuu gaaffiiwwan (requests) dizaayinii tokkootti walitti dhufeen akka baay'atan gochuun gufuu uumuu mannaa, saffisa isaanii hir'isuun ni danda'ama.

API-n kun maal arguu danda'a

API'n akkuma appiiwwan sanaatti dhuunfaa miti, akkamitti akka ta'e irratti sirriitti dubbachuun immoo barbaachisaadha.

  • Kakuu dhiphataa (end-to-end) hin qabu. Appilikeeshonoota keessatti, ergaan deebii qabdu salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti salphaatti sal kennata uffataa. Gaaffiin API HTTPS dhuunfaa dha: karaa Nymbot gara deemutti kan qulqullaa'e dha, fi serwerii Nymbot sirna qulqulluu ta'een deebii ittiin kennuuf dubbisa.
  • Yaadoota fi deebiiwwan hin kuufamu. Isaan moodeela keessa darbu, deebiin immoo deebi'ee darba. Kan kuufamu garuu bilbila dha: gaaffii hundaaf yeroo, moodeela, gosa, lakkoofsa tookenii, gatii, baalansii, kiiyii fi milkaa'ina isaa, guyyaa 90f, kunis maali? seenaa gaaffii siif agarsiisa. Galmeen fayyadama gaaffii sanaatiin (yeroo, gosa, moodela, lakkoofsa tookenii, gatii, dheerina fi immoo barbaacha weebsaayitiin fayyadame yookaan milkaa'uu isaa) guyyoota 90 keessatti, kan appii sanaatiin wal qabatu waliin kuufama.
  • Wanti biroo nym natti fakkatu hundi xiqqoodha, as irrattis kan tarreeffameedha. Tooftaa API hashii keessatti kuufamu, kofii (key) hin kuufamu, maqaa isaanii, qajeelfama gabaabaa, dabalata baasii (spending cap), yeroo deebisanii ibsan (reset period), xumura (expiry) fi yeroo hojjetaman fi yeroo dhumaaf itti fayyadaman qabatu; kofiiwwan haqaman 50 isaanii dhumaa qofa kuufamu. An ufurtaa ofumaan deebi'u wallet walitti hidhamiinsa isaa, walakkaa isaa, hammana fi bu'aa kaffaltii dhiyeenya irratti argame wajjin kan qulqullaa'e (encrypted) ta'ee kuufama. Hojii viidiyoo sa'aatii 24f kan kuufamu dha. Gaaffii kaffaltiin isaa callii tokkoof ta'e, hashii kaffaltii Lightning guyyaa 7f fi tokeeni (token) deebisanii kaffaluu kan hashed ta'e guyyaa 30f qofa dhiisa, kun immoo maqaa (nym) kamiyyuu wajjin hin walqabatu. Kaffaltii baasiin (balance) hin danda'in hordofni isaa kaffaltiin dhiyeenyi (top-up) yoo kaffale qofa hordofni isaa ni dhumata.
  • Appii kana balleessuun isaa akka balleeffamu taasisa. A meeshaa qulqulleessuu hiiqa qindii API hunda kana balleessa, akkasumas seenaa gaaffii, ragaalee fayyadamaa, walitti hidhamiinsa waletii fi hojii viidiyoo balleessa. Gamna fi kaffaltiin hundi harka kanaan oluun immoo nym irratti hafa.
  • Dallaa moodeelichaa gaaffii kee argata, akka appii sanaa ta'etti. Catalog moodeelota uumtoota isaaniitiin hojjetamu; karaalee fi embedding-oota dabeessaan Cloudflare irratti hojjetu.
  • Miidiyaan uumame kamuudha. Fakkiiwwan fi viidiyoowwan akka linkii dhiyaatan hostii file Blossom beekamaa irratti olka'an, bakka teessoon file sanaa hash isaa ta'udha. Namni linkicha qabu hundi banaachuu danda'a, Nymbot immoo deebisee balleessuu hin danda'u. Gaafadhu b64_json fi fakkii uumame deebii keessatti deebi'ee dhufa, akkasumas yoomiyyuu hin ol-fe'amu.
  • Kanaafuu, fakkiiwwan ati kennitu uumtii (generator) dha? Fakkii ati ol fe'itu fooyyessu, yookaan akka a... ergi data: URL uumuu (generator) keessatti image_url, dura Blossom host bifa dhuunfaan olka'uun dursa jira akka generator'ichi fudhachuu danda'uuf, akkasumas kanaafis wal fakkaata. Suuraan ergame... https:// hiriyaan akkuma hiriyaa sanaatti dabarsama. Fakkiiwwan gaaffii chat keessatti jiran tajaajilaa modelii sanaa bira etan, Blossom bira miti.
  • Tooftaan furtuun nym kee waliin walqabattee jirti. Wanti furtuun (key) tokko baasu hunda baajata nym keetiirraa hir'isa, kanaafuu fayyadama API... namummaa hin qabne. Yoo API fayyadama kee nym kee guyyaa guyyaa irraa adda baafachuu barbaadde, kiiwwan (keys) nym addaa kan waldaa (balance) mataa isaa qabu irraa hojjedhu.

Yoo eegumsa appii barbaadde, appii fayyadami. API'n immoo yeroo moodelota meeshaalee kee keessatti barbaadduufi.

Endpoint hunda

Xumura QarqaraaWaan hojjatuHayyuu
GET /api/v1/modelsMoodeelota tarreessi, gatii waliinHomaa
POST /api/v1/chat/completionsXumura MariiKoftee
POST /api/v1/responsesAPI DeebiiwwaniiKoftee
POST /api/v1/messagesAnthropic ErgaawwanKoftee
POST /api/v1/messages/count_tokensTokeniiwwan dhiyaatan yaaduuKoftee
POST /api/v1/images/generationsFakkiiwwan uumaKey yookaan Xuraayaa
POST /api/v1/images/editsFakkii tokko sirreessaKey yookaan Xuraayaa
POST /api/v1/videos, GET /api/v1/videos, GET /api/v1/videos/{id}Viidiyoowwan jalqaba, tarreessa fi qorata godhaKii, ykn Xuraayaa Tokko jalqabuuf
POST /api/v1/audio/speechBarruu gara sagaleetti jijjiiruuKey yookaan Xuraayaa
GET /api/v1/audio/models, GET /api/v1/audio/voicesMoodellota sagalee fi sagaleewwanHomaa
POST /api/v1/audio/transcriptions, POST /api/v1/audio/translationsSagalee gara barreeffamaatti, fi gara IngiliffattiKey yookaan Xuraayaa
POST /api/v1/embeddingsEmbeddingsKey yookaan Xuraayaa
GET /api/v1/credits/balance (yookaan POST)Balansiwwan lamaan turanKoftee
GET /api/v1/topup/payment-methodsAkkaataa kaffaltiiHomaa
POST /api/v1/topup/create/btc-lightningInbooyisii LightningKoftee
GET /api/v1/topup/status/{invoice_id}Akkuma mirkaneessa fi kireedii itti kennaa dhaKoftee
GET /api/v1/queries/historyKutannaan tokko tokko gatii meeqa?Kii ykn nym
GET /api/v1/accountCuunfa herregaaNym
/api/v1/keysIjoollee, jijjiirama, fi haqee furtuuwwan uumaNym
/api/v1/nwc-auto-topupBu’uura ofii ofumaan guutuunNym
GET /api/v1/l402/refunds, POST /api/v1/l402/refunds/redeemTokenii deebii kaffaltii mirkaneessa yookaan fura.Token deebisii; nym itti fayyadamaaf

“Nym” jechuun gaaffii furtuu Nostr keetiin mallatteeffame, kan ibsamu kana keessatti dha gaaffiiwwan herrega mallatteessuu. Meeshaalee foormatawwan kun dubbatan kana ilaali, meeshaalee fi SDK'wwan, akkasumas ajantoota koodingii kanneen akka Claude Code, Codex fi Cline, ilaali meeshaalee koodingii.