Bilim binýady / Programmistler

API syny

Programmada ulanýan modelleriňiz, generatorlaryňyz we balansyňyz öz kodyňyzdan. API OpenAI we Anthropic formatlarynda gürleşýär, şonuň üçin köp gurallar we SDK-lar esasy URL we açary üýtgetmek arkaly işleýär.

Bu sahypa amatlylyk üçin maşyn terjime edilýär. Iňlis asyl nusgasy ulanylýan wersiýa.

API näme?

HTTP API on nymbot.ai OpenAI ýa-da Anthropic müşderisi eýýäm iberýän şol bir soraglara jogap berýän. Siz şulary alýarsyňyz:

• Chat Completions, Jogaplar API we Anthropic Habarlary, akymly hyzmatlar, gurallar, suratlar, logiki pikir ýetirmek we web gözleg bilen, ähli modeller üçin katalaog we Nymbot-yň öz awto-rutingi üçin.
• Suratlar, wideo, syn”, transkripsiýa we embeddings.
• Siziňki balans, Lightning-de balans doldurmaklar, waletiňizden awtomatiki doldurmalar we bir taryh her bir soragyň nähili gymmatlanýandygy

Ol şol bir iki sanydan tölenýär. balanslar programma ýaly, şol baha bilen. API-da abuna bolmak we mugt limit ýok: her bir sorat siziň satyn alan kreditleriňizden tölenilýär.

API Nymbot-yň özünden hiç zat goşmaýar. Siziň habarlaryňyz modele nähili ugradylan bolsa, şol görnüşde gidýär: hiç hili Nymbot ulgam prompt-y, ýat, senä ýa-da dil barada görkezme ýok. Yzyna gelen bolsa modeliň jogaby we onuň bahasy baradaky bellikdir.

Esasy URL-ler

Her bir uçtog (endpoint) şu aşakdakynyň astynda ýerleşýär /api/v1/. Nätanyş ýol yzyna dolanýar 404 we ýalňyş usul bilen çagyrylan bilinen ýol gaýtarýar 405, ikisindäki hem JSON görnüşinde.

API is eýýäm ähli saýtlardan gelen cross-origin soraglaryna jogap berýär, şonuň üçin brauzer sahypasy ony çagyryp biler. Emma, brauzere ugradýan islendik zadyňyzy ony açan islendik adam okap biler, şonuň üçin muny diňe çäkli ygtyýarlygy bolan açar bilen ediň papagy. Siziň nym-yňyz bilen imzalanylan uç noktalar (açarlar, hasabyň jemlemesi, NWC awtomatiki doldurylmagy we gaýtarylan serişdeleriň alynyşy) istisnadyr: brauzerde olar diňe Nymbot-yň öz saýtlaryna jogap berýärler. Seret hasap soraglaryna gol çekmek.

Her bir JSON bedenini şu bilen iberiň Content-Type: application/json. Islendik başga görnüşi rad edilýär 415, şol sebäpli ýönekeý HTML formasy ýa-da a text/plain başga bir saýtdan gelen haýyş API-ä ýetip bilmeýär. cURL bilen, geçiriň -H "Content-Type: application/json" bilelikde bilen -d.

API açarlary

Açarlar programmada döredilýär. Aç API web programmada çep tarapdaky paneldäki ýa-da Android we iOS-daky menýudaky düwmäni basyň we Açar döretOňa at beriň we, isleseňiz, çäk hem-de möhlet senesini goýuň.

Açary bir gezek görkezilýär. Sahypany ýapmazdan ozal ony ygtybarly bir ýere nusgalap alyň: Nymbot diňe onuň barmak yzy (fingerprint) görnüşindäki nusgasyny saklaýar, şonuň üçin ony size gaýtadan görkezip bilmeýär. Ýitirilen açary yzyna gaýtaryp bolmaýar; ony ýatyryň we täzesini dörediň.

Açar şuna meňzeýär sk-nymbot- 43 harp, san, tire we aşyrgy bilen dowam edýär. Programma her açary öz ady we şuna meňzeş gysgaça yşarat bilen sanap görkezýär: sk-nymbot-Qm7x…c2Lw.

