Sciobazo / Programistoj

Superrigardo de API

La modeloj, generiloj kaj saldo, kiujn vi uzas en la aplikaĵo, el via propra kodo. La API parolas la OpenAI kaj Anthropic formatojn, do la plej multaj iloj kaj SDK-oj funkcias per ŝanĝo de baza URL kaj ŝlosilo.

Ĉi tiu paĝo estas maŝintradukita por komforto. La angla originalo estas la versio kiu validas.

Kio la API estas

HTTP API sur nymbot.ai tio respondas al la samaj petoj, kiujn OpenAI aŭ Anthropic kliento jam sendas. Vi ricevas:

• Ĉat-kompletigoj, la API de Respondoj kaj Anthropic-mesaĝoj, kun fluigo, iloj, bildoj, argumentado kaj reta serĉado, por ĉiu modelo en la katalogo kaj por Nymbot-sia propra aŭtomata rutingado.
• Bildoj, videfilmo, parolo, transkribo kaj envestigoj.
• Via ekvilibro, Fulm-ŝargoj, aŭtomataj plenigas de via portmoneo kaj unu historio de kio ĉiu peto kostas.

Ĝi estas pagita el la samaj du ekvilibroj kiel la aplikaĵo, la samaj prezoj. Ne estas abonado kaj nek senpaga kvoto pri la API: ĉiu peto estas pagita per kreditoj, kiujn vi aĉetis.

Kio la API ne faras, estas aldoni ion ajn de Nymbot mema. Viaj mesaĝoj iras al la modelo tiel kiel vi sendis ilin: neniuj Nymbot-sistemaj instrukcioj, neniu memoro, neniuj dato- aŭ lingvaj indikoj. Kio revenas estas la respondo de la modelo kaj noto pri tio, kio ĝi kostis.

Bazaj URL-oj

Ĉiu punkto finas loĝas sub /api/v1/. Neanstataŭa vojo revenas 404 kaj konata vojo vokita per la malĝusta metodo reternas 405, ambaŭ kiel JSON.

La API respondas al trans-originaĵaj petoj de iu ajn retejo, do retumila paĝo povas voki ĝin. Tamen, ĉio, kion vi sendas al retumilo, povas esti legata de kiu ajn malfermas ĝin, do faru tion nur per ŝlosilo, kiu havas malgrandan ĉapetoLa terminalpunktoj subskribitaj per via nym (ŝlosiloj, la kontosumo, NWC aŭtomata plenigo kaj mono-restituita redemcio) estas la escepto: en retumilo ili respondas nur al la propraj retejoj de Nymbot. Vidu subskribante kontajn petojn.

Sendu ĉiun JSON-korpon kun Content-Type: application/json. Alia ajn tipo estas rifuzita kun 415, do simpla HTML-formularo aŭ text/plain peto de alia retejo ne povas atingi la API-on. Per cURL, transdoni -H "Content-Type: application/json" kune kun -d.

API-ŝlosiloj

Ŝlosiloj estas faritaj en la aplikaĵo. Malfermu API en la flankolaborbaro de la retega aplikaĵo, aŭ en la menuo en Android kaj iOS, kaj tuŝu Krei ŝlosilon. Donu al ĝi nomon kaj, se vi ŝatus, ĉapelon kaj expirajn daton.

La ŝlosilo estas montrita nur unufoje. Kopiu ĝin ien sekuran antaŭ ol vi fermas la foliojn: Nymbot konservas nur spurfingron de ĝi, do ĝi ne povas montri ĝin al vi denove. Perdita ŝlosilo ne povas esti revitita; revoku ĝin kaj faru alian.

Ŝlosilo aspektas kiel sk-nymbot- sekvata de 43 literoj, ciferoj, tiretujoj kaj subĉapeloj. La aplikaĵo listigas ĉiun ŝlosilon laŭ ĝia nomo kaj mallonga sugesto kiel ekzemple sk-nymbot-Qm7x…c2Lw.

