Zināšanu bāze / Izstrādātāji

Ugunsgrēka apskats

API runā OpenAI un Anthropic formātus, tāpēc lielākā daļa rīku un SDK darbojas, mainot bāzes URL un atslēgu.

Ērtības labad šī lapa ir mašīntulkota. Piemērotā versija ir oriģināls angļu valodā.

Kas ir ugunsgrēks

HTTP API izmantošana nymbot.ai kas atbild uz tiem pašiem pieprasījumiem, ko jau nosūta OpenAI vai Anthropic klients.

• Chat pabeigšanaTās Atbildes uz ugunsgrēku un Antropozīcijas vēstījumi, ar straumēšanu, rīkiem, attēliem, pamatojumu un tīmekļa meklēšanu, katram modelim Katalogs un Nymbot pašu automātisko maršrutēšanu.
• Attēli, Video, Runas, Transkripcijas un Iebūvētāji.
• Jūsu līdzsvars, Gaismas top-ups, Automātiskie top-ups no jūsu maku un a Vēsture Cik maksā katrs pieteikums.

Tas tiek maksāts no tiem pašiem diviem līdzsvars Nav abonēšanas un nav bezmaksas atlaides API: katrs pieprasījums tiek samaksāts no iegādātajiem kredītiem.

Ko API nedara, ir pievienot kaut ko no Nymbot paša. Jūsu ziņojumi tiek nosūtīti uz modeli, kad jūs tos nosūtījāt: nav Nymbot sistēmas pieprasījuma, nav atmiņas, nav datuma vai valodas norādījumu.

Bāzes URL

Katrs gala punkts dzīvo zem /api/v1/Nezināms ceļš atgriežas 404 un zināmais ceļš, ko sauc ar nepareizu metodi, atgriežas 405Tāpat kā JSON.

API atbild uz krustojuma pieprasījumiem no jebkuras vietnes, lai pārlūkprogrammas lapa to varētu izsaukt. galvaGalvenie punkti, kas parakstīti ar jūsu nym (ķēdes, konta kopsavilkums, NWC auto-top-up un atmaksas atmaksāšana) ir izņēmums: pārlūkprogrammā viņi atbild tikai uz Nymbot vietnēm. Parakstīt konta pieprasījumu.

Nosūtiet katru JSON ķermeni ar Content-Type: application/jsonJebkurš cits veids ir noraidīts 415, tātad vienkārša HTML forma vai text/plain pieprasījums no citas vietnes nevar sasniegt API. ar cURL -H "Content-Type: application/json" Kopā ar -d.

Uguns atslēgas

Atslēgas tiek izveidotas lietojumprogrammā. atvērt Ugunsgrēks tīmekļa lietojumprogrammas sānu joslā vai Android un iOS izvēlnē, un nospiediet Izveidot atslēguDodiet tam nosaukumu un, ja vēlaties, vāku un derīguma termiņu.

Kopējiet to kaut kur drošā vietā, pirms aizverat lapu: Nymbot saglabā tikai tā pirkstu nospiedumu, tāpēc tas to vairs nevar parādīt.

Atslēga izskatās kā sk-nymbot- seko 43 burti, cipari, rādītāji un apakšpunkti. lietotne uzskaita katru taustiņu pēc tās nosaukuma un īsas norādes, piemēram, sk-nymbot-Qm7x…c2Lw.

