د پوهې بنسټ / پراختیا

د API په اړه

د ماډلونه، جنراتورونه او توازنونه چې تاسو په غوښتنلیک کې کاروي، ستاسو د خپل کوډ څخه. د API د OpenAI او Anthropic فارمونو سره خبرې کوي، نو ډیری وسایلو او SDKونو د بنسټ URL او کلید بدلولو سره کار کوي.

دا پاڼه د اسانتیا لپاره ماشین ژباړل شوې ده. انګلیسي اصلي نسخه ده چې پلي کیږي.

څنګه چې د API

د HTTP API nymbot.ai چې ورته پوښتنو ته ځواب ورکوي چې د OpenAI یا Anthropic کلینټونه اوس هم چمتو کوي. تاسو ترلاسه کړئ:

• چټک بشپړولود د API ځواب او antropological پیغامونه، سره د سټراییم، وسایل، انځورونه، دلیلونه او ویب څیړنې، د هر موډل په اړه کټګورۍ او د Nymbot خپل اتومات روټ کولو لپاره.
• انځورونه, ویډیو, د نښه, د transcription او نندارتونونه.
• ستاسو توازن, د رڼا top-ups, اتومات Top-ups له خپل کیف او د د تاریخ د هر غوښتنې لګښت.

دا د ورته دوو څخه ورکړل کیږي توازن لکه څنګه چې د اپلیکیشن، په ورته نرخونو کې. د API په اړه نه پینلونه او نه وړیا وړاندیزونه شتون لري: هر غوښتنلیک د کریډیټونو څخه پیسو کیږي چې تاسو خوندي کړئ.

هغه څه چې د API نه کوي دا دی چې د Nymbot خپل څه اضافه کړئ. ستاسو پیغامونه به د ماډل ته ورسیږي لکه څنګه چې تاسو دوی ته ورسیږي: نه د Nymbot سیسټم پاملرنه، نه د حافظه، نه د تاریخ او یا د ژور نندارتونونه. هغه څه چې راځي دا د ماډل د ځواب دی او د دې لګښت په اړه یو نوټ دی.

د URLs

هر Endpoint د ژوند لاندې /api/v1/د ناشایستې سړک د رجوع 404 او یو معلومه لاره چې د غلط طریقې سره نومول کیږي راځي. 405لکه څنګه چې JSON.

د API د هر سایټ څخه د cross-origin غوښتنې ځواب کوي، نو یو براؤزر پاڼه کولی شي دا راټول کړي. هر څه چې تاسو ته د براؤزر ته لیږدول کیدی شي د هغه څوک لرم چې دا راټول کیږي، خو یوازې د یو کلید سره چې د کوچنۍ کچه لري. د سر. د پایپ ټکي چې ستاسو د nimm سره امین شوي دي (کړونه، حساب خلاص، NWC اتومات او refund خوندي) د استثنا دي: په یو براؤزر کې دوی یوازې د Nymbot خپل سایټونه ځواب کوي. وګورئ د حساب ورکولو غوښتنلیک.

هر JSON بدن سره Content-Type: application/jsonهر بل ډول د 415لکه څنګه چې د ساده HTML شکل یا text/plain د نورو سایټونو څخه د غوښتنې کولی شي د API ته ورسیږي. د cURL سره، -H "Content-Type: application/json" همدارنګه -d.

د API کلیدونه

کلیدونه په اپلیکیشن کې جوړ شوي دي. Open د آتشې په ویب اپلیکیشن سایټ بار کې، یا په Android او iOS کې مینو کې، او د کلید جوړ کړئ. دا د يو نوم او، که تاسو غواړئ، د پوښونو او د ختم تاریخ.

د کلید د یو ځل ښودل کیږي. د پاڼه بندولو مخکې دا په خوندي ځای کې کاپي کړئ: Nymbot یوازې د دې څخه یو fingerprint ذخیره کوي، نو دا به تاسو ته دا نه ښودل شي. د کټ شوي کلیدونه کولی شي نه ترلاسه شي؛ د هغه لټون کړئ او یو بل جوړ کړئ.

د کلید په څیر sk-nymbot- د 43 حروف، اټکلونه، ډیزاینونه او underscores لخوا پیژندل کیږي. د اپلیکیشن د هر کلید د خپل نوم او یو مختصر پاملرنه لکه sk-nymbot-Qm7x…c2Lw.