• Ŝlosilo apartenas al via nomo. Ĝi eluzas vian saldon, kaj nur via nym povas krei, ŝanĝi aŭ revoki ĝin. Ĉiu, kiu posedas la ŝlosilon, povas eluzante ĝin elspezi, do traktu ĝin kiel pasvorton.
• La ĉapeloj estas en la satelitoj. Ŝlosilo povas havi elspezlimon, kaj la limo povas reiziĝi ĉiumanĝon, ĉiumanĝon (lundo) aŭ ĉiumonatan (la unua), je 00:00 UTC. Ĝi kalkulas ambaŭ saldujn, norman krediton kiel 10 sats kaj Pro-krediton kiel 100, do ĝi signifas la saman sendepende de kiu salduo peto elspezas. Antaŭ ol peto okazas, la plej alta ebla kosto (rondigita supren al plenaj kreditoj) estas kontralatita kontraŭ tio, kio restas el la limo. Se ĝi nejeĝas, la peto estas rifuzita kun 403 key_limit_reached, eĉ se la respond' venus sub la plafon; la eraro diras kiom restas kaj kiam la plafon reiziĝas. Malpliigado max_tokens malaltigas tiun plej malbonan kazon. Peto estas pagita laŭ tio, kion ĝi reŝte kostis kaj tio kalkuliĝas kontraŭ la limo, do se la provizanto raportas pli da tokenoj ol estiĝis rezervis, la lasta peto, kiu eltenis, povas preni la ŝlosilon iom preter ĝia limo; la sekva estas tiam rifuzita.
• Elĉerpita ĉapelo nur haltigas elspezojn. Clavo ĉe sia limigo ankoraŭ povas kontroli la saldon, legi ĝian historion, listigi modelojn, kalkuli tokenojn, reŝarĝi kaj kontroli videon, kiun ĝi jam komencis.
• Eksvalidigo estas opcia. Post la dato, kiun vi agordis, la ŝlosilo ĉesas funkcii.
• Revokado estas tuja kaj definitiva. Revokita ŝlosilo malsukcesas pri sia sekva peto. Ĝi restas en la listo, markita kiel revokita, por ke ĝia elspezita historio ankoraŭ havu sencon.
• Vi povas havi ĝis 25 aktivajn ŝlosilojn, ĉiu kun sia propra nomo. ŝanĝi la reŝipton de ŝlosilo komencas novan periodon de nulo.

La sama folio montras la elspezojn de ĉiu ŝlosilo ĉi tiun periodon kaj totale, kiam ĝi estis lastfoje uzata, ambaŭ de viaj saldoj, kaj viajn lastajn API-petojn. La terminalpunktoj malantaŭ ĝi estas dokumentitaj sub administrado de ŝlosiloj.

Autentikigi peton

Sendu la ŝlosilon en iu ajn el tiuj ĉefoj. Ili estas ekvivalentaj, do uzu tion, kion via kliento sendas per la defaŭlto:

Malkovrita, nekonata, revokita aŭ expirinta ŝlosilo redonas 401, kun la kodo missing_api_key, invalid_api_key, revoked_api_key aŭ expired_api_key. Listigi modelojn, aŭdajn modelojn kaj voĉojn, kaj pagmetodojn ne bezonas ŝlosilon.

Bildoj, video, parololo, transkribo kaj enbedoj povas ankaŭ esti pagitaj unufoje po unu peto per Lightning sen iu ajn ŝlosilo: sendu la peton sen unu kaj pagu la fakturon en la 402 respondu. Vidu pagi per peto sen ŝlosilo.

Gvidado de ŝlosiloj, la kontosunprunto kaj aŭtomataj reaprovizoj estas la esceptoj: ili postulas subskribon de via nym anstataŭ ŝlosilon, do fuŝita ŝlosilo ne povas krei pliajn ŝlosilojn. Vidu subskribante kontajn petojn.

Via unua peto

