בסיס ידע / מפתחים

API תצפית

המודלים, הגנרטורים והאיזון שאתה משתמש באפליקציה, מהקוד שלך.ה-API מדבר על הפורמטים OpenAI ו-Anthropic, כך שרוב הכלים וה-SDK עובדים על-ידי שינוי כתובת URL בסיסית ומפתח.

דף זה תורגם במכונה לנוחיותך. המקור האנגלי הוא הגרסה החלה.

מהו האש

ה-HTTP API של nymbot.ai זה עונה על אותם בקשות שהלקוח של OpenAI או Anthropic כבר שולח.

• צ'אט סיום→ The תשובות API ו מסרים אנתרופיים, עם סטרימינג, כלים, תמונות, סיבה וחיפוש אינטרנט, עבור כל מודל ב קטלוג על ידי Nymbot Auto-routing.
• תמונות, וידאו, נאום, תרגום ו Embeddings.
• שֶׁלְךָ איזון, תגיותLightning Top-ups, Top-ups אוטומטיים מהארנק שלך ו A היסטוריה על מה כל בקשה עולה.

הם משלמים מאותם שני איזון כמו האפליקציה, באותם מחירים.אין מנוי ואין תשלום חינם על ה-API: כל בקשה משולם על ידי קריטריונים שקנית.

מה שה-API לא עושה הוא להוסיף משהו של Nymbot עצמו.ההודעות שלך הולכות למודל כפי שאתה שולח אותם: אין Nymbot מערכת דחיפה, אין זיכרון, אין תאריך או רמזים לשפה.מה חוזר הוא התשובה של המודל והערה של כמה זה עולה.

בסיס URL

כל נקודה חיה מתחת /api/v1/דרך לא ידועה חוזרת 404 ודרך ידועה שנקראת בשיטה הלא נכונה חוזרת 405כמו גם JSON.

התוכנה מגיבה לבקשות בין מקורות מכל אתר, כך דף דפדפן יכול להתקשר אליו.כל מה שאתה שולח לדפדפן ניתן לקרוא על ידי מי פותח אותו, אם כי, אז רק לעשות זאת עם מפתח שיש לו מפתח קטן. ראשנקודות הקצה שנחתמו עם נימ שלך (מפתחות, סיכום החשבון, NWC auto-top-up ו- refund redemption) הן יוצא מן הכלל: בדפדפן הם עונים רק לאתרים של Nymbot. חתימה בקשות חשבונות.

שלח כל גוף JSON עם Content-Type: application/jsonכל סוג אחר מסרב 415, כך צורה פשוטה של HTML או text/plain בקשה ממקום אחר לא יכולה להגיע ל-API. -H "Content-Type: application/json" יחד עם -d.

מפתחות אש

המפתחות נוצרות באפליקציה. אש בשורת הצדדים של אפליקציית האינטרנט, או בתפריט ב- Android ו- iOS, ולחץ על יצירת מפתחתן לו שם, ואם תרצה, כיסוי ותאריך יציאה.

העתק אותו במקום מאובטח לפני שתסגור את העמוד: Nymbot שומר רק טביעת אצבע ממנו, כך שהוא לא יכול להראות לך אותו שוב.

המפתח נראה כאילו sk-nymbot- בעקבותיו 43 אותיות, ספרות, תווים ותחתונים.האפליקציה רשימה כל מפתח בשמו וסימן קצר כגון: sk-nymbot-Qm7x…c2Lw.