• Açar seniň nymyňa degişli. Ol siziň balansyňyzy sarp edýär we diňe siziň nym-yňyz ony döredip, üýtgedip ýa-da ýatyryp bilýär. Açary elinde saklaýan islendik adam ony ulanyp sarp edip bilýär, şonuň üçin oňa paroluňyz ýaly garaýyň.
• Kapslar sats-da. Açar çäklenen çykdajy limitine eýe bolup biler we bu limit her gün, her hepde (Duşenbe) ýa-da her aý (birinji günü) sagat 00:00 UTC wagtda täzelenip bilýär. Ol oba balanslary hasaba alýar: standart kredit 10 sat, Pro kredit bolsa 100 sat hasaplanýar, diýmek, haýsy balans ulanylyp çykdajy edilse-de, netije birmeňzeş bolar. Sorag ýerine ýetirilmezden ozal, onuň iň köp bolup biljek bahasy (bitin kreditlere çenli ýokarylandyrylyp) çägiň galan böleginden aýrylýar. Eger bu çäk ýetmese, sorag şu aşakdakylar bilen ret edilýär 403 key_limit_reached, hatda jogap çäkden aşman hem gelende; ýalňyşlyk näçesi galandygyny we çägiň haçan täzelenjekdigini aýdýar. Peseltmek max_tokens bu iň erbet ýagdaýy peseldýär. Söýeg (request) hakyky bahasyna görä tölenýär we ol çäk (cap) bilen hasaplanýar, şonuň üçin, eger üpjünçi ayrylan sözlerden köp token hasabat etse, çäge sygyan iň soňky söýeg açary çägiň azajyk ötesine geçip biler; ondan soňky söýeg bolsa ret edilýär.
• Sarp edilen bökgi diňe sarp etmegi saklaýar. Gündelik ulanyşda açaryň çägi içinde salgyny barlap, taryhyny okap, modelleri sanap, tokenleri hasaplap, balans dolduryp we eýýäm başlatylan wideony gözden geçirip bolar.
• Gözden geçirmek opsionaldyr. Siziň belleyen seneden soň, açar işläp durmaz.
• Yza alyş derrew we hemişelik amala aşyrylýar. Ýatyrylan açar indiki soragda ýalňyşlyk berýär. Ol sanawda, ýatyrylan hökmünde bellik bilen galýar, şol sebäpli onuň çykarmasy taryhy henizem logiki bolup galýar.
• Siziň 25 sany işjeň açaryňyz bolup biler we her biriniň öz ady bolar. Açaryň resetleniş döwrüni üýtgetmek, täze döwri nolden başlatýar.

Şol bir sahypada her bir açaryň şu döwürdäki we umumy çykdajylary, iň soňky haçan ulanylandygy, iki sany balansyňyz we soňky API soraglaryňyz görkezilýär. Onuň arkasyndaky uç noktalar aşakdaky ýerlerde resmileşdirilendir: açarlary dolandyrmak.

Soragy tassyklamak

Açar deşmesini bu sargyllaryň islendik birinde iberiň. Olar deňdir, şonuň üçin müşderiňiziziň standart görnüşde iberýänini ulanyň:

Ýitirilen, bilinmeýän, ogurlanan ýa-da möhleti geçen açar dolanýyk berýär 401, kod bilen missing_api_key, invalid_api_key, revoked_api_key ýa-da expired_api_key. Modelleri, audio modelleri we sesleri hem-de töleg usullaryny sanamak açary talap etmeýär.

Suratlar, wideo, ses, transkripsiýa we embeddingler üçin hem Lightning arkaly hiç hili açar ulanmazdan, her gezek bir sorag üçin töleg edilip bilner: soragy açarsyz iberiň we hasaby... 402 jogap. Gör açary bolmazdan her sorag üçin tölemek.

Açar suratlaryny dolandyrmak, hasabyň jemlemesi we awtomatiki doldurmalar istisna bolup durýar: olar açar deregine siziň nym-iňizden gol çekilmegini talap edýär, şonuň üçin sızan açar täze açarlary döredip bilmeýär. Serediň hasap soraglaryna gol çekmek.

Siziň birinji haýyşyňyz

Açar sözi gurşaw üýtgeýjisine goýuň, soňra modelden bir zat soraň. Bu sahypalaryň dowamyndaky mysallar ony şundan okaýar NYMBOT_API_KEY.

cURL

export NYMBOT_API_KEY="sk-nymbot-..."

curl https://nymbot.ai/api/v1/chat/completions \
  -H "Authorization: Bearer $NYMBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "nymbot/auto",
    "messages": [{"role": "user", "content": "What is a Lightning invoice?"}]
  }'

Python

import os
from openai import OpenAI

client = OpenAI(
    base_url="https://nymbot.ai/api/v1",
    api_key=os.environ["NYMBOT_API_KEY"],
)