• یو کلید د خپل نیم لري. دا ستاسو د توازن لګښت کوي، او یوازې ستاسو نیم کولای شي دا جوړ کړي، بدل کړئ یا لګښت ورکړي. هر څوک چې د کلیدي لګښت کوي کولای شي د دې سره لګښت ورکړي، نو دا به د پاسورډ په څیر وي.
• Caps په شرط کې دي. د کلیدي کچه کولی شي د لګښت کچه لري، او کچه کولی شي هر ورځ، هر اونۍ (د اونۍ) یا هر میاشت (د لومړي) په 00:00 UTC. دا د دوو توازنونو حساب کوي، د معياري کریډیټ په توګه 10 sats او د پرو کریډیټ په توګه 100، له دې امله دا ورته معنی لري کومې توازن د غوښتنې لګښت کوي. مخکې له دې چې د غوښتنې ترسره شي، دا کولی شي د لګښت (د کلې کریډیټونو ته راټول شوي) په مقابل کې مقرر کیږي چې د کڅوړه لګښت لري. که دا نه راټول کیږي، د غوښتنې له خوا انکار کیږي 403 key_limit_reached، حتی که د ځواب د پوښونو لاندې وي؛ د غلطۍ وايي چې څومره رخصت دی او کله چې پوښ ته رسیږي. max_tokens د غوښتنې ته د هغه څه په واقعیت کې لګښت لري او دا د کټ سره شمول کیږي، نو که پلورونکي نور ټکینونه راپور ورکوي چې د خوندي شوي دي، د وروستیو غوښتنلیک چې مناسب وي کولی شي د کلید د دې کټ څخه ډډه وکړي؛ په دې توګه، د راتلونکي څخه انکار کیږي.
• د سپارلو لپاره د سپارلو یوازې د سپارلو لپاره. د دې په پوښ کې یو کلید کولای شي د توازن چمتو کړي، د دې تاریخو وګورئ، د نمونې لیست کړئ، ټوکنونو لټون کړئ، او د ویډیو وګورئ چې دا اوس مهال پیل شوی.
• Expiry د اختیاري. کله چې تاسو د تاریخ تنظیم کړئ، د کلید کار نه کوي.
• د انتقام د فوری او پایلې ده. یو لګول شوي کلید د راتلونکي غوښتنلیک سره ناکام کیږي. دا په لیست کې وي، د لګول شوي لګول په لټه کې وي، نو د هغې لګول تاریخ هم منطقي دی.
• تاسو کولی شئ تر 25 فعال کلیدونه لري، کوم چې د خپل خپل نوم لري. د کلید د رخصتۍ دوره بدل کړئ د نوي دوره له رخصتۍ پیل کوي.

په ورته پاڼه کې د هر کلید په دې دوره کې اخلي او په ټولیزه توګه، کله چې دا په وروستیو وخت کې کارول شو، ستاسو د توازنونو او ستاسو د وروستیو API غوښتنې. د دې پیژندنې پایلې په لاندې کې ډیزاین شوي دي د کلیدي مدیریت.

د درخواست د تصدیق کولو

د دغو مخکښونو په هر ډول کې د کلیدو سپارښتنه کړئ. دوی برابر دي، نو د دې لپاره چې ستاسو د کلینر په معياري توګه سپارښتنه کوي:

د ناکام، نامتو، لګول شوي یا ختم شوي کلیدونه 401د کوډ سره missing_api_key, invalid_api_key, revoked_api_key یا expired_api_keyد تلیفون ماډلونه، صوتی ماډلونه او غږونه، او د پیسو طریقې ته اړتیا نلري.

انځورونه، ویډیو، خبرې، transcription او embeddings هم کولی شي په هر وخت کې د رڼا په اړه د يو غوښتنلیک له خوا په هر ډول د کلیدي پرته ورکړل شي: د غوښتنلیک پرته ورکړئ او په حساب کې ورکړئ 402 ځواب په هر غوښتنې پرته د کلیدي پرته پیسې.

د کلیدي مدیریت، د حساب خلاصې او اتومات top-ups د استثنا دي: دوی د کلید په ځای د خپل نیم څخه د سند ترلاسه کوي، نو د لګولو کلیدونه نه کولی شي نور کلیدونه جوړ کړي. د حساب ورکولو غوښتنلیک.

ستاسو د لومړي درخواست

