پایگاه دانش / توسعه دهندگان

API بصری

مدل ها، ژنراتورها و توازن هایی که شما در برنامه استفاده می کنید، از کد خودتان هستند. API از فرمت های OpenAI و Anthropic صحبت می کند، بنابراین اکثر ابزارهای و SDK ها با تغییر یک URL پایه و کلید کار می کنند.

این صفحه برای سهولت به صورت ماشینی ترجمه شده است. نسخه اصلی انگلیسی نسخه ای است که اعمال می شود.

آتش سوزی چیست

استفاده از HTTP API nymbot.ai که همان درخواست ها را پاسخ می دهد که یک مشتری OpenAI یا Anthropic در حال حاضر ارسال می کند.

• مکمل های چتاین پاسخ API و پیام های Anthropicبا پخش، ابزارهای، تصاویر، استدلال و جستجو وب، برای هر مدل در کاتالوگ و برای خودرویی Nymbot.
• تصاویر, ویدیو, سخنرانی, ترجمه و Embeddings.
• شما توازن, دانلود فیلم Lightning Top-ups, اتوماتیک Top-ups از کیف پول شما و A تاریخ هزینه هر درخواست

پرداخت می شود از همان دو توازن مانند اپلیکیشن، در همان قیمت وجود ندارد و هیچ امضای رایگان در API وجود ندارد: هر درخواست از اعتبارات که خریداری کرده اید پرداخت می شود.

آنچه API انجام نمی دهد این است که چیزی از Nymbot خود اضافه کند. پیام های شما به مدل می روند همانطور که آنها را ارسال کردید: هیچ توصیه سیستم Nymbot، هیچ حافظه، هیچ دلیلی به تاریخ یا زبان وجود ندارد.

پایگاه URL

هر نقطه پایانی تحت /api/v1/بازگشت یک راه ناشناخته 404 و یک مسیر شناخته شده که با روش اشتباه نامیده می شود باز می گردد. 405همانند JSON.

API پاسخ به درخواست های متصل از هر سایت می دهد، بنابراین یک صفحه مرورگر می تواند آن را بخواند. هر چیزی که شما به یک مرورگر ارسال می کنید می تواند توسط هر کس که آن را باز می کند، خوانده شود، بنابراین فقط با یک کلید که دارای یک کلید کوچک انجام دهید. سرنقاط پایانی امضا شده با nym شما (کتاب ها، خلاصه حساب، NWC Auto-top-up و بازپرداخت بازپرداخت) استثنا هستند: در یک مرورگر آنها فقط به سایت های Nymbot خود پاسخ می دهند. ثبت نام درخواست حساب.

ارسال هر بدن JSON با Content-Type: application/jsonهر نوع دیگر از آن رد می شود 415به عنوان مثال یک HTML یا یک text/plain درخواست از یک سایت دیگر نمی تواند به API برسد. با cURL، عبور کنید. -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 یک درخواست هزینه ای است که در واقع هزینه دارد و این نسبت به پوشش محاسبه می شود، بنابراین اگر ارائه دهنده گزارش بیشتری از تیکون ها را از دست داده است، آخرین درخواست که مناسب است می تواند کلید را کمی فراتر از پوشش آن بگیرد؛ بعدی آن را رد می کند.
• صرفه جویی فقط صرفه جویی را متوقف می کند. یک کلید در پوشش خود هنوز هم می تواند توازن را چک کند، تاریخچه آن را بخواند، مدل های آن را لیست کند، تیک ها را محاسبه کند، بالا بماند و در یک ویدئو که قبلا شروع کرده است، بررسی کند.
• 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 Balance. لیست مدل ها هر یک از ID ها را

هزینه درخواست چقدر است

API دقیقا همان گونه که اپلیکیشن انجام می دهد حساب می دهد.