reply = client.chat.completions.create(
    model="nymbot/auto",
    messages=[{"role": "user", "content": "What is a Lightning invoice?"}],
)
print(reply.choices[0].message.content)

JavaScript

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://nymbot.ai/api/v1",
  apiKey: process.env.NYMBOT_API_KEY,
});

const reply = await client.chat.completions.create({
  model: "nymbot/auto",
  messages: [{ role: "user", content: "What is a Lightning invoice?" }],
});
console.log(reply.choices[0].message.content);

nymbot/auto ...Nymbot-yň öz eltidiş ulgamy bolup, ol standart balansdan tölenýär. Onuň deregine, mysal üçin... ýaly katalog modeliniň ID-sini goýuň. anthropic/claude-sonnet-5, şol modeli ulanmak üçin Pro balansyndan. Modelleri sanawda her bir ID-ni berýär.

Soragyň bahasy näçä düşýär

API takyk edil programma ýaly hasaplaýar.

• Haýsy balans. nymbot/auto sarp edýär standart balans (10 sats kredit). Her beýleki chat modeli sarp edýär Professional balans (100 sats kredit). Standart surat dörediji we standart ses standat kreditleri sarp edýär; beýleki ähli döredijiler Pro sarp edýär. Embeddings standart kreditleri sarp edýär. Transkripsiýa, eger standart balans ony ödeýip bilýän bolsa standart kreditleri, ýogsa Pro kreditleri sarp edýär. Modeller sanawy her modeliniň haýsy balansı sarp edýändigini görkezýär.
• Näçe? Söhbetdeşlik soragy model tarapyndan hakykatdan okalan we ýazylan tokenler esasynda, hyzmatdaşyň çap edilen tarifleri boýunça hasaplanýar. Şol bahanyň üstüne 5% komissiýa goşulýar we soňra 1.5-e köpeldilýär, şonuň üçin siz hyzmatdaşyň sanaw bahasyndan 1.575 esse köp töleýärsiňiz. Ol häzirki Bitcoin bahasy boýunça sats-a öwrülýär we kreditiniň müňden bir bölegi görnüşinde tölenilýär. Professional suratlar, wideo we ses her bir generasiýa, her sekunt ýa-da her belgi boýunça bahalanýar, tekst dökümleri bolsa audio sekundy üçin şol bir komissiýa we margina bilen bahalanýar. Standart surat 5 standart kredit, standart ses bolsa 3 standart kredit möçberinde baha goýulýar.
• Minimal. Her ölçen sorat azyndan 0.05 kredit harçlaýar: standart balansda ýarym sat, Pro-da bolsa 5 sat. Kredit bölekleri geçýär, her gezek ýokary bellemek bilen sanalanmaýar.
• Saklaň, soňra ýerleşiň. Sorag işläp başlamazdan ozal, ugradan maglumatlaryňyza we ýazyp biljek iň köp token sanyna esaslanyp, balansiňyzdan iň ýokary baha bellenilýär. Ýönekeý ASCII-den daşary tekstler UTF-8 baýtlar boýunça ölçelýär we ASCII sanlary hem, alamatlary hem her biri bir token hasaplanýar, şonuň üçin islendik ýazuwda, kodda we sanlarda tekst doly bellenilýär. Bellenilen baha bitewi kreditler görnüşinde we azyndan bir bellenilýär, şonuň üçin islendik soragyň başlamagy üçin standart balansda azyndan 10 sats ýa-da Pro balansda 100 sats bolmaly. Diňe hakyky baha tölenilýär; galan bakiýasy bolsa iş tamamlananda yzyna gaýtarylýar. Uzak dowam edýän sorag öz bellenilen baha göterimini işleýän wagtynda saklaýar; eger bellenilen kreditler elýeterli bolmasa, akym bir sany bilen bes edilýär 402 insufficient_balance ýalňyşlyk wakasy, we döredilen zat üçin töleg alnady. Eger hakyky töleg balansyň töleýän möçberinden köp bolsa, bütin balans alynýar, galan bölegi bolsa bergi bolup galýar (owed_sats içinde nymbot obyekt we otrisatel balans). Borç, şol balansa geljek indiki kreditlerden ilki bilen tölenilýär. Tölenýänçä, şol balansdaky hiç zat ulanylyp bilinmeýär: ne API tarapyndan, ne programmada gelen jogaplar, ne geçirme, ne-de sowgat arkaly.
• Krediti ýeterlik däl. Eger balans saklanan möçümi ýetirip bilmese, sorag şular bilen ret edilýär 402 hiç zat işläp başlamazdan öň. Ýalňyşlyk haýsy balansyň ýetmezçilik çekýändigini, soragyň näçe sat talap edýändigini we näçesiniň boşdigini aýdýar. Has kiçi max_tokens hasratyň has kiçi diýmekdir.
• Başjaryksyzlyklar. Ýalňyş bolýan sorag hiç zat möçberinde harçlamaz, eger hyzmatdaş ýalňyşmazdan öň ýerine ýetiren işi üçin töleg talap etmese ýa-da web gözleg ýa-da... nymbot/auto Görev barlagy eýýäm ýerine ýetirilen bolsa; onda siz azynda 0,05 kredit töleýärsiňiz. Siziň kesip eden akymyňyz üpjünçiniň hasaplaýan tokenleri üçin tölenilýär: Nymbot sanawy almak üçin siz çykyp gideniňizden soň hem üpjünçiniň akymyny 25 sekunda çenli okap durýar. Eger hasap gelmese, töleg siziň ugradan we ýazylan maglumatlaryňyza esasynda baha berilýär we düşünje alyp işleýän model üçin bu saklanan çykyş limitiniň tutuş bahasyny öz içine alýar. Baglanyşygy üzülen sorat hem tamamlanýar we töleg hasaplanýar.
• Web gözleg her bir gözleg işledende, model jogap berse-de ýa-da ýalňyş bolsa-da, gözleg $0.008 töweleli durýar, bu bolsa sats-a öwrülýär. Ol okap okaýan sahypalary hem giriş hökmünde modele ugradylýar, şonuň üçin olar hem öz tokenlerini goşýarlar.