Metu la ŝlosilon en medio-variablon, poste demandu ion al modelo. La ekzemploj tra ĉi tiuj paĝoj legas ĝin el 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 estas Nymbot-sia propra rutingado, pagita el la norma saldo. Metu katalogan model-identigilon tie anstataŭe, kiel ekzemple anthropic/claude-sonnet-5, por uzi tiun modelon el la Pro-saldo. Listigo de modeloj donas ĉiun ID.

Kiom kostas peto

La API fakturas tute same kiel la aplikaĵo.

• Kiun ekvilibron. nymbot/auto pasigas la standarda saldo (10 sats po kredito). Ĉiu alia babilada modelo elspezas la Pro saldo (100 sats ĉe kredito). La norma bildgenerilo kaj la norma voĉo uzas normajn kreditojn; ĉiu alia generilo uzas Pro. Embeddingoj uzas normajn kreditojn. Transkribado uzas normajn kreditojn kiam la norma saldo povas pokovri ĝin, kaj Pro-kreditojn aliflanke. La listo de modeloj diras, kiun saldon ĉiu modelo uzas.
• Kiom multe. Retĉat-peto estas mezurata laŭ la jetonoj, kiujn la modelo efektive legis kaj skribis, laŭ la publikigitaj tarifoj de la provizanto. Tiu prezeto havas 5% ĉerimon aldonitan kaj estas poste multiplikita per 1.5, do vi pagas 1.575 fojon la listprezon de la provizanto. Ĝi estas konvertita al sats laŭ la aktuala Bitcoin-prezo kaj elŝarjita en milonaj partoj de kredito. Profesiaj bildoj, video kaj parolado estas prezigitaj laŭ generado, laŭ sekundo aŭ laŭ ĉaraktero, kaj transskribado laŭ sekundo de aŭdio, kun la sama ĉerimo kaj marĝo. La norma bildo estas fixa 5 normaj kreditoj kaj la norma voĉo fixa 3.
• La minimumo. Ĉiu mezurata peto, kiu funkcias, kostas almenaŭ 0.05 krediton: duonon de sat en la norma saldo, 5 satojn en Pro. Fraktioj de kredito estas transprenataj, ne rande supra ĉiumerke.
• Atendu, tiam trankviliĝu. Antaŭ ol peto ruliĝas, la plej alta ebla kosto estas rezervata el via saldo, bazita sur tio, kion vi sendis kaj la plej multaj tokenoj, kiujn ĝi eble skribos. Teksto ekster la pura ASCII estas mezurata laŭ siaj UTF-8 bajtoj, kaj ASCII-ciferoj kaj signaturoj okazas kiel unu ĉiu tokeno, do teksto en ajna skribo, kodo kaj nombroj estas rezervataj en plene. La rezervo estas en plenaj kreditoj, almenaŭ unu, do iu ajn peto bezonas almenaŭ 10 sats liberajn en la norma saldo aŭ 100 sats en Pro por komenci. Nur la reala kosto estas elŝarjita; la restanto estas liberigita kiam ĝi finiĝas. Longa peto konservas sian rezervon dum la tempo, kiom longe ĝi ruliĝas; se la rezervitaj kreditoj ĉesas esti disponeblaj ĉiuokaze, fluo ĉesas kun a 402 insufficient_balance erara evento, kaj tio kio estis generita estas pagita. Se la reala kosto estas pli ol la saldo povas pagi, la tuta saldo estas prenta, la restanto estas debita (owed_sats en la nymbot objekto, kaj negativa saldo). Kio estas debita estas pagata unue el la sekvaj kreditoj, kiuj atingas tiun saldon. Ĝis ĝi estas pagita, nenio sur tiu saldo povas esti elspezita: nek per la API, nek per respondoj en la aplikaĵo, nek per transiro aŭ donaco.
• Ne sufiĉe da kredito. Se la saldo ne povas kovri la rezervon, la peto estas malakceptita kun 402 antaŭ ol io ajn funkcias. La eraro diras, kiu saldo estas malplena, kiom da satoj la peto bezonas kaj kiom estas liberaj. Pli malgranda max_tokens signifas pli malgrandan tenon.
• Malfuloj. Peto kiu malsukcesas kostas nenion, krom se la provizanto fakturis por la laboro kiun ĝi faris antaŭ malsukceso, aŭ retserĉon aŭ la nymbot/auto task kontrolo jam okazis; tiam tio estas tio, kion vi pagas, almenaŭ 0.05 kredito. Stream kiun vi ĉesigis estas pagita laŭ la tokenoj, kiujn la provizanto raportas: Nymbot daŭre legas la streamon de la izprovizanto dum ĝis 25 sekundoj post kiam vi forlasas por ricevi tiun supranĝon. Se ĝi ne alvenas, la pagado estas estimata el tio, kion vi sendis kaj kio estis skribita, kaj por modelo kiu pripensas ĝi inkluzivas la tutan elbaton de la eligo de la reteno. Peto kies konekto falas ankoraŭ finiĝas kaj estas pagita.
• Retserĉo kostas $0.008 per serĉo, konvertite al sats, ĉiam kiam serĉo okazis, ĉu la modelo tiam respondas aŭ malsukcesas. La paĝoj kiujn ĝi legas estas ankaŭ senditaj al la modelo kiel enigo, do ili aldonas siajn tokenojn.