• המפתח שייך לנימוס שלך. זה מוציא את האיזון שלך, ורק הנימ שלך יכול לעשות, לשנות או לבטל אותו.כל מי שיש לו את המפתח יכול להוציא את זה, אז לטפל בו כמו סיסמה.
• הקופסאות נמצאות בתעריף. מפתח יכול להיות מכסה הוצאות, ואת מכסה ניתן להגדיר מחדש כל יום, כל שבוע (יום שני) או כל חודש (הראשון), בשעה 00:00 UTC. זה מחשב את שני המשקלים, אשראי סטנדרטי כ 10 sats ו אשראי פרו כ 100, כך שזה אומר אותו דבר בכל איזון ההזמנה מבזבז. 403 key_limit_reached, גם אם התשובה הייתה מתחת לקופסה; השגיאה אומרת כמה נשאר ומתי הקופסה מחזירה. max_tokens בקשה מחויבת במה שהיא באמת עולה וזה נחשב נגד הקפדה, כך שאם הספק מדווח על יותר טוקינים מאשר הוצבו בצד, הבקשה האחרונה שמתאימה יכולה לקחת את המפתח קצת מעבר לקפדה; הבא הוא סולל.
• מחירי המניות הפסיקו רק את ההוצאות. מפתח בכיסו עדיין יכול לבדוק את האיזון, לקרוא את ההיסטוריה שלו, לרשום מודלים, לספור טוקינים, לפתוח ולבדוק וידאו שהוא כבר התחיל.
• החופש הוא אופציונלי. לאחר התאריך שאתה מגדיר, המפתח מפסיק לעבוד.
• התפטרות היא מיידית וסופית. מפתח בוטל נכשל בקשתו הבאה.הוא נשאר ברשימה, מסומן בוטל, כך ההיסטוריה של ההוצאות שלו עדיין הגיוני.
• אתה יכול להיות עד 25 מפתחות פעיל, כל אחד עם שם משלו.

אותו גיליון מציג את ההוצאות של כל מפתח בתקופה זו ובסך הכל, כאשר הוא שימש לאחרונה, הן את המשאבים שלך, והן את בקשות ה-API שלך לאחרונה. ניהול מפתחות.

אימות בקשה

שלח את המפתח בכל אחת מהכותרות האלה.הן שוות, לכן השתמש במה שהלקוח שלך שולח כברירת מחדל:

החזרה של מפתח חסר, לא ידוע, מבוטל או נגמר 401עם הקוד missing_api_key, invalid_api_key, revoked_api_key או expired_api_keyרשימת מודלים, דגמי אודיו, קולות ושיטות תשלום אינם זקוקים למפתח.

תמונות, וידאו, דיבור, תרגום ושילוב ניתן גם לשלם על בקשה אחת בכל פעם על ידי Lightning ללא מפתח בכלל: לשלוח את הבקשה ללא אחד ולשלם את החשבון ב 402 תשובה - ראה תשלום לפי בקשה ללא מפתח.

ניהול מפתחות, סיכום החשבון והעלויות אוטומטיות הם יוצאים מן הכלל: הם לוקחים חתימה מ-nym שלך במקום מפתח, כך שהמפתח שנעלם לא יכול ליצור יותר מפתחות. חתימה בקשות חשבונות.

בקשתך הראשונה

הניחו את המפתח במשתנה סביבתי, ולאחר מכן שאלו את המודל משהו. 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 עצמו, משולם מהסכום הסטנדרטי. anthropic/claude-sonnet-5, כדי להשתמש במודל זה מתוך Pro איזון. רשימת מודלים תן לי כל מזהה.

כמה עולה בקשה

ה-API מחייב בדיוק כמו שהאפליקציה עושה.

