Baza e njohurive / Zhvilluesit

Pamje e plotë e zjarrit

Modelet, gjeneratorët dhe balancat që përdorni në aplikacion, nga kodi juaj. API flet për formatet OpenAI dhe Anthropic, kështu që shumica e mjeteve dhe SDK-ve punojnë duke ndryshuar një URL bazë dhe një çelës.

Kjo faqe është përkthyer me makinë për lehtësi. Origjinali në anglisht është versioni që zbatohet.

Çfarë është zjarri

Një HTTP API në nymbot.ai që përgjigjet të njëjtat kërkesa që një klient OpenAI ose Anthropic tashmë dërgon.

• Chat Përfundim, të Përgjigje zjarri dhe Mesazhet antropike, me streaming, mjete, imazhe, arsyetim dhe kërkim web, për çdo model në Katalogu dhe për auto-routing e vet Nymbot.
• Imazhe, Video të, Fjalimi, transkriptim dhe embeddings.
• E juaja Balancës, Dritë Top-ups, Top-ups automatike nga portofoli juaj dhe a historisë Çfarë kushton çdo kërkesë

paguhen nga të njëjtat dy Balancës Nuk ka abonim dhe nuk ka leje falas në API: çdo kërkesë paguhet nga kreditet që keni blerë.

Ajo që API-ja nuk bën është të shtoni asgjë të vetën e Nymbot-it. Mesazhet tuaja shkojnë në model ndërsa i dërgoni ato: nuk ka sistem të Nymbot-it, nuk ka kujtesë, nuk ka datë ose sugjerime të gjuhës.

URL bazë

Çdo pikë e fundit jeton nën /api/v1/Një rrugë e panjohur kthehet 404 dhe një rrugë e njohur e quajtur me metodën e gabuar kthehet 405Të dy si JSON.

API përgjigjet kërkesave të kryqëzuara nga çdo vend, kështu që një faqe shfletuese mund ta thërrasë atë. Çdo gjë që ju dërgoni në një shfletues mund të lexohet nga kushdo që e hap atë, megjithatë, kështu që vetëm ta bëni këtë me një çelës që ka një kokëEndpoints nënshkruar me nym tuaj (keys, përmbledhjen e llogarisë, NWC auto-top-up dhe rimbursim shpengimit) janë përjashtim: në një shfletues ata përgjigjen vetëm faqet e veta Nymbot. Kërkesat e nënshkrimit të llogarisë.

Dërgo çdo trup JSON me Content-Type: application/jsonÇdo lloj tjetër është refuzuar me 415, kështu që një formë e thjeshtë HTML ose një text/plain Kërkesa nga një vend tjetër nuk mund të arrijë API. Me cURL, kaloni -H "Content-Type: application/json" së bashku me -d.

Çelësat e zjarrit

Çelësat janë bërë në app. zjarri në shiritin anësor të aplikacionit web, ose në menunë në Android dhe iOS, dhe prekni Krijo çelësinJepni një emër dhe, nëse dëshironi, një kapak dhe një datë skadimi.

Kopjoni në një vend të sigurt para se të mbyllni fletën: Nymbot mban vetëm një gjurmë gishtash të saj, kështu që nuk mund t'ju tregojë përsëri.

Një çelës duket sk-nymbot- e ndjekur nga 43 shkronja, shifra, shifra dhe nënshkrime. Aplikacioni liston çdo çelës me emrin e tij dhe një sugjerim të shkurtër si: sk-nymbot-Qm7x…c2Lw.