• چه تعادل nymbot/auto انفاق کنید استاندارد توازن (10 sats a credit). هر مدل چت دیگر هزینه می کند پرو تعادل (100 sats یک اعتبار). ژنراتور عکاسی استاندارد و رای استاندارد اعتبار استاندارد را صرف می کنند؛ هر ژنراتور دیگر Pro را صرف می کند. Embeddings اعتبار استاندارد را صرف می کند. Transcription اعتبار استاندارد را صرف می کند هنگامی که تعادل استاندارد می تواند آن را پوشش دهد، و اعتبار Pro در غیر این صورت. لیست مدل ها می گوید چه تعادل هر مدل صرف می کند.
• چقدر یک درخواست چت بر روی تیکن هایی که مدل در واقع خوانده و نوشته است، در نرخ های منتشر شده از ارائه دهنده متمرکز می شود. این قیمت دارای هزینه 5٪ اضافه شده و سپس با 1.5 برابر می شود، بنابراین شما 1.575 برابر قیمت لیست ارائه دهنده پرداخت می کنید. آن را به نرخ در قیمت بیت کوین زنده متمرکز می شود و در هزاران درصد از یک اعتبار محاسبه می شود. عکس های حرفه ای، ویدئو و صحبت در هر نسل، در هر ثانیه یا در هر شخصیت، و ترجمه در هر ثانیه از صدا، با همان هزینه و margin.
• حداقل است. هر درخواست محاسبه شده که هزینه حداقل 0.05 اعتبار است: نیمی از یک نشست بر روی توازن استاندارد، 5 sats بر روی پرو.
• بگذارید و سپس تسلیم شوید. قبل از اینکه یک درخواست اجرا شود، بیشترین هزینه ای که می تواند از حساب شما داشته باشد، بر اساس آنچه که شما ارسال کرده اید و بیشترین تیکن هایی که می تواند بنویسید. متن خارج از ASCII ساده از بیتی های UTF-8 خود اندازه گرفته می شود، و اعداد ASCII و امتیازها به عنوان یک تیکن محاسبه می شوند، بنابراین متن در هر اسکرپت، کد و شماره به طور کامل در دسترس می شوند. نگه داشتن در اعتبارات کامل، حداقل یک، بنابراین هر درخواست نیاز به حداقل 10 تکه رایگان در تکه استاندارد یا 100 تکه در Pro برای شروع دارد. تنها هزینه واقعی محاسبه می شود؛ بقیه زمانی که تمام می شود آزاد می شود. یک درخواست طولانی تا زمانی که اجرا می شود نگه می دارد. 402 insufficient_balance در صورتی که هزینه ها بیش از حد است که می توان پرداخت، تمام هزینه ها به حساب می آید، باقی مانده به حساب می آید (owed_sats در این nymbot موضوع، و یک توازن منفی). آنچه بدهکار است اول از اعتبار های بعدی که به آن توازن برسد پرداخت می شود. تا زمانی که پرداخت شود، هیچ چیز در آن توازن می تواند صرف شود: نه توسط API، پاسخ در برنامه، انتقال یا هدیه.
• اعتبار کافی نیست. اگر حساب حسابداری نمی تواند ذخیره را پوشش دهد، درخواست با 402 قبل از اینکه هر چیزی اجرا شود خطا می گوید که کدام توازن کوتاه است، چه مقدار نیاز به درخواست دارد و چه مقدار رایگان است. max_tokens به معنای یک دست کم.
• شکست ها درخواست شکست ناپذیر هیچ هزینه ای ندارد، مگر اینکه ارائه دهنده برای کار که قبل از شکست انجام داد، یا یک جستجو وب یا nymbot/auto چک وظیفه در حال حاضر اجرا شده است؛ پس این چیزی است که شما پرداخت می کنید، حداقل 0.05 اعتبار. یک جریان که شما قطع می کنید برای تیکن های ارائه دهنده گزارش می شود: Nymbot به مدت 25 ثانیه پس از ترک شما برای دریافت این تعداد مطالعه می کند. اگر آن را دریافت نکنید، هزینه از آنچه شما ارسال کرده اید و آنچه نوشته شده است محاسبه می شود، و برای یک مدل که به این دلیل شامل تمام هزینه های خروج از دسترس است.
• WEB جستجو $0.008 یک جستجو هزینه می کند، تبدیل به sats، هر بار که یک جستجو انجام می شود، آیا مدل پس از آن پاسخ می دهد یا شکست می دهد.

هر پاسخ به شما می گوید چه هزینه ای دارد. پاسخ های JSON یک nymbot موضوع با توازن که از آن پرداخت شده است، هزینه در اعتبارات و نرخ، و آنچه باقی مانده است:

هزینه object

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

پاسخ های پرداخت نیز این عنوان ها را حمل می کنند، که در آن به دنبال هزینه پاسخ هایی است که JSON نیستند، مانند صحبت:

نرخ ها در هر میلیون تیکن، که در حال حاضر شامل هزینه و margin هستند، در لیست مدل ها در دلار و سکه و در لیست قیمت هااگر قیمت بیت کوین نمی تواند خوانده شود، درخواست های پرداخت را باز می گردانند. 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 به طوری خصوصی نیست که اپلیکیشن ها هستند، و ارزش آن است که دقیقا در مورد چگونگی.

