Fa'avae poto / Atia'i Fausiaina

Fa'amatalaga atoa o le API

O modele, generators ma le totogia o lo'o e fa'aaogaina i totonu o le polokalame, mai lau lava kōdu. O le API e tautala i tulaga OpenAI ma Anthropic, o lea o le tele o meafaigaluega ma SDKs e galue e ala i le suia o le fa'avae URL ma se ki.

O lenei itulau ua fa'aliliuina i masini mo le fa'afaigofieina. O le ulua'i fa'a-Peretania o le fa'amatalaga lea e fa'atatau.

O le ā le API

Se HTTP API i luga o nymbot.ai o lea e tali atu ai i lava lava talosaga e uma ona lafo e se polokalame a se tagata fa'aaoga o OpenAI pe Anthropic. E maua oe:

• Fa'auna o Talanoaga, le API o Tali ma Feau a Anthropic, ma le streaming, meafaigaluega, ata, fa'amanatu ma le sailiga i luga o le upega tafa'ilagi, mo taimi uma o le model i le katalogi ma mo le auto-routing lava ia a Nymbot.
• Atuāfaamatalaga o Ata, vitio, lau lauga, tusiga ma fa'asologa o fa'amatalaga nini.
• O lau tautupe o lo o totoe, Fa'asalaga o le Lightning, fa'aauau ni fa'asalalaga mai lau komea tupe ma se talafaasolopito o le tau o le talosaga ta'itasi.

E totogi mai i le tutusa o le lua e pei o lena tupe maua ma tupe fa'amaumau pei o le polokalame, i tau e tutusa lava. E leai se faʻasaoina (subscription) ma e leai se saʻoloto i le API: o le mea uma e talosaga atu ai e totogi mai i tupe (credits) na e faʻatauina.

O le mea e le faia e le API o le faaopoopoina o se mea e aoga mai Nymbot. O au feau e alu atu i le masini pe a e lafoina i ai: e leai se faatonuga o le Nymbot, e leai se manatu, e leai se aso po o ni faailoga o le gagana. O le mea e toe foia mai o le tali a le masini ma se faamatalaga o lona tau.

URL Faavae

Ota tele o fuafuaga e nofo i lalo o /api/v1/. O se ala lē iloa ua toe fo'i mai 404 ma se ala ua silafia ua valaauina ma le sese o le ituaiga faiga e toe foai mai ai 405, e lua fo'i o ni JSON.

O lo'o tali mai le API i talosaga mai isi upega tafa'ilagi, o lea e mafai ai e se itulau o se navigatō (browser) ona valaau i ai. Peita'i, so'o se mea e te lafoina i se navigatō e mafai ona faitau e so'oisei lava e tatalaina, o lea na'o le faia o lea mea ma se ki o lo'o iai se ki la'ititi tau. O vaega faaiu (endpoints) ua saini i lou nym (iaiga, le otootoaga o le teugatupe, le NWC auto-top-up ma le toe faafoi mai o tupe) o le faataitai: i se upega faitau (browser), latou te tali atu na o upega tafa'ilagi a Nymbot lava ia. Vaai faamautu polokalame o talosaga mo teugatupe.

Auina atu ia so'o se JSON body ma Content-Type: application/jsonO so'o isi ituaiga lava e fa'amuta ai ma 415, o se fa'asologa HTML masani pe se text/plain talosaga mai le isi upega tafaʻilagi e lē mafai ona oʻo atu i le API. Ma le cURL, lafo -H "Content-Type: application/json" bersama dengan along with -d.

Ki o le API

O suafa e fai i totonu o le polokalame. Tatala API i le sidebar o le web app, pe i le meniu i Android ma iOS, ma kiliki Fatua'i kiFa'aopoopo i se igoa ma, pe afai e te fiafia ai, se teuaga ma se aso e mae'a ai.