په یو چاپیریال متغیر کې کلید واخلئ، بیا د ماډل څخه څه پوهیږئ. د دغو صفحات په بشپړ ډول د مثالونو له دې څخه وګورئ 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 خپل روټنگ دی، د معياري توازن څخه ورکړل کیږي. په ځای کې د کاتالوژۍ ماډل ID کړئ، لکه: anthropic/claude-sonnet-5، د دې ماډل څخه د پرو توازن څخه کارول. د نمونوي لیست هر ID ورکړئ.

د غوښتنې لګښتونه

د API دقیقا د اپلیکیشن په څیر حساب کوي.

• څومره توازن nymbot/auto د سپارلو معياري توازن (10 sats a credit). هر بل چیټ ماډل د د پرو د معیاري انځور جنراتور او معياري غږ د معياري کریډیټونه اخلي؛ هر بل جنراتور د پرو اخلي. د انډولونو د معياري کریډیټونه اخلي. Transcription د معياري کریډیټونه اخلي کله چې د معياري توازن کولی شي د دې پوښښ، او د پرو کریډیټونه په بل ډول. د ماډل لیست وايي چې هر موډل د توازن اخلي.
• څومره د چټک غوښتنلیک د نمونوي په واقعیت کې لوستل او لیکل شوي ټکنونو په اندازه کې اندازه کیږي، د عرضه کوونکي په اعلان شوي نرخونو کې. دا بيه د 5٪ لګښت اضافه کوي او بیا د 1.5 په لټه کې دی، نو تاسو د عرضه کوونکي لست بيه 1575 ځله ورکړئ. دا په ژوند کې د Bitcoin بيه کې د sats بدل کیږي او د کریډیټ د هزارو ټوټهونو کې لګښت کیږي. پرو انځورونه، ویډیو او خبرې د نسل، په ثانیو کې یا د ځانګړتیاو په هر ثانیو کې لګښت شوي دي، او د غږونو په هر ثانیو کې لګښت لري، په ورته لګښت او margin سره. د معياري انځور د 5 معياري کریډیټ دی او د معياري غږ د 3 لګښت
• د کمېسيون هر ټیټ غوښتنلیک چې د کمېسيون 0.05 کریډیټ لګښتونه لري: د معياري توازن کې د نیم ټیټ، د پرو لپاره د 5 ټیټ. د کریډیټ د فریکونسونو په پرتله لیږد شوي دي، هر وخت نه راټول شوي.
• چمتو کړئ، او بیا ځای کړئ. د غوښتنې چلولو مخکې، دا کولی شي ستاسو د توازن څخه تر ټولو لګښت لري، د هغه په اساس چې تاسو سپارښتنه وکړئ او دا کولی شي تر ټولو ټکینونه ورسوي. د ساده ASCII څخه بهر متن د UTF-8 بټونو څخه اندازه لري، او ASCII شمیره او ټکینونو د هر یو ټکین په توګه حساب کیږي، نو د هر سکرین، کوډ او شمیره متن په بشپړ ډول لګښت لري. د لګښت په کلک کریډیټونو کې دی، لږ تر لږه یو، نو هر غوښتنې ته د معياري توازن په اړه لږ تر لږه 10 وړیا ټکینونه یا 100 ټکینونه په پرو کې اړتیا لري ترڅو پیل شي. یوازې د واقعي لګښت لګښت لګښت کیږي؛ د نورو په پایله کې 402 insufficient_balance د غلطی واقعې، او هغه څه چې جوړ شوی کیدی شي. که د واقعي لګښت ډیر دی چې د توازن کولی شي ورکړي، ټول توازن په لټه کې وي، د بل لګښت دی (owed_sats په nymbot Object، او د منفي توازن). هغه څه چې اړتيا لري لومړی له راتلونکي کریډیټونو څخه سپارل کیږي چې د توازن ته ورسيږي. تر هغه چې سپارل کیږي، د دې توازن کې هیڅ څه نه کولی شي سپارل شي: نه د API، په اپلیکیشن کې ځوابونه، یو انتقال یا یو هدیه.
• نه ډیری کریډیټ. که د توازن کولی شي د ساتنې پوښښ نه وي، دا غوښتنلیک د 402 مخکې له هر څه چلند. د غلطۍ وايي چې د توازن مختصر دی، د غوښتنلیک ته کتنه اړتیا لري او څومره وړيا دي. د کوچني max_tokens معنی د کوچني ساتنې.
• د ناکامۍ د غوښتنلیک چې ناکام نه وي، که څه هم د پلورونکي د هغه کار لپاره چې هغه یې مخکې ترسره کړ، یا د ویب څیړنې یا د بریالیتوب لپاره لګښت لري. nymbot/auto دا هغه څه دی چې تاسو کولی شئ ورکړئ، لږ تر لږه 0.05 کریډیټ. د ټوکنونو لپاره چې تاسو کولی شئ د پلورونکي راپور ورکړئ کیدی شي: Nymbot د پلورونکي د ټوکن څخه تر 25 ثانیو پورې لټون کوي کله چې تاسو کولی شئ دا حساب ترلاسه کړئ. که دا نه وي، دا کیدی شي د هغه څه څخه چې تاسو سپارښتنه کړې او هغه څه چې لیکل شوي وي، او د دې دلیلونو لپاره دا د ټوکن په بشپړه توګه شامل دي. هغه غوښتنلیک چې د اړیکو په پایله کې ښودل کیږي او کیدی شي.
• WEB څیړنه په هر وخت کې چې د څیړنې کارول کیږي، دا $ 0.008 لګښت لري، په sats کې بدل کیږي، که څه هم د ماډل وروسته ځواب کوي یا ناکام کیږي. هغه صفحات چې دا لوستل کیږي هم د ماډل ته د انټرنټ په توګه سپارل کیږي، نو دوی خپل ټکینونه اضافه کوي.