• Atslēga pieder jūsu nym. Tas iztērē jūsu līdzsvaru, un tikai jūsu nym var izveidot, mainīt vai atsaukt to. ikviens, kam ir atslēga, var iztērēt ar to, tāpēc izturēties pret to kā paroli.
• Caps ir likmes. Atslēgvārdam var būt izdevumu kapitāls, un kapitāls var tikt atkārtoti iestatīts katru dienu, katru nedēļu (pirmdien) vai katru mēnesi (pirmā), 00:00 UTC. Tā skaitās gan atlikumi, standarta kredīts kā 10 sats un Pro kredīts kā 100, tāpēc tas nozīmē to pašu neatkarīgi no tā, kāds atlikums tiek tērēts pieprasījumam. 403 key_limit_reached, pat ja atbilde būtu nonākusi zem vāka; kļūda norāda, cik daudz ir palicis un kad vāks tiek atkārtots. max_tokens Pieprasījums tiek iekasēts par to, ko tas faktiski maksā un kas skaitās pret kapitālu, tāpēc, ja pakalpojumu sniedzējs ziņo par vairāk žetoniem, nekā tie tika izslēgti, pēdējais pieprasījums, kas atbilst, var ņemt atslēgu nedaudz virs tās kapitāla; nākamais tiek noraidīts.
• Iztērētais kaps tikai pārtrauc tēriņus. Atslēga pie tās vāka joprojām var pārbaudīt bilanci, izlasīt tās vēsturi, uzskaitīt modeļus, skaitīt žetonus, augšupielādēt un pārbaudīt video, ko tā jau ir uzsākusi.
• Expiry ir fakultatīvs. Pēc datuma, kuru esat iestatījis, atslēga pārtrauc darbu.
• Atcelšana ir tūlītēja un galīga. Atceltā atslēga neizdod savu nākamo pieprasījumu. tā paliek sarakstā, atzīmēta ar atceltu, tāpēc tās izdevumu vēsture joprojām ir jēga.
• Jums var būt līdz 25 aktīvām atslēgām, no kurām katrai ir savs nosaukums.

Tajā pašā lapā ir parādīts katra atslēgas izdevumi šajā periodā un kopumā, kad tas pēdējo reizi tika izmantots, gan jūsu bilances, gan jūsu nesenie API pieprasījumi. Atslēgu pārvaldība.

Autentificēt pieprasījumu

Nosūtiet atslēgu jebkurā no šīm virsrakstīm.Tās ir līdzvērtīgas, tāpēc izmantojiet to, ko jūsu klients nosūta pēc noklusējuma:

Trūkst, nezināms, atsaukts vai beidzies atslēgas atgriešanās 401Kopā ar kodu missing_api_key, invalid_api_key, revoked_api_key vai expired_api_keyUzskaites modeļi, audio modeļi un balsis, kā arī maksājuma metodes neprasa atslēgu.

Attēlus, video, runu, transkripciju un ievietojumus var arī samaksāt par vienu pieprasījumu vienā reizē, izmantojot Lightning bez atslēgas vispār: nosūtiet pieprasījumu bez viena un samaksājiet rēķinu 402 Atbilde - redzēt Maksājums pēc pieprasījuma bez atslēgas.

Atslēgu pārvaldība, konta kopsavilkums un automātiskie top-ups ir izņēmums: tie ņem parakstu no jūsu nym, nevis atslēgu, tāpēc noplūdušais atslēga nevar padarīt vairāk atslēgas. Parakstīt konta pieprasījumu.

Jūsu pirmais pieprasījums

Ievietojiet atslēgu vides mainīgajā, pēc tam jautājiet modelim kaut ko. 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 ir Nymbot paša maršruts, kas samaksāts no standarta bilances. ievietojiet tā vietā kataloga modeļa ID, piemēram, anthropic/claude-sonnet-5, lai izmantotu šo modeli no Pro līdzsvara. Modelu saraksts Dodiet ikvienam ID.

Cik maksā pieprasījums

API rēķina tieši tā, kā lietotne to dara.