E fa'aali lava lava le ki i se tasi taimi. Fa'aputu le i se mea saogalemu a'o le'i tapuni le pepa: o lo'o teuina e le Nymbot na'o le fa'ailoga (fingerprint) o le ki, o lea e lē mafai ona fa'aali atu fua ia te oe i se isi taimi. Afai e leiloa le ki, e lē mafai ona toe maua; fa'amutā le fa'aaogāina o le ki lea ma faia se isi.

E pei o se ki le vaai i se mea sk-nymbot- e mulimulita'i i ni 43 tusi, numera, fa'asologa (dashes) ma fa'ailoga (underscores). O lo'o lisiina e le polokalame (app) tusi ta'itasi e tusa ai ma lona suafa ma se fa'ailoga pu'upu'u e pei o le sk-nymbot-Qm7x…c2Lw.

• O se ki e aofia ai lau igoa. E fa'aaluina ai lau tupe, ma na'o lau nym e mafai ona faia, suia pe aveese ai. So'o se o lo'o iai le ki e mafai ona fa'aalu ai ma le tupe, o lea fa'amolemole tausia e pei o se fa'amatalaga lilo.
• O lo'o i to'otia le cap i satoshis. E mafai ona iai se fa'atapula'i o le tupe fa'aalu i se ki, ma e mafai ona toe fa'aleleia lenei fa'atapula'i ta'itasi aso, ta'itasi vaiaso (Aso Lua) po'o ta'itasi masina (le aso muamua), i le 00:00 UTC. E aofia ai itugāfale uma e lua, o le tupe fa'aopeope standard e 10 sats ma le Pro credit e 100, o lona uiga e tutusa pe auala lava e fa'aalu ai se talosaga. A'o le'i fa'atino se talosaga, o le tele sili lea e mafai ona tau (fa'atupulaia i luga i le fuainumera atoatoa o credit) e fa'aaogāina e fa'atusatusa i le to'aitiiti o le fa'atapula'i ua totoe. Afai e le mafai ona fa'atino, o le talosaga o le a lē taliaina ma e fa'apea 403 key_limit_reached, tusa lava po o le ai lava se tali i lalo o le pusa; o lo'o fa'ailoa e le mea sese le tele o lo'o totoe ma le taimi e toe amata ai le pusa. Fa'aititia max_tokens fa'aitiitia lea o le tulaga pē o le mea sili ona leaga. O se talosaga e totogiina e fuafua i le tau moni o lona fa'agaioiga ma o le a faitauina i le tulaga maualuga, o lea afai e lipoti le lafoina o ni tokens e sili atu i le numera na fa'atulaga ai, o le talosaga mulimuli na mafai ona fa'atinoina e mafai ona sili atu i lona tulaga maualuga; o le talosaga soso'o ai ona te'ena.
• O se uaea ua uma ona faamaonia e taofia na o le faamaumauina. O se ki i lona ulu e mafai lava ona siaki le tauvaga, faitau lona talafaasolopito, lisi o ata, faitau ni tokens, toe fa'aola le tupe ma siaki se vitio ua uma ona amata.
• E lē fa'atatau le vāfea. Pe a uma le aso na e fa'atulaga, e le toe galue le ki.
• O le aveeseina e vave ma le faaiuina atoatoa. O se ki ua aveeseina e le o manuia lona talosaga soso'o lava. E tumau pea i totonu o le lisi, ua faailoga o lo'o aveeseina, ina ia mautinoa o lona talafaasolopito o tupe fa'aalu e mautinoa pea.
• E mafai ona e iai i puta o le 25 ki fa'aeke'e, o le ki ta'itasi foi e iai lona igoa fa'apitoa. O le suia o le vaitaimi toe fa'atumuina o se ki e amata ai se vaitaimi fou i le zero.

O le pepa fa'apenei e fa'aalia ai le tupe fa'aalu o masini taitasi i lenei vaitau ma le aofa'i atoa, taimi na fa'aaogāina ai mulimuli ai, o au lua tupe i totonu o lau akaoga, fa'apea foi au talosaga API talu ai nei. O vaega o lo'o i tua atu o lenei mea o lo'o fa'amaumauina i lalo i fa'atonutonuina o ki.