هر ځواب ښکاري چې دا څه ارزښت لري. JSON ځوابونه د nymbot د موضوع سره د بیلابیلو چې له هغه څخه ورکړل شو، د کریډیټونو او satsونو په لګښت، او هغه څه چې لوړه ده:

د لګښت Object

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

د سپارلو ځوابونه هم د دې مخونه لري، کوم چې دا دی چې د JSON نه ځوابونو لګښت، لکه خبرې کولو لپاره چمتو کیږي:

د ملیون ټکینونو په اړه نرخونه، چې د فیس او margin شامل دي، په د نمونوي لیست په ډالرو او sats، او په د قیمت پاڼهکه د بیتکوین بیه نه ښودل شي، د پلټنې غوښتنو ته ورسیږي 503 price_unavailable سره Retry-After: 60 په بڼه کې د اندازې په پرتله.

د غلطو

هر غلطۍ ورته شکل لري، کوم چې د OpenAI کلینټونه اوس هم درکوي. code دا یو ثابته نوم دی چې تاسو کولی شئ په لټه کې وي. message دا د خلکو لپاره دی او ممکن بدل شي.

د بدن غلط

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

دوو استثناوو:

• /api/v1/messages په Anthropic د غلطۍ فورمټ کې ځوابونه، ځکه چې دا دا دی چې Anthropic مشتریانو د پوښتنو: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. د ډول په حالت کې پیژندل کیږي: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error یا overloaded_error (503).
• د سټراییم غوښتنلیک چې د لومړي بټ څخه مخکې ناکام کیږي د JSON غلطی سره د اوبو حالت، نه یو واقعیت سټرایم ترلاسه کوي. د سټرایم پیل وروسته یو ناکام دی چې د سټرایم وروستۍ واقعیت په توګه، د دې پای ته خپل فورم کې سپارل کیږي.

د بریښنا پیغامونه هیڅکله د نورو خدمتونو داخلي معلوماتو نلري. د پلورونکي خپل بریښنا د تاسو ته ورسیږي دمخه بدل کیږي.

محدودیتونه

د انځور لپاره د لینک باید د یو عام میزبان ته اشاره وکړي: په یو انفرادي یا محلي شبکې کې، یا د Nymbot په خپل سایټونو کې، یو پته راټول کیږي. د پلورونکي ګامونه چې په اپلیکیشن کې کارول کیږي دلته هم کارول کیږي، نو د یو پلورونکي ته د غوښتنو د بریالیتوب کولی شي د ناکام کولو په پرتله کم شي.

هغه څه چې د API کولای شي وګورئ

د API په توګه د اپلیکیشنونو په توګه خوندي نه ده، او دا ارزانه ده چې دقیقا څنګه وي.