• Un kāda līdzsvars. nymbot/auto Iztērē to Standarta līdzsvars (10 sats a credit). katrs cits čata modelis tērē Pro bilance (100 sats a credit). Standarta attēlu ģenerators un standarta balss tērē standarta kredītus; katrs cits ģenerators tērē Pro. Iebūvējumi tērē standarta kredītus. Transcription tērē standarta kredītus, kad standarta bilance to var segt, un Pro kredītus citādi. Modelu saraksts norāda, kuru bilanci katrs modelis tērē.
• Cik daudz Tērzēšanas pieprasījums tiek mērīts uz žetoniem, kurus modelis faktiski izlasīja un uzrakstīja, par piegādātāja publicētajām likmēm. Šai cenai ir piešķirta 5% maksa un pēc tam tiek reizināta ar 1,5, tāpēc jūs maksājat 1,575 reizes no piegādātāja saraksta cenas. Tas tiek pārvērsts par likmēm par dzīvo Bitcoin cenu un tiek iekasēts tūkstošdaļās no kredīta. Pro attēli, video un runa tiek iekasēti par paaudzi, par sekundi vai par rakstzīmi, un transkripcija par sekundi audio, ar to pašu maksu un maržu. Standarta attēls ir plakans 5 standarta kredīti un standarta balss ir plakans 3.
• Tātad minimums . Katrs mērīts pieprasījums, kas darbojas, maksā vismaz 0,05 kredītu: puse no standarta bilances, 5 likmes par Pro. Kredīta daļas tiek pārnestas, nevis noapaļotas katru reizi.
• Saglabājiet un pēc tam nosūtiet. Pirms pieprasījuma darbojas, visvairāk, ko tas varētu maksāt, tiek turēts no jūsu bilances, pamatojoties uz to, ko jūs nosūtījāt, un visvairāk žetonu, ko tas var rakstīt. Teksts ārpus ASCII ir izmērīts no tā UTF-8 bajtiem, un ASCII cipari un punktu skaits tiek aprēķināti kā ikviens žetons, tāpēc teksts jebkurā skriptā, kodā un numuros tiek turēts pilnā apmērā. Turētājs ir veseli kredīti, vismaz viens, tāpēc jebkuram pieprasījumam ir nepieciešams vismaz 10 bezmaksas likmes standarta bilancē vai 100 likmes Pro, lai sāktu. Tikai faktiskās izmaksas tiek iekasētas; pārējais tiek atbrīvots, kad tas beidzas. 402 insufficient_balance Ja atmaksātais maksājums ir lielāks par atmaksāto summu, atmaksātais maksājums ir lielāks par atmaksāto summu, tad atmaksātais maksājums ir lielāks par atmaksāto summu (owed_sats Tajā nymbot objekts un negatīvs līdzsvars). Kas ir parādā, tiek izmaksāts vispirms no nākamajiem kredītiem, kas sasniedz šo līdzsvaru. Kamēr tas nav samaksāts, nekas par šo līdzsvaru nevar tikt tērēts: ne API, atbildes lietojumprogrammā, pārskaitījums vai dāvana.
• Nav pietiekami daudz kredītu Ja atlikums nevar segt turēšanu, pieprasījums tiek noraidīts ar 402 Pirms kaut kas darbojas. kļūda norāda, kurš līdzsvars ir īss, cik daudz sats pieprasījumam ir nepieciešams un cik daudz ir bezmaksas. max_tokens Tas nozīmē mazāku izturību.
• Ar neveiksmēm. Neveiksmīgs pieprasījums neko nemaksā, ja vien piegādātājs nav iekasējis rēķinu par darbu, ko viņš veica pirms neveiksmes, vai tīmekļa meklēšanu. nymbot/auto uzdevuma pārbaude jau bija veikta; tad tas ir tas, ko jūs maksājat, vismaz 0.05 kredīts. plūsma, kuru jūs izgrieziet, tiek iekasēta par piegādātāja ziņoto žetonu: Nymbot turpina lasīt piegādātāja plūsmu līdz 25 sekundēm pēc tam, kad jūs atstājāt, lai saņemtu šo skaitli.
• WEB meklēšana izmaksas $ 0,008 meklēšana, pārvēršot par sats, katru reizi, kad meklēšana tika veikta, vai modelis tad atbild vai neizdodas.

Katra atbilde norāda, cik tas maksā. JSON atbildes nes nymbot objekts ar atlikumu, no kura tas tika samaksāts, maksu kredītos un likmēs un to, kas paliek:

Objekta izmaksas

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

Apmaksātās atbildes satur arī šādus virsrakstus, kas ir vieta, kur meklēt atbilžu izmaksas, kas nav JSON, piemēram, runas:

Likmes uz miljonu žetonu, jau ieskaitot maksu un maržu, ir Modelu saraksts dolāros un likmēs, un uz Cenu sarakstsJa Bitcoin cenu nevar izlasīt, atgriež apmaksātus pieprasījumus 503 price_unavailable ar Retry-After: 60 Tā vietā, lai uzminētu

kļūdas

Katrai kļūdai ir tāda pati forma, kuru OpenAI klienti jau saprot. code ir stabils nosaukums, ar kuru jūs varat atbilst; message Tas ir cilvēkiem un var mainīties.

Kļūda ķermenī

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

Divi izņēmumi :

• /api/v1/messages Atbildes ir Anthropic kļūdu formātā, jo tas ir tas, ko Anthropic klienti analizē: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Tips seko statusu: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error vai overloaded_error (503).
• Straumēšanas pieprasījums, kas neizdodas pirms pirmā bajta, saņem parastu JSON kļūdu ar iepriekš minēto statusu, nevis notikumu straumu.

Kļūdu ziņojumi nekad nesatur citas pakalpojuma iekšējās detaļas.