• איזה איזון nymbot/auto מוציאים את סטנדרט איזון (10 sats a credit). כל דגם צ'אט אחר מבלה את Pro איזון (100 sats אשראי). הגנרטור התמונה הסטנדרטי והקול הסטנדרטי מוציאים אשראי סטנדרטי; כל גנרטור אחר מוציא Pro. Embeddings מוציא אשראי סטנדרטי. Transcription מוציא אשראי סטנדרטי כאשר איזון סטנדרטי יכול לכסות את זה, ואת אשראי Pro אחרת. רשימת המודלים אומרת איזה איזון כל מודל מוציא.
• כמה בקשת צ'אט מתוארת על התוויות שהמודל בעצם קרא וכתב, במחירים שפורסמו על ידי הספק. המחיר הזה יש תשלום נוסף של 5%, ולאחר מכן מופרד על ידי 1.5, כך שאתה משלם 1.575 פעמים את מחיר הרשימה של הספק. זה מוחלף ל-SAT במחיר Bitcoin חי ומוגבל באלפית של אשראי. תמונות פרו, וידאו ודיבור מוערכים לדור, לשנייה או לדמות, וטרנסקיפציה לשנייה של אודיו, עם אותה תשלום ומגבלה. התמונה הסטנדרטית היא שטוח 5 אשראי סטנדרטי והקול הסטנדרטי שטוח 3.
• את המינימום כל בקשה מדויקת שמשלימה עולה לפחות 0.05 אשראי: חצי מהשווי הסטנדרטי, 5 שוויות על Pro.
• החזיקו אותו, ואז התיישבו. לפני שביקוש פועל, רוב העלות שלו נשמרת מהסכום שלך, בהתבסס על מה שאתה שולח ואת רוב הכרטיסים שהוא יכול לכתוב. טקסט מחוץ ל- ASCII רגיל הוא בגודל מ- UTF-8 בייטים שלו, ואת המספרים ASCII ואת הנקודות לספור כמו טוקן כל אחד, כך טקסט בכל סקריפט, קוד ומספרים נשמרים במלואם. ההחזקה היא בכרטיסים שלמים, לפחות אחד, כך שכל בקשה צריכה לפחות 10 שערים חופשיים על הסכום הסטנדרטי או 100 שערים על Pro כדי להתחיל. רק העלות האמיתית מתבצעת; השאר משוחרר כאשר הוא מסתיים. בקשה ארוכה שומרת את עצמה כל עוד היא פועלת; אם השערים שנשמרו מפסיקים 402 insufficient_balance כלומר, אם התוצאה היא שווה יותר מהתוצאה, כל התוצאה היא שווה, כל התוצאה היא שווה (owed_sats ב The nymbot מה שנחויב משולם תחילה מתוך הכרטיסים הבאים שמגיעים לשווי זה.עד שהוא משולם, שום דבר על איזון זה לא יכול להיות מנוצל: לא על ידי ה- API, תשובות באפליקציה, העברה או מתנה.
• לא מספיק אשראי. אם האיזון אינו יכול לכסות את ההחזקה, הבקשה נדחתה 402 השגיאה אומרת איזה איזון הוא קצר, כמה sats הדרישה צריכה וכמה הם חופשיים. max_tokens פירושו של מעמד קטן יותר.
• כשלונות בקשה שנכשלת לא עולה כלום, אלא אם כן הספק חשב על העבודה שהוא עשה לפני כישלון, או חיפוש באינטרנט או nymbot/auto בדיקת המשימות כבר הושלמה; אז זה מה שאתה משלם, לפחות 0.05 אשראי. זרם שאתה לחתוך הוא מחויב עבור התוויות שהספק מדווח: Nymbot ממשיך לקרוא את זרם הספק עד 25 שניות לאחר שאתה עוזב כדי לקבל את המספר.
• חיפוש WEB עלות החיפוש היא 0.008 דולר, המוחלפת ל- sats, בכל פעם שביצע החיפוש, בין אם המודל עונה או נכשל.

כל תשובה אומרת כמה היא עולה. 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).
• בקשה לסטרימינג שנכשלת לפני באט הראשון שלה מקבלת שגיאה JSON רגילה עם המצב לעיל, לא זרם אירועים.

הודעות שגיאה לעולם אינן מכילות פרטים פנימיים של שירות אחר.

גבולות

קישור לתמונה חייב להראות למארח ציבורי: כתובת ברשת פרטית או מקומית, או באתרים של Nymbot, נדחתה.