Fa'atumuina o se talosaga

Auina atu le ki i so'o se tasi o nei ulutala. E tutusa lava i latou, o lea fa'aaoga po'o fea lava e lafo e lau tagata fa'atau i lona lava fa'asologa:

O se ki ua leai, e le silafia, ua aveesea pe ua mae'a, e toe fo'i mai 401, ma le code missing_api_key, invalid_api_key, revoked_api_key poʻo expired_api_keyO le lisiina o ata faʻataʻitaʻiga, ata faʻaʻoaʻo, ma leo, faʻapea foʻi auala totogi e le manaʻomia se ki.

O ata, vitio, lauga, tusitusiga ma embeddings e mafai fo'i ona totogi mo se talosaga e tasi i taimi e tasi i luga o le Lightning e aunoa ma se ki lava: lafo le talosaga e aunoa ma se tasi ma totogi le invoice i le 402 tali. Va'ai totogi i soo se talosaga e aunoa ma se keli.

O le fa'ata'ita'iga o le pulega o ki, le otootoga o teugatupe, ma le fa'aopoopoina sili i aso uma: e fa'aaogā se suafa mai lau nym nai lo se ki, o lea e lē mafai e se ki ua fa'ailoga ina ia faia nisi ki. Va'ai faamautu polokalame o talosaga mo teugatupe.

Lau talosaga muamua

Tu'u le ki i se tulaga fa'apitoa o le siaki (environment variable), ona fesili atu lea i se tautua (model). O fa'ata'ita'iga i luga o nei itulau e faitauina mai i 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 o le fa'atulagaga a Nymbot lava ia, e totogi mai i le tutusa o le tauloaiga. Fa'atulaga i ai le id o se fa'atauga fa'ata'ita'iga, e pei o le anthropic/claude-sonnet-5, ina ia fa'aaoga lena modele mai le Pro balance. Lisiina o modele tu'uina atu i ai soo se id.

O le tau o se talosaga

E tutusa lava le pili a le API ma le pili a le app.