• Një çelës i përket nym tuaj. Ajo shpenzon bilancin tuaj, dhe vetëm nymi juaj mund ta bëjë, të ndryshojë ose të revokojë atë. kushdo që mban çelësin mund të shpenzojë me të, kështu që trajtoje atë si një fjalëkalim.
• Kapsulat janë në bast. Një çelës mund të ketë një kapak shpenzimi, dhe kapaku mund të rivendoset çdo ditë, çdo javë (e hënë) ose çdo muaj (i pari), në 00:00 UTC. Ajo numëron të dy balancat, një kredi standarde si 10 sats dhe një kredi Pro si 100, kështu që do të thotë e njëjta kudo balanca një kërkesë shpenzon. 403 key_limit_reached, edhe nëse përgjigja do të kishte ardhur nën kapak; gabimi tregon se sa ka mbetur dhe kur kapaku rivendoset. max_tokens Një kërkesë ngarkohet se çfarë kushton në të vërtetë dhe që llogaritet kundër kapakut, kështu që në qoftë se ofruesi raporton më shumë tokenë se sa u vendosën mënjanë, kërkesa e fundit që përshtatet mund të marrë çelësin pak përtej kapakut të tij; tjetri atëherë refuzohet.
• Një kapak i shpenzuar vetëm ndalon shpenzimet. Një çelës në kapakun e tij ende mund të kontrollojë bilancin, të lexojë historinë e tij, të listojë modelet, të numërojë tokenët, të kryejë dhe të kontrollojë një video që ka filluar tashmë.
• Expiry është opsional. Pas datës që keni vendosur, çelësi ndalon së punuari.
• Shkarkimi është i menjëhershëm dhe përfundimtar. Një çelës i revokuar dështon kërkesën e tij të ardhshme. Ai mbetet në listë, i shënuar i revokuar, kështu që historia e shpenzimeve ende ka kuptim.
• Ju mund të keni deri në 25 çelësat aktive, secila me emrin e vet.Ndryshimi i periudhës së rivendosjes së një çelësi fillon një periudhë të re nga zero.

I njëjti fletë tregon shpenzimet e secilit çelës për këtë periudhë dhe në total, kur u përdor për herë të fundit, të dy bilancet tuaja dhe kërkesat tuaja të fundit API. Menaxhimi i çelësave.

Autentifikimi i një kërkese

Dërgoni çelësin në ndonjë nga këto tituj. ato janë ekuivalente, kështu që përdorni atë që klienti juaj dërgon sipas parazgjedhjes:

Një çelës i humbur, i panjohur, i revokuar ose i skaduar kthehet 401Me kodin e missing_api_key, invalid_api_key, revoked_api_key ose expired_api_keyModelet e listës, modelet audio dhe zërat dhe metodat e pagesës nuk kanë nevojë për çelës.

Fotot, videot, fjalët, transkriptimet dhe embeddings gjithashtu mund të paguhen për një kërkesë në një kohë mbi Lightning pa asnjë çelës në të gjitha: dërgoni kërkesën pa një dhe paguani faturën në 402 Përgjigje: Shiko Pagesa me kërkesë pa çelës.

Menaxhimi i çelësave, përmbledhja e llogarisë dhe top-ups automatike janë përjashtimi: ata marrin një nënshkrim nga nym juaj në vend të një çelës, kështu që një çelës i rrjedhur nuk mund të bëjë më shumë çelësat. Kërkesat e nënshkrimit të llogarisë.

Kërkesa juaj e parë

Vendosni çelësin në një variabël mjedisore, pastaj kërkoni një model diçka. 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 është drejtimi i vet i Nymbot, i paguar nga bilanci standard. Vendosni id-në e një modeli katalogu atje në vend, të tilla si: anthropic/claude-sonnet-5, për të përdorur atë model nga Pro balancimit. Lista e modeleve Të gjitha id.

Çfarë kushton një kërkesë

API faturon pikërisht ashtu si bën aplikacioni.