• آن را از انتها به انتها رمزگذاری نمی کند. در برنامه ها، یک پیام در دستگاه شما به کلید هایی که تنها Nymbot نگه دارد و به عنوان یک کلید عبور می کند بسته می شود. هدیه Wrapیک درخواست API HTTPS معمولی است: آن را در راه به Nymbot رمزگذاری می کند و سرور Nymbot آن را در روش روشن می خواند تا آن را مدیریت کند.
• پاسخ ها و پاسخ ها ذخیره نمی شوند. آنها به مدل عبور می کنند و پاسخ را به عقب می فرستد. آنچه که نگه می دارد، حساب است: برای هر درخواست، زمان، مدل، نوع، عدد تیکن، هزینه، توازن، کلید و اگر موفق شد، برای 90 روز، که چه چیزی است. آرزوی تاریخ یک رکورد استفاده از همان درخواست (زمان، نوع، مدل، شمارش تیکن، هزینه، طول عمر و اینکه آیا از جستجوی وب استفاده کرده یا موفق شده است) همچنین برای 90 روز، همراه با برنامه خود حفظ می شود.
• همه چیز دیگری که برای یک نیم محسوب می شود، کوچک است و در اینجا لیست می شود. کلید های آتش آنها به عنوان یک hash ذخیره می شوند، هیچ وقت کلید، با نام خود، یک راهنمایی کوتاه، حداکثر هزینه، دوره بازسازی، پایان دوره و زمانی که آنها ساخته شده و آخرین استفاده از آنها؛ تنها آخرین 50 کلید بازگردانده ذخیره می شود. اتوماتیک Top-Up ارتباط کیف پول به صورت رمزگذاری، با حداکثر، مقدار و نتیجه آخرین بالا رفتن ذخیره می شود. کارهای ویدئویی برای 24 ساعت ذخیره می شود. درخواست های پرداخت شده در هر تماس تنها یک هشدار پرداخت Lightning برای 7 روز و یک تکه بازپرداخت هشدار شده برای 30 روز، مرتبط با هیچ NIM باقی می ماند. هزینه هایی که یک توازن نمی تواند پوشش داشته باشد تا زمانی که یک بالا رفتن آنها را پرداخت می کند.
• حذف اپلیکیشن آن را حذف می کند. A دستگاه Wipe هر کلید API را رد می کند و حذف می کند و تاریخچه سوال، رکورد استفاده، اتصال کیف پول و کار های ویدئویی را حذف می کند.
• ارائه دهنده مدل درخواست شما را می بیندمدل های کاتالوگ در سازندگان خود اجرا می شوند؛ راه های استاندارد و نصب ها در Cloudflare اجرا می شوند.
• رسانه های تولید شده عمومی هستند. عکس ها و ویدئو هایی که به عنوان لینک ها ارائه می شوند، به میزبان فایل های عمومی Blossom اپل می شوند، که در آن آدرس یک فایل hash است. هر کس با لینک می تواند آن را باز کند و Nymbot نمی تواند آن را دوباره دانلود کند. b64_json و یک تصویر تولید شده در پاسخ باز می گردد و هرگز بارگذاری نمی شود.
• عکس هایی که شما به یک ژنراتور می دهید عکس هایی که شما اپل می کنید Editیا به عنوان A ارسال کنید. data: URL در یک ژنراتور image_url، اول به یک میزبان عمومی Blossom اپل می شود تا ژنراتور بتواند آن را دریافت کند، و همینطور برای آن اعمال می شود. https:// تصاویر در یک درخواست چت به ارائه دهنده مدل می روند، نه به Blossom.
• یک کلید به نیم شما متصل می شود. همه چیز که یک کلید صرف می کند از توازن نیم شما می آید، بنابراین استفاده از API نیست. انیمیشناگر می خواهید استفاده از API را از نیم روزمره خود جدا کنید، کلید ها را از نیم جداگانه با تعادل خود ایجاد کنید.

اگر شما نیاز به محافظت از برنامه ها، از برنامه ها استفاده کنید. API برای زمانی است که شما نیاز به مدل ها در ابزار خود را.

هر نقطه پایانی

“Nym&rdquo؛ به معنای درخواست امضا شده توسط کلید Nostr شما، که در ثبت نام درخواست حساببرای ابزار هایی که در حال حاضر از این فرمت ها صحبت می کنند، ببینید: ابزار و SDKبرای آژانس های رمزنگاری مانند Claude Code، Codex و Cline، ببینید: ابزار Coding.