• O le fea le tupe o lo'o totoe? nymbot/auto fa'aaluina le tulaga tau (10 sats e fa'asaoina). O isi lava lava o ata o talanoaga e fa'amaumau le Faapolofesa tau (100 sats o se tupe fa'aopoopo). O le masini masani fa'atofu ata ma le masini masani fa'aaoga leo e fa'aoga tupe fa'aopoopo masani; o isi masini fa'atofu uma e fa'aoga Pro. O Embeddings e fa'aoga tupe fa'aopoopo masani. O le Transcription e fa'aoga tupe fa'aopoopo masani pe a mafai e le tupe fa'aopoopo masani ona fuafuainia, ae o tupe Pro pe a le mafai. O le lisi o modele o lo'o fa'ailoa mai ai po'o fea tupe e fa'aaoga e maso ifo modele.
• E fia le tele. O se talosaga talanoa e faitauina e tusa ai ma le NUMERA O TAUTU (tokens) na faitau ma tusia moni e le tautua, i luga o tau faalauiloa a le tuatusia. O lea tau e faaopoopo i ai se totogi e 5% ona toe faateleina lea i le 1.5, o lea e totogi ai oe i le 1.575 i le tau o le tuatusia. E suia lea i sats i le tau o Bitcoin o loo ola ma totogi i le faatolu o se kuredisi (credit). O ata faapolofesa, vitio ma le leo e totogi i le taimi o le foafoaga, i le faitau o sekone po o le faitau o isi mataitusi, ma le tusitalasi i le faitau o sekone o le leo, ma le faapea le faaopoopo o le totogi ma le faatupulaia o le tau. O le ata masani o se totogi tutusa e 5 kuredisi masani ma le leo masani e 3 tutusa.
• Le mea itiiti lava. O le faitau i le mea lava po o se talosaga e faia e iai lona tau e sili atu i le 0.05 credit: le setengah o se sat i le balance masani, 5 sats i le Pro. O vaega o se credit e faaauau atu, e le faatupulaia i taimi uma.
• Fa'atali, ona fa'atulaga lea. A o le'i amata se talosaga, o le tele lea o le tau e mafai ona totogi ai e taofia mai lau tauvaga, e faavae i le mea na e lafoina ma le tele o token e mafai ona tusi ai. O tusitusiga e lua atu i le ASCII masani e faitauina mai ana bytes UTF-8, ma numera ma faailoga ASCII e faitauina o se token ta'itasi, o lea o le tusitusiga i so'o se fa'atofiga, polokalame ma numera e taofia atoatoa. O le taofia o le tauvaga e faia i le credits atoatoa, e ao imu le tasi, o lea o so'o se talosaga e mana'omia le auaunaina o least 10 sats sa'oloto i le tauvaga masani pe 100 sats i le Pro ina ia amata ai. O le tau moni lava e totogi; o le totoe e toe fa'afo'i pe a mae'a. O se talosaga umi e taofia lona tau e pei lava o le umi o le fa'atinoina; afai o le tauvaga o lo'o taofia e le toe mafai ona fa'aaogaina, o le fa'asologa e uma ma se a 402 insufficient_balance mea sese na tupu, ma mea ua maua ua totogiina. Afai o le tau moni e sili atu i lo le tupe maua e mafai ona totogi ai, ua ave le atoa o le tupe maua, ma o le to'aitiiti totoe e totogiina (owed_sats i totonu o le nymbot (object, ma se tau fa'atiga). O le mea e totogi atu e totogi muamua mai na credits e soso'o mai e o'o i lea tau. Se'ia o'o ina totogi, e lē mafai ona fa'aalu se mea lava i luga o lena tau: e lē mafai e le API, tali i totonu o le app, se transfer po'o se meaalofa.
• E le lava le tupe i lau teugatupe. Afai e lē mafai ona lavea le totogi mo le taofia o tupe, o le talosaga e fa'amuta ma 402 a'o le'i amata so'o se mea. O lo'o fa'ailoa mai le mea sese po'o fea le totogi ua maua leitiiti, otsia le tele o le sats e mana'omia e le talosaga ma le tele o lo'o avanoa. O se mea itiiti hơn max_tokens e uiga i se nofoaga laitiiti hơn.
• Fa'aletonu. O se talosaga e le manuia e lē tau teutuhi, se'i vagā ua totogi le pulega mo le galuega na faia a'o le'i leiloa, pe se su'esu'ega i luga o le upega tafa'ilagi pe le nymbot/auto galuega fa'atonutonu ua uma ona fa'atino; o lena o le mea e totogi ai, aua least o le 0.05 credit. O se lipu (stream) ua e tapuni ina ia totogiina i token na lipoti mai e le pulega (provider): O lo'o fa'aauau pea e Nymbot ona faitau i le lipu a le pulega mo se taimi e oo atu i le 25 sekone amu pe a uma ona e al离开 ina ia maua lea numera. Afai e le maua, e fa'atatau le totogi mai mea na e lafoina ma mea na tusia, ma mo se filimeli (model) e mafai ona mafaufau e aofia ai le aofai o le fa'asilasilaga atoa o le fa'atali. O se talosaga ua tapuni ai lona fesootaiga e fa'aauau pea ona mae'a ma totogiina.
• Su'esu'e Web e tau $0.008 i le su'esu'ega tasi, ua suia i ni sats, i taimi lava e fa'atino ai se su'esu'ega, pe tali mai pe le tali mai le model. O suiga o lo'o faitauina fo'i e lafo atu i le model o ni fa'amaumauga fa'aopoopo, o le mea lea e fa'aopoopo ai a latou tokens.

O le tali uma lava e fa'amatala ai lona tau. O tali JSON e iai se nymbot fa'aliliuga ma le tupe sa totogia ai, le totogi i credits ma sats, ma le toe to'a:

Le mea e aumai ai le tau

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

O tali totogi e iai fo nei ulutala, o fea lea e tatalo ai mo le tau o se tali e lē o se JSON, e pei o le tautala:

O tau mo le miliona token, ua aofia ai le totogi ma le margin, o lo'o i ai i le lisi o modeleipi i tupe fa'apitoa ma sats, ma luga i luga le pepa o tauAfai e lē mafai ona faitau le tau o le Bitcoin, toe fo'i atu talosaga totogi 503 price_unavailable tau Retry-After: 60 talu ai nai le faʻaluga.

Iteitega

O mea sese uma e tutusa lona vaaiga, o le mea ua uma ona malamalama i ai tagata fa'aaoga a OpenAI. code o se suafa mautū e mafai ona e fa'afeso'ota'i ai; message e mo tagata ma e mafai ona suia.

Aiga o le mea sese

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

Lua fa'ata'ita'iga:

• /api/v1/messages fa'amatalaga i le tulaga o le mea sese a Anthropic, ona o lena lava e faitau ai tautala a Anthropic: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. O le ituaiga e mulimulitaʻi i le tulaga: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error poʻo overloaded_error (503).
• O se talosaga streaming e le manuia a o le'i oo atu lona byte muamua, e maua ai se error JSON masani ma le tulaga (status) o luga nei, ae le o se event stream. O se fa'aletonu pe a uma ona amata le streaming, e lafoina o le fa'ailoga mulimuli o le streaming, i le format patino o lena endpoint.

E lē fa'aopoopoina ni fa'amatalaga fa'apolofesa a se isi tautua i fa'aletonu (error messages). O se fa'aletonu a se lafoia (provider) e toe fa'amatala ina a'o le'i oo atu ia te oe.

Limitia

O se sootaga i se ata e tatau ona fa'asino i se nofoaga o lo'o avanoa i le lautele: o se tulaga i se feso'ota'iga patino po'o se feso'ota'iga fa'apito, po'o upega tafa'ilagi a Nymbot lava ia, e lē fa'atagaina. O le fa'asologa o le pacer o le au'oa'oina o mea o lo'o fa'atino i le polokalame, o lo'o fa'atino fo'i iinei, ina ia mafai ona fa'aitiitia le vave o fa'amemefea tele i se tasi au'oa'o nai lo le le toe fa'atinoina lava.

O le ā mea e mafai ona va'ai ai le API

E lē faalilolilo le API pei o a polokalame, ma e taua le faatatau saʻo i le auala o loo faia ai.

• E le o se faamaoniaina mai le tasi i le isi (end-to-end encrypted). I togalau app, o se feau ua sili ona puipuia i lau masini e na o ki o loo iai i Nymbot ma savali atu e pei o se paku meaalofaO se talosaga API e masani lava i le HTTPS: o lo'o fa'afefiloiina lona saogalemu i le malaga atu i le Nymbot, ma o le server a le Nymbot o lo'o faitauinaina i se tulaga manino ina ia mafai ona fa'atautaia.
• E le teuina manatu ma tali. E alu atu i le matafaga ma toe fo'i mai le tali. O le pili o le mea e teuina ai: mo talosaga ta'itasi, o le taimi, le matafaga, ituaiga, numera o token, tau, tupe o lo'o i ai, le ki, ma pe manuia lea, mo le 90 aso, lea o le mea... talosaga o tala fa'asolopito fa'aali atu ia te oe. O se pepa fa'amaumauga o le fa'aaogaina o le lava uma lava o le talosaga (laufono, ituaiga, modele, numera o token, tau, taimi na fa'amaonia, ma pe na fa'aaoga pe le fa'aaoga le su'esu'ega i luga o le upega tafa'ilagi po'o le manuia) e teuina foi mo le 90 aso, fa'atasi ma fa'amaumauga a le polokalame lava ia.
• O mea uma e totoe mo se nym e itiiti ma o lo'o lisiina iinei. Ki o le API e teuina o se hash, ae le o le ki, fa'atasi i ai le suafa, se fautuaga puupuu, le tulaga fa'atapula'a o tupe fa'aalu, le vaitau toe fa'aleleia, le vaitau fa'amutāmuta ma le taimi na faia ma le taimi na fa'aaogāina mulimuli ai; na'o isi 50 o ki ua aveese na pulea fa'atasi. An fa'auto top-up o le fesootaiga o le wallet o lo'o teuina fa'afetai i le fa'amamafa, fa'atasi ai ma lona tulaga tija, le tele, ma le i'uga o le fa'aopoopoina sili ona fiafia. O galuega fa'asalafia o lo'o tauoloaina mo le 24 itula. O talosaga totogi i le tasi e tu'uina atu ai se Lightning payment hash mo le 7 aso ma se hashed refund token mo le 30 aso, e le fa'atatau i se igoa. O totogi e le mafai ona totogi e se tupe i le tauoloa o le a teuina o se totogi e totogi mai.
• O le tapeina o le polokalame e tapeina ai. A fa'amoe masini fa'aleaogaina ma le tapeina o so'o se isi API key, ma tapeina o tala fa'asologa o fesili, tala fa'aogaina, fesootaiga o le wallet ma galuega o vitio. O le totogi ma so'o se totogi e to'toe fa'asaoina i luga o le nym.
• O lo'o va'ai le tu'uina atu o le modele i lau talosaga, pe afai e tusa ma le polokalame. Catalog fa'agaioiga e fa'at运行 i lona mata'itu'u; o ala standard ma embeddings e fa'at运行 i luga o Cloudflare.
• O mea media ua foofoina o mea lautele. O ata ma vitio e lafoina e pei o ni sootaga o lo'o tu'uina atu i luga o Blossom file hosts lautele, lea o le uiga o le ala e maua ai se failauga o lona hash. O so'o se tasi e iai le sootaga e mafai ona tatala, ma e lē mafai e Nymbot ona toe aveeseina. Fai atu mo b64_json ma se ata na faitauina e tulaga fa'akomepiu e toe fo'i mai i le tali ma e lē fa'asoloina lava.
• O ata o lo'o e tu'uina mai, o se mea lea o loo faia e se masini faia ata? O se ata e te tu'uina atu i Faatonutonu, pe lafo atu e pei o se data: URL i se a le mea faia image_url, ua tu'uina atu i se Blossom host o lo'o tatala i tagata uma muamua ina mafai e maua ai e le masini fa'atupu, ma e tutusa lava le tulaga mo lena mea. O se ata na lafoina e https:// e tuuina atu le sootaga e pei o lena sootaga. O ata i se talosaga o se talanoaga e alu atu i le pulega o le faataitai, ae le i Blossom.
• O se ki e feso'ota'i ma lau nym. O mea uma e fa'aalu e se ki e aveese mai lau nym balance, o lea o le fa'aaogāina o le API e lē ta'uoleoleaAfai e te mana'o e fa'aaoga le API fa'apitoa mai lau igoa masani, faia ni ki mai se isi igoa ese ma lona tau (balance) patino.

Afai e te mana'omia le puipuiga o polokalame, fa'aaoga polokalame. O le API e mo taimi e te mana'omia ai modele i au meafaigaluega lava ia.

O tulaga fa'ai'uga uma

“Nym” o lona uiga o se talosaga ua sainia e lau ki o le Nostr, o lo'o fa'amatalaina i le faamautu polokalame o talosaga mo teugatupe. Mo meafaigaluega ua uma ona tautala i nei ituaiga, vaai i meafaigaluega ma SDKs, ma mo agena fa'akomupi e pei o Claude Code, Codex ma Cline, va'ai i meafaigaluega mo le coding.