• Çfarë ekuilibri nymbot/auto shpenzojnë atë Standardë balancë (10 sats një kredi). Çdo model tjetër chat shpenzon për balanca (100 sats një kredit). Generatori standard i imazhit dhe zëri standard shpenzojnë kredi standarde; çdo gjenerator tjetër shpenzon Pro. Embeddings shpenzojnë kredi standarde. Transcription shpenzon kredi standarde kur bilanca standarde mund ta mbulojë atë, dhe kredite Pro ndryshe. Lista e modeleve tregon se çfarë bilance shpenzon secili model.
• Sa shumë Një kërkesë për bisedë matet në tokenët që modeli në të vërtetë lexon dhe shkruan, në normat e publikuara të ofruesit. Ky çmim ka një tarifë të shtuar 5% dhe pastaj shumëzohet me 1.5, kështu që ju paguani 1.575 herë çmimin e listës së ofruesit. Ajo konvertohet në tarifë në çmimin e jetojnë Bitcoin dhe ngarkohet në mijëra të një krediti. Fotot Pro, video dhe fjalimi janë të çmimit për gjeneratë, për sekondë ose për karakter, dhe transkriptimi për sekondë të audio, me të njëjtën tarifë dhe margjinë. Imazhi standard është një shesh 5 kredite standarde dhe zëri standard një shesh 3.
• minimale të Çdo kërkesë e matur që shkon kushton të paktën 0.05 kredi: gjysma e një vënë në bilancin standarde, 5 vënë në Pro.
• Mbajeni dhe pastaj vendosni. Para se të drejtohet një kërkesë, më shumë që mund të kushtojë mbahet nga bilanci juaj, bazuar në atë që keni dërguar dhe më shumë token që mund të shkruajë. Teksti jashtë ASCII i thjeshtë është i madhësuar nga bytet e tij UTF-8, dhe shifrat ASCII dhe pikturimi llogariten si një token secili, kështu që teksti në çdo skenar, kod dhe numra mbahen në tërësi. Mbajtja është në kredi të tëra, të paktën një, kështu që çdo kërkesë ka nevojë për të paktën 10 sats falas në bilancin standard ose 100 sats në Pro për të filluar. Vetëm kostoja aktuale ngarkohet; pjesa tjetër lëshohet kur përfundon. Një kërkesë e gjatë mban mbajtjen e saj për aq kohë sa funksionon; nëse kreditet e mbajtura ndalen 402 insufficient_balance Në qoftë se shpenzimet janë më të larta se sa mund të paguajë bilanci, të gjithë bilanci është marrë, pjesa tjetër është e detyruar (owed_sats Në të nymbot objekti, dhe një bilanc negativ). Ajo që është e detyruar paguhet së pari nga kreditet e ardhshme që arrijnë atë bilanc. Derisa të paguhet, asgjë në atë bilanc nuk mund të shpenzohet: jo nga API, përgjigjet në aplikacion, një transferim ose një dhuratë.
• Nuk ka kredi të mjaftueshme Nëse bilanci nuk mund të mbulojë mbajtjen, kërkesa refuzohet me 402 Gabimi tregon se cili bilanc është i shkurtër, sa sats kërkesa ka nevojë dhe sa janë të lira. max_tokens do të thotë një mbajtje më e vogël.
• dështimeve të Një kërkesë që dështon nuk kushton asgjë, përveç nëse ofruesi faturoi për punën që bëri para dështimit, ose një kërkim në internet ose nymbot/auto verifikimi i detyrës tashmë ishte drejtuar; atëherë kjo është ajo që ju paguani, të paktën 0.05 kredi. Një rrymë që ju prerë është e ngarkuar për tokenët që ofruesi raporton: Nymbot vazhdon të lexojë rrymën e ofruesit për deri në 25 sekonda pasi ju largoheni për të marrë atë numër.
• Kërkim Web kushton $0.008 një kërkim, i konvertuar në sats, sa herë që një kërkim është drejtuar, nëse modeli pastaj përgjigjet ose dështon.

Çdo përgjigje tregon se sa kushton. përgjigjet JSON mbajnë një nymbot objekti me bilancin nga i cili është paguar, tarifa në kredite dhe sats, dhe çfarë mbetet:

Objekti i kostos

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

Përgjigjet e paguara gjithashtu mbajnë këto tituj, e cila është ku për të kërkuar për koston e një përgjigje që nuk është JSON, të tilla si fjalimi:

Tarifat për milion tokenë, tashmë duke përfshirë tarifën dhe marzhin, janë në Lista e modeleve në dollarë dhe në Çmimi i fletësNëse çmimi i Bitcoin nuk mund të lexohet, kërkesat e paguara kthehen 503 price_unavailable me Retry-After: 60 Në vend që të mendohet

Gabimet

Çdo gabim ka të njëjtën formë, atë që klientët e OpenAI tashmë e kuptojnë. code është një emër i qëndrueshëm që mund të përputhet me; message Është për njerëzit dhe mund të ndryshojë.

Trupi i gabuar

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

Dy përjashtime:

• /api/v1/messages përgjigjet në formatin e gabimit të Anthropic, pasi kjo është ajo që klientët e Anthropic analizojnë: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Lloji ndjek statusin: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error ose overloaded_error (503).
• Një kërkesë streaming që dështon para bytes së saj të parë merr një gabim të zakonshëm JSON me statusin e mësipërm, jo një rrymë ngjarjesh.

