قاعدة المعرفة / المطورين

API نظرة عامة

تستخدم النماذج والإنتاجيات والتوازنات التي تستخدمها في التطبيق، من الكود الخاص بك، وتتحدث API إلى المكونات OpenAI و Anthropic، لذلك تعمل معظم الأدوات و SDK من خلال تغيير URL القائمة والمفتاح.

تمت ترجمة هذه الصفحة آليًا من أجل الراحة. النسخة الأصلية الإنجليزية هي النسخة التي تنطبق.

ما هي النار

تحميل HTTP API nymbot.ai يجيب نفس الطلبات التي يتم إرسالها بالفعل من قبل عميل OpenAI أو Anthropic.

• Chat التكامل، الـ ردود الفعل و رسائل إنسانية، مع التلفزيون، والأدوات، والصور، والتفكير، والبحث على شبكة الإنترنت، لكل نموذج في الكاتالوني و لخدمة Nymbot الذاتية.
• الصور, فيديو, الكلام, الترجمة و إبداعات.
• لك التوازن, الضوء Top-ups, اتصالات تلقائيا من محفظتك و a التاريخ ما تكلفه كل طلب.

يتم دفعها من نفس اثنين. التوازن كما هو الحال مع التطبيق ، على نفس الأسعار.لا توجد ترخيص ولا رسوم مجانية على API: يتم دفع كل طلب من الائتمان التي اشتريتها.

ما لا يفعل API هو إضافة أي شيء من Nymbot الخاص بك. رسائلك تنتقل إلى النماذج أثناء إرسالها: لا إشعار نظام Nymbot، لا الذاكرة، لا توضيحات تاريخية أو لغة.

قاعدة URL

كل نقطة حياة تحت /api/v1/طريق لا يعرفه يعود 404 ثم يعود الطريق المعروف الذي يسميه الطريق الخاطئ 405كلاهما مثل JSON.

يجيب API على طلبات الأرشيف من أي موقع ، بحيث يمكن لصفحة المتصفح إدخالها. كل ما تريد إرساله إلى متصفح يمكن قراءته من قبل أي شخص يفتح ذلك ، لذلك فقط القيام بذلك مع مفتاح يحتوي على صيغة صغيرة. كابالأهداف المشتركة مع nym الخاص بك (المفاتيح والبيانات المباشرة، NWC Auto-top-up و refund redemption) هي استثناءات: في المتصفح، فإنها تجيب فقط على مواقع Nymbot الخاصة بك. توقيع طلبات الحساب.

إرسال كل جسم JSON مع Content-Type: application/jsonأي نوع آخر يتم رفضه 415وبالتالي ، فإن شكل HTML بسيط أو text/plain لا يستطيع طلب من الموقع الآخر الوصول إلى API. -H "Content-Type: application/json" إلى جانب -d.

المفتاح الحار

يتم إنشاء المفتاحات في التطبيق.Open النار في صفحة الجانب من تطبيقات الويب، أو في البرنامج على Android و iOS، ثم اضغط على إنشاء مفتاحإعطيت اسمًا، وإذا كنت ترغب في ذلك، ومرحلة إنتهاء.

تظهر المفتاح مرة واحدة. كشفها في مكان آمن قبل إغلاق العلامة: Nymbot يحفظ فقط علامة تجارية منها، لذلك لا يمكن أن تظهر لك مرة أخرى. لا يمكن استرداد المفتاح المفقود؛ إلغاءه وخلق آخر.

يبدو أن المفتاح sk-nymbot- ثم تتبعها 43 حرفًا، وأرقامًا، وأرقامًا، وتحديدًا، وتحديدًا، وتحديدًا، وتحديدًا. sk-nymbot-Qm7x…c2Lw.