Ĉiu respondo diras, kion ĝi kostis. JSON-respondoj enhavas nymbot objekto kun la saldo el kiu ĝi estis pagita, la ĉargo en kreditoj kaj satoj, kaj kio restas:

La kosto-objekto

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

Pagitaj respondoj ankaŭ enhavas ĉi tiujn headerojn, kie oni devas serĉi la koston de respondo kiu ne estas JSON, kiel ekzemple parolo:

Tarifoj por miliono da tokenoj, jam inkludante la koston kaj marginon, estas en la modeloj listo en dolaroj kaj satoj, kaj plu la prezlisto. Se la Bitcoin-prezo ne povas esti legata, pagitaj petoj redonas 503 price_unavailable kun Retry-After: 60 anstataŭ radu.

Eraroj

Ĉiu eraro havas la saman formon, tiun kiun OpenAI-klientoj jam komprenas. code estas stabila nomo, kiun vi povas kongruigi; message estas por homoj kaj povas ŝanĝiĝi.

Erara korpo

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

Du esceptoj:

• /api/v1/messages respondoj en la erara formato de Anthropic, ĉar tio estas tio, kion Anthropic-klientoj analizas: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}La tipo sekvas la statuson: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error aŭ overloaded_error (503).
• Flua peto, kiu malsukcesas antaŭ sia unua bajto, ricevas ordinaran JSON-eraron kun la supre menciita stato, ne eventan fluon. Malsukceso post kiam la fluo komenciĝis estas sendata kiel la lasta evento de la fluo, en la propra formato de tiu terminalpunkto.

Erarmesaĝoj neniam enhavas la internajn detalojn de alia servo. Provizanto's propra eraro estas reformulata antaŭ ol ĝi atingas vin.

Limitoj

Ligilo al bildo devas indiki al publika gastiganto: adreso en privata aŭ loka reto, aŭ sur la propraj retejoj de Nymbot, estas rifuzata. Provizanto-ritmigo, kiu aplikas en la aplikaĵo, ankaŭ aplikas ĉi tie, do kulmo de petoj al unu provizanto povas esti malrapdigita anstataŭ malsukcesi.

Kion la API povas vidi

La API ne estas privata same kiel la aplikaĵoj, kaj estas oportune esti preciza pri kiel.