Her jogap näçä durýandygyny aýdýar. JSON jogaplaryda ... bar nymbot Töleg tölenen balans, kreditler we satlar görnüşindäki töleg we galan mukdar bilen obýekt:

Çykdajy obýekti

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

Tölegli jogaplar hem şu sözbaşylary özünde saklaýar, deňdir we ses ýaly JSON bolmadyk jogabyň bahasyny gözlemeli ýer şüdür:

Million token üçin tarifler, töleg we marja eýýäm goşulan görnüşde, ...-da/de. modeller sanawy dollarlarda we satslarda, we üstünde bahalar sanawy. Eger Bitcoin bahasy okalmasa, tölenen soraglar gaýtarylyp berilýär 503 price_unavailable bilelikde Retry-After: 60 çaklamakdan däl-de.

Ýalňyşlyklar

Her bir ýalňyşlyk birmeňzeş görnüşe eýe, ýagny OpenAI müşderileriniň eýýäm düşünýän görnüşine. code esen; sen utgaşdyryp biljek durnukly atdyr; message adamlar üçindir we üýtgäp biler.

Ýalňyşlyk gövdesi

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

Iki istisna:

• /api/v1/messages Anthropic klientleri ony analiz edip bilýändigi sebäpli, Anthropic-yň ýalňyş formatyndaky jogaplar: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. Tipi statusy yzarlaýar: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error ýa-da overloaded_error (503).
• Ilkinji baýty gelmezden öň ýalňyşlyk berýän akymly sorag, dabyş akymy däl-de, ýokardaky status bilen adaty JSON ýalňyşlygyny alýar. Akym başlanandan soňky ýalňyşlyk bolsa, şol uçpuna mahsus formatda, akymyň iň soňky dabyşy hökmünde iberilýär.

Ýalňyşlyk habarlary hiç wagt başga hyzmatyň içki maglumatlaryny özünde saklamaz. Provaderiň öz ýalňyşlygy size ýetmezden ozal täzeden işlenip düzülýär.

Çäkler

Surata bolan çakylyk jemgyýetçilikli hosta gönükdirilmelidir: ýapyk ýa-da lokal ulgamdaky ýa-da Nymbot-yň öz saýtlaryndaky salgylary kabul edilmeýär. Programmada ulanylýan provayder tizligini sazlamak bu ýerde hem degişlidir, şonuň üçin bir provaydera edilen köp sanly haýyşlar ýalňyş diýilmek deregine haýalladylyp bilner.

API nämäni görüp bilýär

API programmalar ýaly gizlin däl, we munuň nähili bolandygy barada takyk bolmak peýdalydyr.