• المفتاح يحتوي على نيم. إنها تستغرق التكلفة الخاصة بك ، ويمكن أن تخلق أو تغير أو إلغاءها فقط ، أي شخص يحمل مفتاحه يمكن أن يستغرق معها ، لذلك تشخيصها مثل كلمة المرور.
• كوبونات في الأسهم قد يكون لديك ميزة التكلفة ، ويمكن إعادة ميزة التكلفة كل يوم ، كل أسبوع (الأول) أو كل شهر (الأول) في 00:00 UTC. فإنه يقدر كل التكاليف ، وهو ميزة قياسية كميزة 10 و ميزة Pro كميزة 100 ، لذلك فإنه يعني نفس ما إذا كان ميزة طلب التكلفة. قبل أن يتم تشغيل طلب ، يتم تحديد أقصى تكلفة (إعادة إلى ميزات كاملة) مع ما تبقى من ميزة. 403 key_limit_reached، حتى لو كان الإجابة قد وصلت تحت القفز ، فإن الخطأ يظهر كم ما زال ومتى يتم إعادة القفز. max_tokens يتم تكلفة طلب ما يكلفه في الواقع والذي يقدر مع الحد الأقصى ، لذلك إذا تقرر المورد المزيد من التوترات مما تم وضعها في الجانب الأيسر ، فإن آخر طلب الذي يطابقه يمكن أن يأخذ الحد الأقصى قليلا من الحد الأقصى ، ثم يتم رفضه.
• لا يزال كوباً مجهزًا فقط يتوقف عن التكاليف. ويمكن أيضًا أن يتم التحقق من التوازن، ويقرأ تاريخها، ويحدد النماذج، ويحصل على تقييمات، ويحصل على التحقق من الفيديو الذي بدأه بالفعل.
• Expiry هو خيار. بعد موعد تحديدك ، فإنه يتوقف عن العمل.
• الإلغاء هو عاجل ومتأخر. يظل المفتاح الذي تم إلغاؤه في طلبها التالي. يظل في القائمة، علامة تم إلغاؤه، لذلك لا تزال تاريخ النفقات معقدة.
• يمكن أن يكون لديك ما يصل إلى 25 مفتاحًا فعالًا، كل منها مع اسمها الخاص.

يظهر الشاشة نفسها استهلاك كل مفتاح في هذه الفترة، وفي مجموعها، عندما تم استخدامه لأول مرة، كلا التقديرات الخاصة بك والطلبات API الأخيرة الخاصة بك. إدارة المفتاح.

تصديق طلب

إرسال المفتاح في أي من هذه المفاتيح.إنها متساوية، لذلك استخدم ما يرسله المستخدم الخاص بك على الفور:

إرسال مفتاح مفقود أو غير معروف أو إلغاء أو قد انتهى 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 هو إرسال Nymbot الخاص بك، التي يتم دفعها من التوازن القياسي. وضع ID من نموذج الكاتالوني هناك بدلا من ذلك، مثل: anthropic/claude-sonnet-5، لاستخدام هذا النموذج من التوازن Pro. قائمة النماذج إرسال كل ID.

ما هي تكاليف طلب

API يلتحق بنفس الطريقة التي يقوم بها التطبيق.