מה האש יכולה לראות

התוכנה אינה פרטית כפי שהאפליקציות הן, וזה שווה להיות מדויק לגבי איך.

• זה לא סופסוף מוצפן. באפליקציות, הודעה מאובטחת במכשיר שלך למפתחות שרק Nymbot מחזיקה ומעבירה חבילת Wrapבקשת API היא HTTPS רגילה: היא מוצפנת בדרך ל-Nymbot, והשרת של Nymbot קורא אותה בקלות כדי לטפל בה.
• תשובות ותשובות לא מאוחסנות. מה שנשמר הוא החשבון: עבור כל בקשה הזמן, המודל, הסוג, חשבונות טוקן, עלות, איזון, מפתח ואם זה הצליח, במשך 90 ימים, וזה מה רוצה היסטוריה רשומה של השימוש באותו בקשה (זמן, סוג, מודל, מספר טוקינים, עלות, משך והאם היא השתמשה בחיפוש אינטרנט או הצליחה) נשמרת גם במשך 90 ימים, לצד האפליקציה עצמה.
• כל דבר אחר שנשמר עבור נימ הוא קטן ומפורסם כאן. מפתחות אש הם מאוחסנים כשיש, לעולם לא המפתח, עם השם שלהם, רמז קצר, קופסת הוצאות, תקופת הגדרת מחדש, תוקף ומתי הם נעשו והשתמשו לאחרונה; רק 50 המפתחות האחרונות שנמחקו נשמרים. Top-up אוטומטי חיבור הארנק מאוחסן מאובטח, עם סף, סכום ואת התוצאה של העלילה האחרונה. עבודות וידאו נשמרות למשך 24 שעות. בקשות ששולמו לפי שיחה משאירות רק חיתוך תשלום Lightning למשך 7 ימים וטוקן החזר חיתוך למשך 30 ימים, מחובר ללא נימ.
• מחיקת האפליקציה מחיקה אותה. A מכשיר Wipe מוחק וממחוק כל מפתח API, וממחוק את היסטוריית השאילתות, רשומות השימוש, חיבורים לכספת ושיעורי וידאו.
• הספק של המודל רואה את הבקשה שלךמודלים קטלוגים פועלים במייצגים שלהם; מסלולים סטנדרטיים ושילוב פועלים ב- Cloudflare.
• התקשורת המוצעת היא ציבורית. תמונות וסרטוני וידאו המועברים כקישורים מוחלפים למארחים ציבוריים של קובץ Blossom, שם הכתובת של קובץ היא ההשקה שלו. b64_json תמונה שנוצרה חוזרת בתגובה ומעולם לא מעלה אותה.
• כך הם התמונות שאתה נותן גנרטור. תמונה שאתה מעלה EDIT, או לשלוח כ A data: URL של גנרטור image_url, מוחזר לראשונה למארח ציבורי Blossom כדי שהגנרטור יוכל להוריד אותו, אותו הדבר חל עליו. https:// התמונות בקשת צ'אט הולכות לספק של המודל, לא ל- Blossom.
• מפתח קשור ל-NIM שלך. כל מה שמפתח מוציא מגיע מהמשקל שלך, כך שהשימוש ב-API אינו אנונימיאם ברצונך שהשימוש ב-API יישמר בנפרד מ-nym היומיומי שלך, צור את המפתחות מ-nym נפרד עם איזון משלו.

אם אתם זקוקים להגנה על האפליקציות, השתמשו באפליקציות.ה-API מיועד כאשר אתם זקוקים למודלים במכשירים שלכם.

כל נקודה סופית

“Nym” פירושו בקשה שנחתמה על ידי המפתח Nostr שלך, המתואר ב חתימה בקשות חשבונותעבור כלים שכבר מדברים על פורמטים אלה, ראה כלים ו- SDKsעבור סוכני קוד כמו Claude Code, Codex ו-Cline, ראה כלי קוד.