• دا نه په پای کې مخکښ دی. په اپلیکیشنونو کې، یو پیغام ستاسو په وسایلو کې د کلیدونو ته مخکښ کیږي چې یوازې Nymbot لري او په توګه سفر کوي. د سپارلو. د API غوښتنلیک عادي HTTPS دی: دا د Nymbot ته د سفر په لاره کې کوډ شوی دی، او د Nymbot سرور دا په چټکۍ سره وګورئ چې دا کارول کیږي.
• د سپارلو او ځوابونه خوندي نه دي. دوی ته د نمونوي ته ورسیږي او ځواب ته ورسیږي. هغه څه چې خوندي دي د حساب دی: د هر غوښتنې لپاره د وخت، نمونوي، ډول، ټکین شمیره، لګښت، توازن، کلید او که دا بریالیتوب وه، د 90 ورځو لپاره، کوم چې دا څه ده د تاریخ په اړه د ورته غوښتنې د کارولو ریکارډ (د وخت، ډول، موډل، ټکین شمیره، لګښت، اوږدوالی او که دا د ویب څیړنې کارول یا بریالیتوب شوی) هم د 90 ورځو لپاره، د اپلیکیشن د خپل سره هم ساتل کیږي.
• د نیم لپاره د نورو ټولې اړتیاوې کوچنی دي او دلته لیست شوي. د API کلیدونه په توګه د هش، نه د کلیدي، سره د دوی نوم، یو مختصر لارښوونې، لګښت cap، reset دوره، د پایلو او کله چې دوی جوړ شوي دي او د وروستيو کارول؛ یوازې د نوي 50 لګښت شوي کلیدونه خوندي دي. اتومات Top-up د ویډیو کارونه د 24 ساعتونو لپاره ذخیره شوي دي. د تماس په لټه کې ورکړل شوي غوښتنلیکونه یوازې د 7 ورځو لپاره د لوښی د پیسو هش لپاره او د 30 ورځو لپاره د لوښی د سپارلو ټکین لپاره خوندي دي، د نه NIM سره تړاو لري. د بیلابیلو لګښتونه د لوښی په لټه کې د لګښت په لټه کې د لګښت په لټه کې د لګښت په لټه کې رسیږي.
• د اپلیکیشن پاکول کول. A د موټر Wipe د هر API کلید واخلئ، او د پوښتنې تاریخي، د کارولو ریکارډونه، د پولادو د اړیکو او ویډیو کارونه واخلئ. د توازن او هر اړونده لګښتونه به په لټه کې وي.
• د نمونوي عرضه ستاسو د غوښتنې وګورئ، لکه څنګه چې دا د اپلیکیشن څخه کار کوي. د کاتالوژۍ ماډلونه په خپل جوړونکو کې کارول کیږي؛ معياري ریلونه او انډولونه په Cloudflare کې کارول کیږي.
• د تولید شوي رسنیو عام دي. انځورونه او ویډیوونه چې د لینکونو په توګه وړاندې شوي دي د Blossom فایبر هټۍ ته اپلوډ شوي دي، په کوم ځای کې د فایبر پته د hash دی. هر څوک چې د لینک لري، کولی شي دا وټاکل شي، او Nymbot کولی شي دا ډاونلوډ نه کړي. د پوښتنې لپاره b64_json او د توليد شوي انځور په ځواب کې راټول کیږي او هیڅکله اپلوډ نه کیږي.
• همدارنګه د انځورونه چې تاسو د جنراتور ته ورکړئ. یو انځور چې تاسو upload ته نندارتونیا د A په توګه ارسال کړئ data: په یو جنراتور کې URL image_url، په لومړي توګه د يو عام Blossom میزبان ته اپلوډ کیږي نو د جنراتور کولی شي دا ترلاسه کړي، او دا هم د هغه په اړه د دې په اړه. https:// عکسونه په چټک غوښتنې کې به د نمونوي عرضه کوونکي ته ورسیږي، نه Blossom.
• یو کلید د خپل نیم سره تړل کیږي. هر څه چې یو کلید لګوي د خپل نیم توازن څخه رامینځته کیږي، نو API کارول نه ده انیمیشنونهکه تاسو غواړئ د API کارولو ستاسو د ورځني نیم څخه جدي وي، د خپل ځان د توازن سره د مختلف نیم څخه کلیدونه جوړ کړئ.

که تاسو د اپلیکیشنونو د ساتنې ته اړتیا لرئ، د اپلیکیشنونو کاروئ. د API د هغه وخت لپاره دی چې تاسو په خپل وسایلو کې د ماډلونو ته اړتیا لرئ.

هر Endpoint

“Nym&rdquo؛ معنی لري چې ستاسو د Nostr کلید لخوا دستخط شوي، په د حساب ورکولو غوښتنلیکد وسایلو لپاره چې په دې فارمونو کې شتون لري، وګورئ وسایل او SDKs، او د کوډینګ ایجنټونو لکه کوډ، کوډکس او کلین، وګورئ د coding وسایلو.