• ما هو التوازن nymbot/auto استهلاك هذه المعايير التوازن (10 sats a credit).كل نموذج التلفزيون الآخر يستهلك Pro التكلفة (100 سعر ثانية). إنتاج الصورة المعتادة والرسالة المعتادة التكلفة المعتادة؛ كل من التكلفة الأخرى التكلفة المعتادة التكلفة المعتادة التكلفة التكلفة المعتادة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة التكلفة.
• كم كم يتم تقييم طلب الدردشة على الأسهم التي قامت بها النماذج في الواقع، في أسعار نشرها من قبل المورد. لديه هذه الأسعار 5% تكلفة اضافية ثم يتم تكرارها بنسبة 1.5، لذلك يمكنك دفع 1.575 مرة من سعر قائمة المورد. يتم تحويلها إلى الأسهم في سعر بيتكوين الحي وتكلفة في آلاف المائة من الائتمان. يتم تقييم الصور المهنية والفيديو والتصريحات لكل جيل، لكل ثانية أو لكل شخص، والترجمة لكل ثانية من الصوت، مع نفس الأسعار والحد الأدنى.
• أدناه . كل طلب محدد يغطي تكلفة ما لا يقل عن 0.05 من الائتمان: نصف على التكلفة القياسية، 5 الائتمان على Pro.
• ضع، ثم استقر. قبل أن يتم تشغيل طلب ، يتم الاحتفاظ بأكثر من تكلفة من حسابك ، وفقًا إلى ما تم إرساله وأكثر من الميزات التي يمكن أن تكتبها. يحتوي النص الخارجي ASCII على أرقام UTF-8 ، وتحتوي الأرقام ASCII والأرقام التقييمية على أرقام كل منها ، لذلك يحتفظ النص في أي سجل ، الكود والأرقام بالكامل. يحتوي الاحتفاظ على الأرقام الكاملة ، على الأقل واحد ، لذلك يحتاج أي طلب إلى ما لا يقل عن 10 أرقام مجانية على التقييم القياسي أو 100 أرقام على Pro للبدء. يحصل على تكلفة حقيقة فقط ؛ يتم إنفاذ بقية الأرقام عند الانتهاء. يحتفظ طلب طويل بمجرد الانتهاء. 402 insufficient_balance إذا كان التكلفة الحقيقية أعلى من التكلفة الحقيقية، فإن التكلفة الحقيقية ستحصل على كل التكلفة. (owed_sats في ال nymbot ما يملكه يتم دفع أولاً من الأوراق التالية التي تصل إلى هذا التوازن. حتى يتم دفعها، لا يمكن إنفاق أي شيء على هذا التوازن: لا من قبل API، والرد في التطبيق، أو نقل أو هدية.
• لا كمية كافية من الائتمان. إذا لم تتمكن المصارف من تغطية الاحتياطي، يتم رفض الطلب 402 قبل أن يتم تشغيل أي شيء.الخطأ يقول أي التوازن قصير، كم عدد الأسهم التي يحتاجها الطلب، وكم عدد مجاني. max_tokens وهذا يعني ضغط أقل.
• الفشل لا تكلف طلبًا ناجحًا، ما لم يُقدّم المورد رسومًا على العمل الذي قام به قبل النجاح، أو البحث على شبكة الإنترنت. nymbot/auto تم تشخيص المهمة بالفعل، ثم هذا هو ما تدفعه، على الأقل 0.05 القيمة. يتم تخصيص إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرس
• البحث WEB تتراوح تكلفة البحث 0.008 دولارًا ، يتم تحويلها إلى sats ، في كل مرة تقوم بها البحث ، سواء كان النموذج يتردد أو لا.

كل إجابة تقول كم تكلفه.إجابة JSON تحمل nymbot موضوع مع التكلفة التي تم دفعها من، والترخيص في الائتمان والمعدلات، وما تبقى:

التكلفة المتعلقة

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

تتعرض الإجابات المدفوعة أيضًا إلى هذه المفاتيح ، والتي هي مكانًا للبحث عن تكلفة الإجابات التي ليست JSON ، مثل الكلام:

أسعار الفوركس لكل مليون دينار، بما في ذلك السعر والميزانية، هي في قائمة النماذج في الدولار و الأسهم و في قائمة الأسعارإذا لم يتم قراءة سعر بيتكوين ، فإن الطلبات المدفوعة ستعود. 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).
• يتم إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرسال إرس

لا تحتوي إشارات الخطأ على تفاصيل داخلية لخدمة أخرى، وتحديد الخطأ الخاص به قبل الوصول إليه.

الحدود

يجب أن يظهر الرابط إلى صورة إلى مستودع عام: يتم رفض عنوان على شبكة خاصة أو محددة، أو على مواقع Nymbot الخاصة بها.

ماذا يمكن رؤية النار

API ليست خاصة بطريقة التطبيقات ، ويجب أن تكون دقيقة حول كيفية ذلك.