• Ol uçdan-uca şifrelenen däl. Programmalarda, habar diňe Nymbot-yň saklaýan we aşakdaky ýaly geçýän açarlary bilen enjabyňyzda möhürlenýär hedýe kagyzyna dolamak. API soragy adaty HTTPS: ol Nymbot-a gidýän ýolda şifrelenýär we Nymbot-yň serweri ony işlemek üçin açyk görnüşde okap alýar.
• Promptlar we jogaplar saklanmaýar. Olar modele geçýärler we jogap yzyna gaýdýar. Saklanýan zat bolsa hasap: her sorag üçin wagt, model, görnüş, token sanlary, çykdajy, balans, açar we üstünlikli bolup-bolmadygy, 90 gün möhletde, haýsy bolsa şol sorag taryhy size görkezýär. Şol bir soragyň ulanylyş ýazgysy hem (wagt, görnüşi, modeli, token sanlary, bahasy, dowamlylygy we web gözleg ulandymy ýa-da üstünlikli boldumy) programmanyň öz ýazgylary bilen bilelikde 90 gün saklanýar.
• Nym üçin beýleki ähli zatlar kiçidir we şu ýerde sanalýar. API açarlary heş hökmünde saklanýar, hiç wagt açar däl, olaryň ady, gysga yşarat, çykdajy çägi, täzelenme döwri, möhleti we haçan döredilenligi hem-de iň soňky ulanylan wagty bilen; diňe iň täze 50 geçersiz edilinen açar saklanýar. Bir awtomatiki ýükleme Kosak birleşmesi onuň çäk bahasy, mukdary we iň soňky doldurylmagynyň netijesi bilen bilelikde şifrirlenen görnüşde saklanýar. Wideo işleri 24 sagat saklanýar. Her jaň üçin tölenýän soraglar diňe 7 günlik Lightning töleg hash-ini we hiç hili at bilen baglanyşykly bolmadyk 30 günlük şifrirlenen yzyna gaýtarmak tokenini galdyrýar. Balans ýetmeýän tölegler, täze doldurylma tölegini ýapýança bergi hökmünde saklanýar.
• Programmany terlemek ony öçürýär. A enjamy arassalamak ähli API açarlaryny ýatyryp we öçürýär, şeýle hem sorag taryhyny, ulanyş ýazgylaryny, walet birleşmesini we wideo işlerini öçürýär. Balans we halkasy bolan islendik tölegler nym-da galýar.
• Modeliň üpjünçisi siziň haýyşyňyzy görýär, programmadan edil şeýle bolsa, Catalog modelleri öz döredijileri bilen işleýär; standart ýollary we gömberişleri (embeddings) Cloudflare-da işleýär.
• Döredilen mediýa umumydyr. Çakylyk görnüşinde berlen suratlar we wideolar umumy Blossom faýl ýerlerine ýüklenýär, ol ýerde faýlyň salgysy onuň hesaby bolup durýar. Çakylygy bolan islendik adam ony açyp bilýär we Nymbot ony täzeden öçürip bilmeýär. Soralyň b64_json we döredilen surat jogapda yzyna gelýär we hiç wagt ýüklänilmeýär.
• Diýmek, siziň berýän suratlaryňyz generatordurmy? Siz ýükleýän suratyňyz redaktirle, ýa-da şu görnüşde iber data: generator'yň içindäki URL image_url, ilki bilen generator ony alyp bilmegi üçin umumy Blossom hostuna ýüklenýär, şonuň ýaly hem şol bir zat şuna hem degişlidir. @-dan iberilen surat https:// link şol link hökmünde berilýär. Chat sorat ýagdaýyndaky suratlar model üpjünçisine gidýär, Blossom-a däl.
• Açar siziň nym-yňyza birleşdirildi. Açar tarapyndan harçlanan ähli zat siziň nym'yňyzyň balansyndan aýrylýar, şonuň üçin API ulanmak däl anonimEger API-ny gündelik nym-yňyzdan aýry saklamak isleseňiz, açarlary öz balansy bolan aýry nym arkaly dörediň.

Eger size programmalaryň goragyny ulanmak gerek bolsa, programmalary ulanyň. API bolsa modelleri öz guralyňyzda ulanmak isleýän wagtyňyz üçindir.

Her bir soňky nokat

“Nym” diýmek, siziň Nostr açaryňyz tarapyndan gol çekilen we aşakda beýan edilen sorga degişlidir hasap soraglaryna gol çekmekBu formatlarda eýýäm işleýän gurallar üçin şu ýere serediň: gurallar we SDK-lar, we kod agentleri ýaly Claude Code, Codex we Cline üçin, serediň kodirleme gurallary.