ierobežojumi

Saite uz attēlu ir jānorāda uz publisku saimnieku: adrese privātā vai vietējā tīklā vai Nymbot vietnēs tiek noraidīta.

Ko var redzēt ugunsgrēks

API nav privāts tādā veidā, kādā ir lietojumprogrammas, un ir vērts būt precīziem par to, kā.

• Tas nav end-to-end šifrēts. Lietojumprogrammās ziņojums ir noslēgts jūsu ierīcē, lai atslēgas tikai Nymbot tur un ceļo kā Dāvanu vākšanaAPI pieprasījums ir parasts HTTPS: tas tiek šifrēts ceļā uz Nymbot, un Nymbot serveris to lasa skaidrā, lai to apstrādātu.
• Prompts un atbildes netiek glabātas. Tas, kas tiek saglabāts, ir rēķins: par katru pieprasījumu laiks, modelis, veids, žetona skaitļi, izmaksas, bilance, atslēga un vai tas ir izdevies, 90 dienas, kas ir tas, ko Vēlas vēsturi To pašu pieprasījumu izmantošanas ieraksts (laiks, veids, modelis, žetonu skaits, izmaksas, ilgums un tas, vai tas izmantoja tīmekļa meklēšanu vai sekmīgi) tiek saglabāts arī 90 dienas, kopā ar lietotnes pašu.
• Viss pārējais, kas tiek turēts par nym, ir mazs un šeit uzskaitīts. Uguns atslēgas tiek glabāti kā hash, nekad atslēgu, ar savu vārdu, īsu ieteikumu, izdevumu kapu, atkārtotu termiņu, derīguma termiņu un kad tie tika veikti un pēdējo reizi izmantoti; tiek saglabātas tikai jaunākās 50 atceltās atslēgas. Automātiskais top-up Portfeļa savienojums tiek glabāts šifrēts, ar tā slieksni, summu un pēdējā top-up rezultātu. Video darbavietas tiek saglabātas 24 stundas. Pieprasījumi, kas samaksāti par zvanu, atstāj tikai Lightning maksājumu hašu 7 dienas un hashed atmaksas žetonu 30 dienas, kas saistīts ar ne-nim.
• Izdzēšot aplikāciju, tas tiek izdzēsts. A ierīce WIPE atceļ un dzēš katru API atslēgu un dzēš vaicājumu vēsturi, lietošanas ierakstus, maku savienojumu un video darbus.
• Modeļa piegādātājs redz jūsu pieprasījumuKatalogu modeļi darbojas to veidotājiem; standarta maršruti un iebūvējumi darbojas Cloudflare.
• Radītie plašsaziņas līdzekļi ir publiski. Attēli un videoklipi, kas tiek piegādāti kā saites, tiek augšupielādēti publiskajos Blossom failu hostos, kur faila adrese ir tā hash. b64_json un ģenerēts attēls atgriežas atbildē un nekad netiek augšupielādēts.
• Tāpat ir attēli, kurus jūs sniedzat ģeneratoram. Attēls, kuru jūs augšupielādējat Edit, vai nosūtīt kā a data: URL ģenerators image_url, vispirms tiek augšupielādēts publiskam Blossom saimniekam, lai ģenerators to varētu saņemt, un tas pats attiecas uz to. https:// Attēli tērzēšanas pieprasījumā iet uz modeļa pakalpojumu sniedzēju, nevis uz Blossom.
• Atslēga ir saistīta ar jūsu nym. Viss, ko atslēga tērē, nāk no jūsu nym bilances, tāpēc API izmantošana nav AnonīmsJa vēlaties, lai API izmantošana tiktu saglabāta atsevišķi no jūsu ikdienas nym, izveidojiet atslēgas no atsevišķas nym ar savu līdzsvaru.

Ja jums ir nepieciešama lietojumprogrammu aizsardzība, izmantojiet lietojumprogrammas. API ir piemērots, ja jums ir nepieciešami modeļi savos rīkos.

Katrs gala punkts

“Nym” nozīmē pieprasījumu, kas parakstīts ar jūsu Nostr atslēgu, kas aprakstīts Parakstīt konta pieprasījumuPar rīkiem, kas jau runā šos formātus, skatiet Instrumenti un SDK, un kodēšanas aģentiem, piemēram, Claude Code, Codex un Cline, skatiet Kodēšanas rīki.