• Ĝi ne estas fine-al-fina ĉifrita. En la aplikoj, mesaĝo estas sigelita sur via aparato per ŝlosiloj, kiujn nur Nymbot tenas kaj vojaĝas kiel papereca ĉemizo por donaco. API-peto estas ordinara HTTPS: ĝi estas ŝifrita laŭdire al Nymbot, kaj la servilo de Nymbot legas ĝin en la klara por trakti ĝin.
• Promptoj kaj respondoj ne estas konservataj. Ili trapasas tra la modelo kaj la respondon reiras. Kio restas estas la fakturo: por ĉiu peto la tempo, modelo, speco, token-kvantoj, kosto, saldo, ŝlosilo kaj ĉu ĝi sukcesis, dum 90 tagoj, kio estas demando-historio montras al vi. Uzo-registro de la sama peto (tempo, speco, modelo, nombro de tokenoj, kosto, daŭro kaj ĉu ĝi uzis retserĉon aŭ sukcesis) estas ankaŭ konservita dum 90 tagoj, kune kun la propra de la aplikaĵo.
• Ĉio alia tenita por nym estas malgranda kaj listigita ĉi tie. API-ŝlosiloj estas konservitaj kiel haŝo, neniam la ŝlosilo, kun loro nomo, mallonga indiko, elspezlimigo, reŝarga periodo, eksvalidigo kaj kiam ili estis kreitaj kaj lastfoje uzataj; nur la plej novaj 50 revokitaj ŝlosiloj estas konservataj. An aŭtomata reŝargado portofolio konekto estas konservita ŝifrite, kun sia limvalor, kvanto kaj la rezulto de la lasta reaprovizo. Videaj taskoj estas konservataj dum 24 horoj. Petoj pagitaj laŭ ĉiu vokado lasas nur Lightning-pagon-hasĥon dum 7 tagoj kaj haŝitan anstataŭigilon dum 30 tagoj, ne ligita al iu ajn nomo. Ŝarĝoj, kiujn saldo ne povus kovri, estas konservataj kiel malkonstruitaj ĝis reaprovizo pagas ilin.
• Viŝado de la aplikaĵo fordeligas ĝin. A viŝado de aparato revokas kaj foras ĉiun API-ŝlosilon, kaj foras la demando-historion, uzajn registrojn, portofolan konekton kaj videajn taskojn. La saldo kaj ajn kostoj ankoraŭ devataj restas ĉe la nym.
• La provizanto de la modelo vidas vian peton, kiel ĝi faras el la aplikaĵo. Katalogaj modeloj funkcias ĉe siaj kreantoj; normaj rutejoj kaj enmetoj funkcias sur Cloudflare.
• Generita amaskomunikilo estas publika. Bildoj kaj filmetoj liveritaj kiel ligoj estas ŝargate al publikaj Blossom-dosierospacenoj, kie la adreso de dosiero estas ĝia haŝo. Ĉiu kun la ligilo povas malfermi ĝin, kaj Nymbot ne povas denove forigi ĝin. Petu por b64_json kaj generita bildo revenas en la respondo kaj neniam estas alŝutita.
• Do, ĉu la bildoj kiujn vi donas estas generilo? Bildo kiun vi ŝarĝas al redakti, aŭ sendu kiel data: URL en generatanto's image_url, estas elŝutita al publika Blossom-gastiganto unue por ke la generilo povu eltiri ĝin, kaj la sama aplikas al ĝi. Bildo sendita de https:// ligilo estas transdonata kiel tiu ligilo. Bildoj en babilĉat-peto iras al la provizanto de la modelo, ne al Blossom.
• Ŝlosilo estas ligita al via nimo. Ĉio, kion ŝlosilo elspezas, estas subtraŭtita de la saldo de via nym, do API-uzo ne estas anonimaSe vi volas uzi API-on kept apart de via ĉiutaga nym, faru la ŝlosilojn el separa nym kun sia propra saldo.

Se vi bezonas la protekton de la aplikaĵoj, uzu la aplikaĵojn. La API estas por kiam vi bezonas la modelojn en viaj propraj iloj.

Ĉiu fino

“Nym” signifas peton subskribitan per via Nostr-ŝloso, priskribitan en subskribante kontajn petojn. Por iloj, kiuj jam parolas tiujn formatojn, vidu iloj kaj SDK-oj, kaj por kodaj agentoj kiel Claude Code, Codex kaj Cline, vidu programistaj iloj.