Mesazhet e gabimit kurrë nuk përmbajnë detajet e brendshme të një shërbimi tjetër. gabimi i një ofruesi riformulohet para se të arrijë tek ju.

Kufijtë

Një lidhje me një foto duhet të tregojë një host publik: një adresë në një rrjet privat ose lokal, ose në faqet e veta të Nymbot, refuzohet.

Çfarë mund të shohë zjarri

API nuk është private në mënyrën se si janë aplikacionet, dhe ia vlen të jetë i saktë se si.

• Nuk është e koduar nga fundi në fund. Në aplikacionet, një mesazh është vulosur në pajisjen tuaj për çelësat vetëm Nymbot mban dhe udhëton si një Dhuratë WrapNjë kërkesë API është e zakonshme HTTPS: ajo është e koduar në rrugën për në Nymbot, dhe serveri i Nymbot e lexon atë në të qartë për ta trajtuar atë.
• Pyetjet dhe përgjigjet nuk ruhen. Ajo që mbahet është fatura: për çdo kërkesë koha, modeli, lloji, numrat token, kostoja, bilanci, çelësi dhe nëse ka sukses, për 90 ditë, që është ajo që Kërko historinë Një regjistrim i përdorimit të të njëjtës kërkesë (koha, lloji, modeli, numri i tokenit, kostoja, kohëzgjatja dhe nëse ka përdorur kërkimin në internet ose ka pasur sukses) ruhet gjithashtu për 90 ditë, së bashku me aplikacionin e vet.
• Çdo gjë tjetër e mbajtur për një nym është e vogël dhe e listuar këtu. Çelësat e zjarrit janë ruajtur si një hash, kurrë çelësin, me emrin e tyre, një sugjerim të shkurtër, kapak shpenzimesh, periudha e rivendosjes, skadimi dhe kur ata janë bërë dhe përdorur për herë të fundit; vetëm 50 çelësat e fundit të revokuara janë ruajtur. Top-up automatik Kërkesat e paguara për thirrje lënë vetëm një hash pagese Lightning për 7 ditë dhe një token rimbursimi të hashed për 30 ditë, i lidhur me asnjë nym.
• Duke fshirë aplikacionin do ta fshini atë. A Pajisje Wipe tërheq dhe fshin çdo çelës API, dhe fshin historinë e pyetjeve, të dhënat e përdorimit, lidhjen e portofolit dhe punët video.
• Ofruesi i modelit e sheh kërkesën tuajModelet e katalogut drejtohen në krijuesit e tyre; rrugët standarde dhe embeddings drejtohen në Cloudflare.
• Media e gjeneruar është publike. Fotot dhe videot e dorëzuara si lidhje ngarkohen në hostet publike të skedarëve Blossom, ku adresa e një skedari është hash. Kushdo me lidhjen mund ta hapë atë, dhe Nymbot nuk mund ta shkarkojë atë përsëri. b64_json Dhe një imazh i gjeneruar kthehet në përgjigje dhe kurrë nuk ngarkohet.
• Kështu janë fotot që ju jepni një gjenerator. Një foto që ju ngarkoni në Editë, ose dërgoni si a data: URL në një gjenerator image_url, është ngarkuar në një Blossom host publik së pari në mënyrë që gjeneratori mund të marrë atë, dhe e njëjta gjë vlen për të. https:// Fotot në një kërkesë chat shkojnë tek ofruesi i modelit, jo tek Blossom.
• Një çelës është i lidhur me nym tuaj. Çdo gjë që një çelës shpenzon vjen nga bilanci i nym tuaj, kështu që përdorimi i API nuk është AnonimëNëse dëshironi që përdorimi i API-së të mbahet larg nym tuaj të përditshëm, bëni çelësat nga një nym i veçantë me ekuilibrin e vet.

Nëse keni nevojë për mbrojtjen e aplikacioneve, përdorni aplikacionet. API është për kur keni nevojë për modelet në mjetet tuaja.

Çdo përfundim

“Nym” do të thotë një kërkesë e nënshkruar nga çelësi juaj Nostr, i përshkruar në Kërkesat e nënshkrimit të llogarisëPër mjetet që tashmë flasin këto formate, shih Mjetet dhe SDK-të, dhe për agjentët e kodimit si Claude Code, Codex dhe Cline, shih Mjetet e kodimit.