علم کی بنیاد ڈویلپرز
اے پی آئی کا جائزہ
ماڈل، جنریٹرز اور توازن آپ کو ایپ میں استعمال کرتے ہیں، اپنے کوڈ سے. API OpenAI اور Anthropic فارمیٹس سے بات کرتا ہے، لہذا زیادہ تر آلات اور SDKs ایک بنیادی URL اور ایک کلید کو تبدیل کرکے کام کرتے ہیں.
یہ صفحہ سہولت کے لیے مشین سے ترجمہ کیا گیا ہے۔ انگریزی اصل وہ ورژن ہے جو لاگو ہوتا ہے۔
API کیا ہے
ایک HTTP API آن ہے nymbot.ai جو اوپن اے آئی یا اینتھروپک کلائنٹ کی بھیجی ہوئی درخواستوں کا جواب دیتا ہے۔ آپ کو ملتا ہے:
- CHAT مکمل کریں→ The جوابات API اور Anthropic پیغام، سٹریمنگ، آلات، تصاویر، سوچ اور ویب تلاش کے ساتھ، ہر ماڈل کے لئے کیتالیف اور نیمبوٹ کے اپنے آٹو روٹنگ کے لیے۔
- تصاویر, ویڈیو, تقریر, ٹرانسمیشن اور داخلہ.
- آپ کا توازن, لائٹننگ ٹاپ اپس, آپ کے بٹوے سے خودکار ٹاپ اپ اور A تاریخ ہر درخواست کی قیمت کے بارے میں
ایک ہی دو میں سے ادا کیا جاتا ہے توازن اپلی کیشن کے طور پر، اسی قیمت پر. API پر کوئی سائن اپ اور کوئی مفت اجازت نہیں ہے: ہر درخواست آپ کی خریداری کے کریڈٹ سے ادا کی جاتی ہے.
اے پی آئی جو نہیں کرتا وہ یہ ہے کہ نمبوٹ کی اپنی کوئی بھی چیز شامل کریں۔ آپ کے پیغامات ماڈل پر جاتے ہیں جیسے ہی آپ انہیں بھیجتے ہیں: کوئی نمبوٹ سسٹم پرامپٹ نہیں، کوئی میموری نہیں، کوئی تاریخ یا زبان کے اشارے نہیں۔ جو واپس آتا ہے وہ ماڈل کا جواب اور اس کی قیمت کا ایک نوٹ ہے۔
بنیادی URLs
| استعمال کریں | بنیادی URL |
|---|---|
| OpenAI SDKs اور OpenAI متوافق آلات | https://nymbot.ai/api/v1 |
| انتھروپک ایس ڈی کے اور کلاڈ کوڈ | https://nymbot.ai/api (SDK شامل کریں) /v1/messages خود) |
ہر نقطہ زندگی کے تحت ہے /api/v1/ایک نامعلوم راستہ واپس آتا ہے 404 اور غلط طریقہ کار کے ساتھ کال کیا گیا ایک معروف راستہ واپس آتا ہے 405JSON کے طور پر.
API کسی بھی سائٹ سے cross-origin درخواستوں کا جواب دیتا ہے، لہذا ایک براؤزر صفحہ اسے کال کرسکتا ہے. جو بھی آپ ایک براؤزر کو بھیجتے ہیں وہ اسے کھولنے والے شخص کی طرف سے پڑھ سکتے ہیں، لہذا صرف ایک کلید کے ساتھ ایسا کریں جس میں ایک چھوٹا سا کلید ہے. کیپآپ کے نیم کے ساتھ دستخط شدہ اختتامی نکات (چابیاں، اکاؤنٹ کا خلاصہ، این ڈبلیو سی آٹو ٹاپ اپ اور ریفنڈ ریڈیمپشن) مستثنی ہیں: براؤزر میں وہ صرف نیمبوٹ کی اپنی سائٹوں کا جواب دیتے ہیں۔ دیکھیں اکاؤنٹ کی درخواستوں پر دستخط کرنا.
ہر جے ایس او این باڈی کو اس کے ساتھ بھیجیں Content-Type: application/jsonکسی بھی دوسری قسم کے ساتھ انکار کر دیا جاتا ہے 415، تو ایک سادہ ایچ ٹی ایم ایل فارم یا ایک text/plain کسی دوسری سائٹ سے درخواست اے پی آئی تک نہیں پہنچ سکتی۔ سی یو آر ایل کے ساتھ، پاس کریں
-H "Content-Type: application/json" اس کے ساتھ -d.
API کلید
کلیدیں اپلی کیشن میں بنائی جاتی ہیں.Open آگ ویب ایپ کے سائیڈ بار میں، یا اینڈرائیڈ اور آئی او ایس کے مینو میں، اور ٹیپ کریں کلید بنائیںاسے ایک نام اور، اگر آپ چاہتے ہیں، ایک cap اور ایک اختتام کی تاریخ بتائیں.
کلید ایک بار دکھایا جاتا ہے. اس کو بند کرنے سے پہلے اسے محفوظ جگہ پر کاپی کریں: Nymbot صرف اس کا ایک انگوٹھا نشان رکھتا ہے، لہذا یہ آپ کو دوبارہ ظاہر نہیں کرسکتا ہے. ایک کھو گیا کلید کو واپس نہیں کیا جا سکتا ہے؛ اسے منسوخ کریں اور ایک اور بنائیں.
ایک چابی اس طرح نظر آتی ہے sk-nymbot- اس کے بعد 43 خطوط، اعداد و شمار، ڈش اور underscores.The app lists each key by its name and a short hint such as
sk-nymbot-Qm7x…c2Lw.
- ایک چابی آپ کے نیم سے تعلق رکھتی ہے۔ یہ آپ کے توازن خرچ کرتا ہے، اور صرف آپ کے نیم اسے بنانے، تبدیل یا منسوخ کر سکتے ہیں.
- کیپس سیٹس میں ہیں۔ ایک کلید ایک خرچ کی حد ہوسکتا ہے، اور کیپ ہر دن، ہر ہفتے (نومبر) یا ہر ماہ (پہلے) 00:00 UTC پر دوبارہ قائم کر سکتے ہیں. یہ دونوں توازن، ایک معیاری کریڈٹ کے طور پر 10 sats اور ایک پرو کریڈٹ کے طور پر 100 کے طور پر شمار کیا جا سکتا ہے، لہذا اس کا مطلب یہ ہے کہ ایک درخواست خرچ کرتا ہے جس میں ایک ہی توازن ہے.
403key_limit_reached، یہاں تک کہ اگر جواب کیپ کے نیچے آتا۔ غلطی بتاتی ہے کہ کیپ کتنی رہ گئی ہے اور کب ری سیٹ ہوتی ہے۔ لوورنگmax_tokensاس بدترین صورت حال کو کم کرتا ہے۔ ایک درخواست پر وہی معاوضہ لیا جاتا ہے جو اس کی اصل قیمت ہوتی ہے اور جو کیپ کے خلاف شمار ہوتا ہے، لہذا اگر فراہم کنندہ اس سے زیادہ ٹوکن کی اطلاع دیتا ہے جو الگ رکھے گئے تھے، تو آخری درخواست جو فٹ ہوتی ہے وہ کلید کو اس کی کیپ سے تھوڑا آگے لے جا سکتی ہے۔ پھر اگلے کو مسترد کر دیا جاتا ہے۔ - خرچ شدہ کیپ صرف خرچ کو روکتی ہے۔ اس کی ٹوپی پر ایک کلید اب بھی بیلنس چیک کر سکتی ہے، اس کی ہسٹری پڑھ سکتی ہے، ماڈلز کی فہرست بنا سکتی ہے، ٹوکن شمار کر سکتی ہے، ٹاپ اپ کر سکتی ہے اور اس ویڈیو کو چیک کر سکتی ہے جو اس نے پہلے ہی شروع کر دی ہو۔
- میعاد ختم ہونا اختیاری ہے۔ آپ کی تاریخ مقرر کرنے کے بعد، کلید کام کرنے سے روکتا ہے.
- منسوخ کرنا فوری اور حتمی ہے۔ ایک منسوخ کلید اس کے اگلے درخواست کو ناکام کرتا ہے. یہ فہرست میں رہتا ہے، منسوخ کر دیا گیا ہے، لہذا اس کے خرچ کی تاریخ اب بھی معقول ہے.
- آپ کے پاس 25 تک فعال چابیاں ہو سکتی ہیں، جن میں سے ہر ایک کا اپنا نام ہے۔ چابی کی ری سیٹ مدت کو تبدیل کرنے سے صفر پر ایک نیا پیریڈ شروع ہوتا ہے۔
ایک ہی شیٹ ہر کلید کے اس مدت کے اخراجات کو ظاہر کرتی ہے اور مجموعی طور پر، جب اسے آخری بار استعمال کیا گیا تھا، آپ کے بیلنس اور آپ کی حالیہ API درخواستیں دونوں۔ اس کے پیچھے کے اختتامی نکات درج ذیل ہیں۔ کلیدوں کا انتظام کرنا.
ایک درخواست کی تصدیق
ان میں سے کسی بھی ہیڈر میں کلید بھیجیں۔ وہ مساوی ہیں، اس لیے جو بھی آپ کا کلائنٹ ڈیفالٹ کے طور پر بھیجے اسے استعمال کریں:
| ہیڈر | کی طرف سے |
|---|---|
Authorization: Bearer sk-nymbot-… | اوپن اے آئی ایس ڈی کے، زیادہ تر ٹولز، کلاڈ کوڈ کے ساتھ ANTHROPIC_AUTH_TOKEN |
x-api-key: sk-nymbot-… | انتھروپک ایس ڈی کے |
api-key: sk-nymbot-… | ازور طرز کے کلائنٹ |
ایک غائب، نامعلوم، منسوخ یا ختم ہونے والے کلید کی واپسی 401کوڈ کے ساتھ
missing_api_key, invalid_api_key, revoked_api_key یا
expired_api_keyفہرست ماڈل، آڈیو ماڈل اور آواز، اور ادائیگی کے طریقوں کو کوئی کلید کی ضرورت نہیں ہے.
تصاویر، ویڈیوز، باتیں، ٹرانسپیشن اور داخلات بھی ایک وقت میں ایک درخواست کے لئے Lightning پر کسی بھی کلید کے بغیر ادا کیا جا سکتا ہے: ایک کے بغیر درخواست بھیجیں اور اکاؤنٹ میں ادائیگی کریں 402 جواب دیں۔ دیکھیں۔ ایک کلید کے بغیر درخواست پر ادائیگی.
کلیدی انتظام، اکاؤنٹ کا خلاصہ اور خودکار ٹاپ اپ مستثنی ہیں: وہ کلید کے بجائے آپ کے این آئی ایم سے دستخط لیتے ہیں، لہذا لیک ہونے والی کلید مزید کلیدیں نہیں بنا سکتی۔ اکاؤنٹ کی درخواستوں پر دستخط کرنا.
آپ کی پہلی درخواست
کلید کو ماحولیاتی متغیر میں رکھیں، پھر کسی ماڈل سے کچھ پوچھیں۔ ان صفحات میں موجود مثالیں اسے یہاں سے پڑھتی ہیں 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 نمبوٹ کی اپنی روٹنگ ہے، جو معیاری بیلنس سے ادا کی جاتی ہے۔ اس کے بجائے وہاں کیٹلاگ ماڈل کی آئی ڈی رکھیں، جیسے کہ anthropic/claude-sonnet-5، اس ماڈل کو پرو توازن سے استعمال کرنے کے لئے. نمونوں کی فہرست سازی ہر آئی ڈی دیتا ہے۔
درخواست کی قیمت کتنی ہے
اے پی آئی بالکل اسی طرح بل کرتا ہے جس طرح ایپ کرتی ہے۔
- کیا توازن ہے
nymbot/autoخرچ کرتا ہے معیاری balance (10 sats a credit). ہر دوسرے چیٹ ماڈل خرچ کرتا ہے پرو بیلنس (100 سیٹس ایک کریڈٹ)۔ معیاری امیج جنریٹر اور معیاری آواز معیاری کریڈٹ خرچ کرتی ہے۔ ہر دوسرا جنریٹر پرو خرچ کرتا ہے۔ ایمبیڈنگز معیاری کریڈٹ خرچ کرتی ہیں۔ ٹرانسکرپشن معیاری کریڈٹ خرچ کرتی ہے جب معیاری بیلنس اس کا احاطہ کر سکتا ہے، اور پرو کریڈٹ بصورت دیگر۔ ماڈلز کی فہرست بتاتی ہے کہ ہر ماڈل کے اخراجات میں کون سا توازن ہے۔ - کتنا ہے ایک چیٹ کی درخواست کو ماڈل کی اصل میں پڑھنے اور لکھنے والے ٹوکن پر میٹر کیا جاتا ہے، فراہم کرنے والے کی شائع قیمتوں پر. اس قیمت میں 5٪ فیس شامل ہے اور پھر 1.5 کے ساتھ متغیر کی جاتی ہے، لہذا آپ فراہم کرنے والے کی فہرست کی قیمت کے 1.575 گنا ادا کرتے ہیں. یہ لائیو ویکیپیڈیا کی قیمت پر sats میں تبدیل کیا جاتا ہے اور ایک کریڈٹ کے ہزاروں میں چارج کیا جاتا ہے. پرو تصاویر، ویڈیوز اور باتیں ہر نسل، فی سیکنڈ یا ہر حروف، اور آڈیو کے سیکنڈ پر ٹرانسپیشن، اسی فیس اور مارجن کے ساتھ. معیاری تصویر ایک فلیٹ 5 معیاری کریڈٹ ہے اور معیاری آواز ایک فلیٹ 3 ہے.
- کم از کم۔ ہر متغیر درخواست جو کم از کم 0.05 کریڈٹ کی لاگت کرتا ہے: معیاری توازن پر نصف، پرو پر 5 سیٹ.
- ٹھہرو، پھر ٹھہرو۔ درخواست چلانے سے پہلے، اس کی زیادہ سے زیادہ قیمت آپ کے بیلنس سے لی جاتی ہے، اس کی بنیاد اس بات پر کہ آپ نے کیا بھیجا ہے اور سب سے زیادہ ٹوکن جو وہ لکھ سکتا ہے۔ سادہ اے ایس سی آئی آئی کے باہر کا متن اس کے یو ٹی ایف-8 بائٹس سے سائز کا ہوتا ہے، اور اے ایس سی آئی آئی کے ہندسوں اور پنکچوایشن کو ٹوکن کے طور پر شمار کیا جاتا ہے، لہذا کسی بھی اسکرپٹ، کوڈ اور نمبروں میں متن کو مکمل طور پر رکھا جاتا ہے۔ ہولڈ پورے کریڈٹ میں ہوتا ہے، کم از کم ایک، لہذا کسی بھی درخواست کو شروع کرنے کے لیے معیاری بیلنس پر کم از کم 10 سیٹس مفت یا پرو پر 100 سیٹس درکار ہوتے ہیں۔ صرف اصل لاگت وصول کی جاتی ہے۔ باقی اس کے ختم ہونے پر جاری کیا جاتا ہے۔ ایک طویل درخواست اس وقت تک برقرار رہتی ہے جب تک کہ یہ چلتا ہے۔ اگر ہولڈ کریڈٹ ویسے بھی دستیاب ہونا بند ہو جاتے ہیں تو، ایک اسٹریم اس کے ساتھ رک جاتا ہے۔
402insufficient_balance ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسے ،جیسowed_satsمیںnymbotموضوع، اور منفی توازن). جو ادا کیا جاتا ہے سب سے پہلے اس توازن تک پہنچنے والے اگلے کریڈٹ سے ادا کیا جاتا ہے. جب تک یہ ادا نہیں کیا جاتا ہے، اس توازن پر کچھ بھی خرچ نہیں کیا جا سکتا: API کی طرف سے نہیں، اپلی کیشن میں جوابات، ایک ٹرانسفر یا ایک تحفہ. - کافی کریڈٹ نہیں اگر باقی رہائشی کی ادائیگی نہیں ہوسکتی ہے تو، درخواست سے انکار کیا جاتا ہے
402کسی بھی چیز کو چلانے سے پہلے غلطی یہ بتاتا ہے کہ کس توازن مختصر ہے، درخواست کی ضرورت کتنی سیٹ ہے اور کتنی مفت ہیں.max_tokensاس کا مطلب ہے چھوٹی گرفت۔ - ناکامیاں ایک درخواست جو ناکام ہوتی ہے، کوئی قیمت نہیں ہے، اگرچہ سپلائر نے اس سے پہلے کام کرنے کے لئے چارج کیا ہے، یا ایک ویب تلاش یا
nymbot/autoٹاسک چیک پہلے ہی چل چکا تھا۔ پھر یہ وہی ہے جو آپ ادا کرتے ہیں، کم از کم 0. 05 کریڈٹ۔ ایک اسٹریم جسے آپ کاٹ دیتے ہیں اس سے ٹوکن کے لیے معاوضہ لیا جاتا ہے جو فراہم کنندہ رپورٹ کرتا ہے: نمبوٹ آپ کے جانے کے بعد 25 سیکنڈ تک فراہم کنندہ کے اسٹریم کو پڑھتا رہتا ہے اس گنتی کو حاصل کرنے کے لیے۔ اگر یہ نہیں پہنچتا ہے تو، چارج کا تخمینہ آپ کے بھیجے ہوئے اور جو لکھا گیا تھا اس سے لگایا جاتا ہے، اور اس ماڈل کے لیے جس کی وجہ سے اس میں ہولڈ کا پورا آؤٹ پٹ الاؤنس شامل ہوتا ہے۔ ایک درخواست جس کا کنکشن ڈراپ ہو جاتا ہے اب بھی ختم ہو جاتا ہے اور چارج کیا جاتا ہے۔ - ویب سرچ ایک تلاش کی قیمت $0.008 ہے، جسے سیٹس میں تبدیل کیا جاتا ہے، جب بھی کوئی تلاش چلتی ہے، چاہے ماڈل اس کا جواب دے یا ناکام ہو۔ اس کے ذریعے پڑھے جانے والے صفحات بھی ماڈل کو ان پٹ کے طور پر بھیجے جاتے ہیں، لہذا وہ اپنے ٹوکن شامل کرتے ہیں۔
ہر جواب یہ بتاتا ہے کہ یہ کتنا خرچ کرتا ہے۔ JSON جوابات ایک nymbot اعتراض اس بیلنس کے ساتھ جس سے اسے ادا کیا گیا تھا، کریڈٹ اور سیٹس میں چارج، اور کیا بچا ہے:
لاگت آبجیکٹ
"nymbot": {
"balance": "pro",
"charged_credits": 0.162,
"charged_sats": 16.2,
"balance_credits": 412.425,
"balance_sats": 41242.5
}
ادا شدہ جوابات میں یہ ہیڈر بھی ہوتے ہیں، جہاں جے ایس او این نہ ہونے والے ردعمل کی قیمت تلاش کی جا سکتی ہے، جیسے تقریر:
| ہیڈر | معنی |
|---|---|
X-Nymbot-Cost-Sats | اس درخواست کی قیمت کتنی ہے، sats میں. |
X-Nymbot-Balance-Sats | بقایا پر جو کچھ بچا ہے اسے سیٹوں میں ادا کیا گیا تھا۔ |
X-Request-Id | درخواست کے لئے ایک ایڈ، ہر جواب پر. اگر آپ سپورٹ سے رابطہ کرتے ہیں تو اس کا حوالہ کریں. |
فی ملین ٹوکن کی شرحیں، جن میں پہلے سے ہی فیس اور مارجن شامل ہیں، میں ہیں
ماڈلز کی فہرست ڈالر اور سیٹس میں، اور
قیمت کی شیٹاگر Bitcoin قیمت نہیں پڑھی جا سکتی ہے، ادائیگی کی درخواستوں کی واپسی 503 price_unavailable کے ساتھ
Retry-After: 60 اندازہ لگانے کے بجائے۔
غلطیاں
ہر غلطی کی شکل ایک جیسی ہوتی ہے، جسے اوپن اے آئی کلائنٹ پہلے ہی سمجھ چکے ہوتے ہیں۔ 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
}
}
| حیثیت | جب |
|---|---|
400 invalid_request_error | باڈی درست جے ایس او این نہیں ہے (invalid_json)، ایک مطلوبہ فیلڈ غائب ہے (missing_required_parameter)، ایک ویلیو غلط ہے، یا درخواست کچھ ایسی چیز کے لیے پوچھتی ہے جو ماڈل یا اینڈ پوائنٹ نہیں کرتا ہے، جیسے کہ ٹولز آن nymbot/auto (unsupported_tool). param کھیت کے نام بتائیں۔ upstream_rejected جب فراہم کنندہ نے درخواست کو مسترد کر دیا۔ |
401 authentication_error | کلید کھو گیا ہے، نامعلوم ہے، منسوخ یا ختم ہو گیا ہے، یا ایک دستخط درخواست مسترد ہے یا دوبارہ استعمال کیا گیا ہے. |
402 insufficient_quota | درخواست کی ادائیگی نہیں کی جاسکتی۔ کوڈ insufficient_balanceکے ساتھ balance, required_sats اور balance_sats. |
403 permission_error | درخواست کلید کی ٹوپی کے مطابق نہیں ہے (key_limit_reachedکے ساتھ limit_sats, used_sats اور reset_at)، یا اکاؤنٹ سروس استعمال نہیں کر سکتا ہے (account_denied). |
404 not_found_error | ایک نامعلوم راستہ (unknown_endpoint)، جس میں کوئی نمونہ نہیں ہے (model_not_found)، یا کوئی نامعلوم کلید، انوائس یا ویڈیو۔ |
405 | یہ طریقہ موجود ہے لیکن اس طریقہ کار کے ساتھ نہیں (method_not_allowed) دی۔ Allow Header اس کے استعمال کے طریقوں کی فہرست کرتا ہے. |
413 | باڈی یا فائل بہت بڑی ہے (payload_too_large, file_too_large)، یا ریکارڈنگ بہت لمبی ہے (audio_too_long) دیکھیں۔ حدود. |
415 invalid_request_error | لاش کو اس طرح نہیں بھیجا جاتا ہے application/json (یا، اپ لوڈ کے اختتامی نکات کے لیے، multipart/form-data): unsupported_media_type. |
422 | ایک لفظ اور زبان جو متن میں بات کرنے کے لئے ایک ساتھ نہیں جا رہے ہیں (voice_language_mismatch, unsupported_language). |
429 rate_limit_error | بہت سے درخواستیں اس کلید پر، اس ایڈریس سے، یا اس کی تصدیق کرنے کے قابل نہیں ہے کہ تصدیق کے ساتھ (rate_limit_exceeded)، یا فراہم کنندہ شرح کو محدود کر رہا ہے (upstream_rate_limited )۲آگے ،آگے ،آگے Retry-After. |
500 api_error | Nymbot کی طرف سے کچھ غلط ہو گیا (internal_error). |
502 api_error | اس نے جواب نہیں دیا (upstream_error)، یا بجلی کا انوائس نہیں بنایا جا سکا (invoice_unavailable). |
503 api_error | فراہم کنندہ اوورلوڈ ہے (upstream_overloaded)، بٹ کوائن کی قیمت نہیں پڑھی جا سکتی (price_unavailable)، یا سروس کا ایک حصہ نیچے ہے (service_unavailable, media_hosting_unavailable). Retry-After کہتا ہے جب دوبارہ کوشش کرنے کے لئے، جہاں یہ جانا جاتا ہے. |
دو مستثنیات:
/api/v1/messagesAnthropic کی غلطی فارمیٹ میں جوابات، کیونکہ یہ ہے کہ 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).- ایک اسٹریمنگ درخواست جو اپنے پہلے بائٹ سے پہلے ناکام ہو جاتی ہے اسے اوپر کی حیثیت کے ساتھ ایک عام جے ایس او این غلطی ملتی ہے، ایونٹ اسٹریم نہیں۔ اسٹریم شروع ہونے کے بعد ناکامی اس اینڈ پوائنٹ کی اپنی شکل میں اسٹریم کے آخری ایونٹ کے طور پر بھیجی جاتی ہے۔
غلطی کے پیغامات میں کسی دوسرے سروس کے اندرونی تفصیلات کبھی نہیں ہیں. ایک فراہم کنندہ کی اپنی غلطی آپ تک پہنچنے سے پہلے دوبارہ ترمیم کی جاتی ہے.
حدود
| حد بندی | قدر |
|---|---|
| کلید کی درخواستیں | 120 فی منٹ۔ اس سے اوپر، 429 کے ساتھ Retry-After. |
| کلید کے بغیر درخواستیں | 120 فی منٹ فی پتہ، ماڈل، آڈیو اور ادائیگی کے طریقہ کار کی لسٹنگ، ریفنڈ ٹوکن چیک، اور بغیر چابی یا ادائیگی کے کال کیے گئے اینڈ پوائنٹ کے لیے۔ اس کے اوپر، 429 کے ساتھ Retry-After. |
| تصدیق ناکام | چابیاں، دستخط، ادائیگی کی اسناد اور رقم کی واپسی کے ٹوکن کے لیے 30 فی منٹ فی پتہ جو تصدیق نہیں کرتے ہیں۔ اس کے علاوہ، اس پتے سے ہر درخواست جس میں اسناد ہوتی ہے اسے مل جاتا ہے۔ 429 کے ساتھ Retry-After جب تک کہ منٹ ختم ہو جاتا ہے.آدمیات کو پڑھنے سے پہلے چیک کیا جاتا ہے. |
| نئے کلید | 60 فی گھنٹہ اور 120 فی گھنٹہ فی ایڈریس. |
| Top-up اکاؤنٹس | 60 فی گھنٹہ اور 120 فی گھنٹہ فی ایڈریس. |
| این ڈبلیو سی والیٹ کنکشن | 10 ایک گھنٹہ فی NM اور 30 ایک گھنٹہ فی ایڈریس. wss:// ایک معیاری بندرگاہ پر |
| ریفنڈ ٹوکن | 60 درخواستیں فی منٹ فی ٹوکن۔ |
| ایڈریس | ایک IPv6 ایڈریس ہر ایڈریس کی حد میں اپنے کل /64 کے طور پر شمار ہوتا ہے، اور ایک IPv4 نقشہ IPv6 ایڈریس اس IPv4 ایڈریس کے طور پر. |
| JSON درخواست کے جسم | 4 ایم بی ؛ آپ کے این آئی ایم کے ساتھ دستخط شدہ درخواستوں کے لیے 64 کے بی۔ |
| ملٹی پارٹ ریکویسٹ باڈی (اپ لوڈ) | 32 MB. ایک تصویر کو ترمیم کرنے کے لئے 20 MB تک ہوسکتا ہے، ایک آڈیو فائل 25 MB تک ہوسکتا ہے. زیادہ سے زیادہ 64 حصوں میں، ہر ایک میں زیادہ سے زیادہ 8 KB کے حصوں کے عنوانات، اور 1 سے 70 حروف کی حد ہے؛ دوسری صورت میں 400 invalid_multipart. |
| ایک چیٹ کی درخواست میں تصاویر | 20. ہر ایک ایک ہے https:// یا http:// عوامی میزبان سے لنک کریں، یا data:image/… یو آر ایل۔ |
| نسل کی درخواست کے مطابق تصاویر | 1 سے 4 (n) |
| آؤٹ پٹ ٹوکن | ماڈل کے اپنے زیادہ سے زیادہ پر احاطہ کرتا ہے۔ ایک بڑا max_tokens اس سے انکار نہیں کیا گیا ہے، اس سے انکار کیا گیا ہے. |
| گفتگو میں داخلہ | معیاری آواز کے لیے 800 حروف، آورا 2 کے لیے 2, 000۔ |
| ٹرانسفر | 30 منٹ کی آڈیو، 25 ایم بی۔ ایک طویل ریکارڈنگ کے ساتھ انکار کر دیا جاتا ہے 413 اور اس کی مدت کو نہیں جانتا، یہاں تک کہ جب اس کی لمبائی سننے کے بعد ہی سنا جاتا ہے. |
| سرایتات | ہر درخواست کے لئے 100 انٹرویو |
| ویڈیو کے کام | جمع کرانے کے بعد 24 گھنٹے کے لیے رکھا جاتا ہے ؛ ایک رینڈر ایک گھنٹے کے بعد چھوڑ دیا جاتا ہے۔ زیادہ سے زیادہ 10 رینڈرنگ ایک ہی وقت میں فی نیم۔ |
| استفسار کی تاریخ | 90 دن تک رکھا گیا۔ |
| فعال چابیاں فی نیم | 25۔ صرف تازہ ترین 50 منسوخ کلیدوں کو محفوظ کیا جاتا ہے. |
ایک تصویر کا لنک ایک عوامی میزبان کی طرف اشارہ کرنا چاہئے: ایک نجی یا مقامی نیٹ ورک پر ایک ایڈریس، یا Nymbot کے اپنے سائٹس پر انکار کیا جاتا ہے.
اے پی آئی کیا دیکھ سکتا ہے
اے پی آئی اس طرح سے نجی نہیں ہے جس طرح سے ایپس ہیں، اور یہ کس طرح کے بارے میں درست ہونے کے قابل ہے۔
- یہ اینڈ ٹو اینڈ انکرپٹڈ نہیں ہے۔ ایپس میں، آپ کے آلے پر ایک پیغام مہر بند کر دیا جاتا ہے جس میں صرف نیمبوٹ کی چابیاں ہوتی ہیں اور وہ ایک پیغام کے طور پر سفر کرتی ہیں۔ آؤٹ Wrapایک اے پی آئی درخواست عام ایچ ٹی ٹی پی ایس ہوتی ہے: یہ نمبوٹ کے راستے میں خفیہ شدہ ہوتی ہے، اور نمبوٹ کا سرور اسے سنبھالنے کے لیے اسے واضح طور پر پڑھتا ہے۔
- اشارے اور جوابات محفوظ نہیں کیے جاتے ہیں۔ وہ ماڈل کے ذریعے جاتے ہیں اور جواب واپس آتا ہے. جو محفوظ کیا جاتا ہے وہ اکاؤنٹ ہے: ہر درخواست کے لئے وقت، ماڈل، قسم، ٹوکن شمار، قیمت، توازن، کلید اور اگر یہ کامیاب ہوا، 90 دنوں کے لئے، یہ کیا ہے استفسار کی تاریخ آپ کو دکھاتا ہے۔ اسی درخواست (وقت، قسم، ماڈل، ٹوکن گنتی، لاگت، مدت اور چاہے اس نے ویب سرچ کا استعمال کیا ہو یا کامیاب ہوا ہو) کا استعمال ریکارڈ بھی ایپ کے اپنے ساتھ 90 دنوں کے لیے رکھا جاتا ہے۔
- ایک نیم کے لئے باقی سب کچھ چھوٹا ہے اور یہاں درج کیا گیا ہے. API کلید انہیں ہیش کے طور پر محفوظ کیا جاتا ہے، کبھی بھی کلید نہیں، ان کے نام کے ساتھ، ایک مختصر اشارہ، اخراجات کی حد، دوبارہ ترتیب دینے کی مدت، میعاد ختم ہونے اور انہیں کب بنایا گیا اور آخری بار استعمال کیا گیا۔ صرف تازہ ترین 50 منسوخ شدہ چابیاں رکھی جاتی ہیں۔ خودکار ٹاپ اپ بٹوے کے کنکشن کو انکرپٹ کیا جاتا ہے، اس کی حد، رقم اور آخری ٹاپ اپ کے نتیجے کے ساتھ۔ ویڈیو جابز کو 24 گھنٹوں کے لیے رکھا جاتا ہے۔ فی کال ادا کی گئی درخواستوں میں صرف 7 دن کے لیے لائٹننگ پیمنٹ ہیش اور 30 دن کے لیے ہیشڈ ریفنڈ ٹوکن چھوڑ دیا جاتا ہے، جو کوئی این آئی ایم سے منسلک نہیں ہوتا ہے۔ بقایا رقم کو اس وقت تک واجب الادا رکھا جاتا ہے جب تک کہ ٹاپ اپ ان کی ادائیگی نہ کرے۔
- اس اپلی کیشن کو ہٹا دیں. A آلہ مسح کریں ہر اے پی آئی کلید کو منسوخ اور حذف کرتا ہے، اور استفسار کی تاریخ، استعمال کے ریکارڈ، بٹوے کے کنکشن اور ویڈیو کے کاموں کو حذف کرتا ہے۔ بقایا رقم اور کوئی بھی چارج اب بھی این آئی ایم پر باقی رہتا ہے۔
- ماڈل کا فراہم کنندہ آپ کی درخواست دیکھتا ہےکیتالیف ماڈل ان کے کارخانہ داروں پر چلتے ہیں؛ معیاری راستے اور داخلات Cloudflare پر چلتے ہیں.
- پیدا شدہ میڈیا عوامی ہے. لنکس کے طور پر فراہم کردہ تصاویر اور ویڈیو کو عوامی بلوم فائل میزبانوں پر اپ لوڈ کیا جاتا ہے، جہاں کسی فائل کا پتہ اس کا ہیش ہوتا ہے۔ لنک والا کوئی بھی شخص اسے کھول سکتا ہے، اور نیمبوٹ اسے دوبارہ نیچے نہیں لے سکتا۔ طلب کریں
b64_jsonاور پیدا شدہ تصویر جواب میں واپس آتی ہے اور کبھی اپ لوڈ نہیں کی جاتی ہے۔ - وہ تصاویر جو آپ ایک جنریٹر فراہم کرتے ہیں. ایک تصویر جسے آپ اپ لوڈ کرتے ہیں
ترمیم کریںیا بھیجیں A
data:جنریٹر میں یو آر ایلimage_url، کو پہلے عوامی بلوم میزبان پر اپ لوڈ کیا جاتا ہے تاکہ جنریٹر اسے حاصل کر سکے، اور یہی اس پر لاگو ہوتا ہے۔https://ایک چیٹ درخواست میں تصاویر ماڈل کے سپلائر کے لئے جائیں گے، Blossom نہیں. - ایک کلید آپ کے این آئی ایم سے منسلک ہوتی ہے۔ ہر چیز جو ایک کلید خرچ کرتا ہے، آپ کے نیم کے توازن سے آتا ہے، لہذا API کا استعمال نہیں ہے. anonimo کےاگر آپ API استعمال کرنا چاہتے ہیں تو آپ کے روزانہ نیم سے جدا رہنا چاہئے، اپنے توازن کے ساتھ ایک منفرد نیم سے کلید بنائیں.
اگر آپ کو ایپس کے تحفظ کی ضرورت ہو تو ایپس کا استعمال کریں۔ اے پی آئی اس وقت کے لیے ہے جب آپ کو اپنے ٹولز میں ماڈلز کی ضرورت ہو۔
ہر اختتامی نقطہ
| اختتامی نقطہ | یہ کیا کرتا ہے | آؤٹ |
|---|---|---|
GET /api/v1/models | نمونوں کی فہرستیںقیمتوں کے ساتھ | کوئی نہیں |
POST /api/v1/chat/completions | CHAT مکمل کریں | کلید |
POST /api/v1/responses | جوابات API | کلید |
POST /api/v1/messages | Anthropic پیغام | کلید |
POST /api/v1/messages/count_tokens | input tokens کے مترادفات | کلید |
POST /api/v1/images/generations | تصاویر بناتا ہے | کلید یا بجلی گرتی ہے |
POST /api/v1/images/edits | تصویر میں ترمیم کریں | کلید یا بجلی گرتی ہے |
POST /api/v1/videos, GET /api/v1/videos, GET /api/v1/videos/{id} | ویڈیوز شروع کرتا ہے، فہرست بناتا ہے اور چیک کرتا ہے | کلید، یا بجلی گرتی ہے ایک شروع کرنے کے لیے |
POST /api/v1/audio/speech | تقریر سے متن | کلید یا بجلی گرتی ہے |
GET /api/v1/audio/models, GET /api/v1/audio/voices | آڈیو ماڈل اور آوازیں | کوئی نہیں |
POST /api/v1/audio/transcriptions, POST /api/v1/audio/translations | زبان میں الفاظ، اور انگریزی میں | کلید یا بجلی گرتی ہے |
POST /api/v1/embeddings | سرایتات | کلید یا بجلی گرتی ہے |
GET /api/v1/credits/balance (یا POST) | دونوں توازن | کلید |
GET /api/v1/topup/payment-methods | ادائیگی کے طریقے | کوئی نہیں |
POST /api/v1/topup/create/btc-lightning | لائٹنگ کی رپورٹ | کلید |
GET /api/v1/topup/status/{invoice_id} | چیک کریں اور کریڈٹ کریں | کلید |
GET /api/v1/queries/history | ہر درخواست کی قیمت کتنی ہے | Key یا NIM |
GET /api/v1/account | اکاؤنٹ کا خلاصہ | نیم |
/api/v1/keys | چابیاں بناتا ہے، تبدیل کرتا ہے اور منسوخ کرتا ہے | نیم |
/api/v1/nwc-auto-topup | خودکار ٹاپ اپس | نیم |
GET /api/v1/l402/refunds, POST /api/v1/l402/refunds/redeem | ریفنڈ ٹوکن کو چیک یا ریڈیم کرتا ہے | ریفنڈ ٹوکن ؛ چھڑانے کے لیے nym |
& ldquo; Nym & rdquo; کا مطلب ہے آپ کی نوسٹر کلید کے دستخط شدہ درخواست، جس میں بیان کیا گیا ہے اکاؤنٹ کی درخواستوں پر دستخط کرناان آلات کے لئے جو پہلے سے ہی ان فارمیٹس سے بات کر رہے ہیں، دیکھیں آلات اور SDKs، اور کلاڈ کوڈ، کوڈیکس اور کلائن جیسے کوڈنگ ایجنٹوں کے لیے، دیکھیں کوڈنگ ٹولز.