• لا يتم تشفيرها من نهاية إلى نهاية. في التطبيقات ، يتم إغلاق رسالة على جهازك إلى المفتاحين فقط يحمل Nymbot وتسافر كما هدية Wrapطلب API هو HTTPS العادي: يتم تشفيره على الطريق إلى Nymbot، ويقرأه خادم Nymbot في الشاشة لتعاملها.
• لا يتم تخزين الإجابة والإجابة. ما يتم الاحتفاظ به هو الرسوم البيانية: لكل طلب وقت، نموذج، نوع، تقييم الأسهم، تكلفة، التضخم، المفتاح، وما إذا كان ذلك ناجحًا، لمدة 90 يوما، وهذا ما طلب التاريخ أيضًا ، يتم الحفاظ على تسجيل استخدام نفس الطلب (التوقيت ، النوع ، النماذج ، عدد التوقيت ، تكلفة ، مدة و ما إذا كان استخدم البحث على شبكة الإنترنت أو كان ناجحًا) لمدة 90 يوما ، إلى جانب التطبيق الخاص.
• كل شيء آخر يحتوي على نيم هو صغير وتقع هنا. المفتاح الحار يتم تخزينها كالشاشة، ولا يزال مفتاحها، مع اسمها، وجوهر قصير، ومدفوع التكاليف، ومدة إعادة تثبيت، وعندما تم إنشاؤها وأخيرًا استخدامها؛ يتم تخزين فقط أحدث 50 مفتاحًا إلغاءً. تلقائيا Top-up يتم تخزين اتصال محفظة، مع الحد الأقصى والقدر والنتائج من الوصول الأخير. يتم تخزين وظائف الفيديو لمدة 24 ساعة. يتم تخزين الطلبات المدفوعة لكل مكالمة فقط بطاقات الضوء لـ 7 أيام وتخزين تذاكر الدفع لـ 30 يومًا، متصلة بأي رقم. يتم تخزين الضرائب التي لم تتمكن من تغطية حتى يتم دفعها من قبل الوصول الأخير.
• إزالة التطبيق يزيلها. A أداة Wipe إلغاء وإزالة كل مفتاح API، وإزالة تاريخ الاستفسارات، ورسائل الاستخدام، ورسائل الاتصال، ورسائل الفيديو.
• المورد من النماذج يرى طلبكيتم تشغيل نموذجات الكاتالولوج في مصمميها، والطرق القياسية والإدراجات تعمل على Cloudflare.
• الوسائط التي تم إنتاجها هي العامة. يتم نشر الصور والفيديوات التي يتم تقديمها كروابط إلى مستندات ملف Blossom العامة ، حيث هو عنوان ملفها. أي شخص لديه الروابط يمكن فتحها ، ولا يمكن Nymbot تحميلها مرة أخرى. b64_json وتعود الصورة التي تم إنشاؤها في الإجابة ولا يتم تحميلها أبدا.
• هذه هي الصور التي تمنحها للجنرال. صورة يمكنك تحميلها إلى EDITأو إرسال مثل a data: URL في جينر image_url، يتم تحميلها إلى مستودع Blossom العامة أولاً حتى يمكن للمنظم إرسالها ، وبالتالي نفس الشيء ينطبق عليه. https:// يتم إرسال الصور في طلب الدردشة إلى منتج النماذج، وليس إلى Blossom.
• يرتبط مفتاحك مع نيم. كل شيء يستهلكه المفتاح يأتي من توازن نيمك ، لذلك لا يتم استخدام API. Anonymousإذا كنت ترغب في استخدام API تم إزالتها من نيم اليومي الخاص بك، جعل المفاتيح من نيم منفصل مع التوازن الخاص بك.

إذا كنت بحاجة إلى حماية التطبيقات، استخدم التطبيقات.

كل نقطة انتهاء

“Nym&rdquo؛ يعني طلب يلقيه على مفتاح Nostr الخاص بك، والتي يتم وصفها في توقيع طلبات الحسابللأدوات التي تتحدث بالفعل عن هذه المكونات، انظر أدوات و SDKو للشركات الكمبيوتر مثل Claude Code و Codex و Cline ، انظر أدوات الكود.