Перайсці да зместу
Назад у Nymbot

База ведаў распрацоўшчыкі

API агляд

Мадэлі, генератары і балансы, якія вы выкарыстоўваеце ў прыкладзе, з вашага ўласнага кода. API размаўляе OpenAI і антрапічны фарматы, так што большасць інструментаў і SDK працуюць, змяняючы базавы URL і ключ.

Што такое API

HTTP API з'яўляецца nymbot.ai што адказвае на тыя ж запрашэнні, якія OpenAI або Anthropic кліент ужо адпраўляе.

Плаціць за два такіх ж Баланс Як і прыкладна, няма ніякай падпіскі і ніякай бясплатнай прывілеі на API: кожны запыт плаціць з крэдытаў, якія вы купілі.

Што API не робіць, гэта дадаць што-небудзь з Nymbot. Вашы паведамленні ідуць у мадэль, як вы адпраўляеце іх: няма Nymbot сістэмы памочнік, няма памяці, няма даты або мовы наметкі.

База URL

ВыкарыстаннеБаза URL
OpenAI SDK і OpenAI-сумяшчальныя інструментыhttps://nymbot.ai/api/v1
антрапічны SDK і Клод Кодhttps://nymbot.ai/api (Пасля перасылкі з SDK) /v1/messages Самі

Кожнае месца жыве пад /api/v1/Невядомы шлях вяртаецца 404 І знаёмы шлях, названы з няправільным метадам, вяртаецца. 405Як і ў JSON.

Усё, што вы адпраўляеце да браўзэра можа быць прачытаны тым, хто адкрывае яго, так што толькі рабіць гэта з ключом, які мае невялікі КапітанВыключэнне з'яўляюцца кандыдаты, падпісаныя з вашым нім (ключы, сумы рахункаў, NWC Auto-top-up і refund redemption): у браўзэры яны адказваюць толькі на ўласныя сайты Nymbot. Заявы на рахунак.

Запрашаем усіх, хто цікавіцца JSON Content-Type: application/jsonУ любым іншым выпадку адмовіцца 415, так што простая форма HTML або text/plain Наступным крокам з'яўляецца выбар адпаведнага абсталявання для -H "Content-Type: application/json" Разам з -d.

Крыніца ключа

Ключы зроблены ў прыкладзе. Пажар у боковым баку вэб-прыкладання, або ў меню на Android і iOS, і націсніце Стварэнне ключаДайце ім назву і, калі вы хочаце, капусту і дату заканчэння.

Усё, што вы чулі пра карысць пара раней - усяго толькі чуткі і павер'і.

Ключ выглядае як sk-nymbot- Затым налічваюць 43 літары, лічбы, дашэ і падскары.Аппп выпісвае кожны ключ па сваёй назве і кароткі нагляд, такі як: sk-nymbot-Qm7x…c2Lw.

  • Ключ належыць вашым нім. Ён расходуе ваш баланс, і толькі ваш нім можа зрабіць, змяніць або адмовіць яго.
  • Казалі, што ў іх ставяцца кошты. Ключ можа мець выдаткавую крэдыт, і крэдыт можа рэстаўраваць кожны дзень, кожны тыдзень (па-першае) або кожны месяц (па-першае), у 00:00 UTC. Ён лічыцца абмежаваным балансам, стандартным крэдытам як 10 sats і Pro-крэдытам як 100, так што гэта значыць тое ж самае, які баланс патрабуецца выдаткаваць. 403 key_limit_reached— Калі я зараз пачну называць прозвішчы, спіс будзе вельмі доўгім. max_tokens Запрашаем усіх, хто цікавіцца беларускай гісторыяй, наведаць нашу Бібліятэку, наведаць нашу Бібліятэку і наведаць нашу Бібліятэку.
  • Вытрачаны капак толькі спыняе расходы. Ключ у свой капак можа яшчэ праверыць баланс, прачытаць яго гісторыя, спіс мадэляў, лічыць токены, набыць і праверыць на відэа, якое ён ужо пачаў.
  • Выключэнне з'яўляецца факультатыўным Пасля таго, як вы задалі дату, ключ перастае працаваць.
  • Вылучэнне — неадкладнае і канчатковае. У нашай багатай беларускай літаратуры няма другога такога твора, які па энцыклапедычнасці выяўлення ў ім нацыянальнага, так набліжаўся б да "Новай зямлі".
  • Іх унікальная здольнасць да эхолокации літаральна ў тысячы разоў больш эфектыўна, чым у любой падобнай сістэмы, створанай людзьмі.

Тым часам, як у нас словы “грамадскае” і “занядбанае” часам успрымаюцца як сінонімы, у Каталоніі грамадскія тэрыторыі — тыя ж пляжы — даглядаюцца так, як у іншых краінах VIP-аўскія. Упраўленне ключамі.

Аўтэнтыфікацыя заяўкі

Узнікае пытанне: калі іх ведае увесь свет, ці можна назваць іх няўдачнікамі?

ХідэрСцягнуць
Authorization: Bearer sk-nymbot-…OpenAI SDK, большасць інструментаў, Claude Code з ANTHROPIC_AUTH_TOKEN
x-api-key: sk-nymbot-…Антыпалітычныя SDK
api-key: sk-nymbot-…Azure-style кліенты

Загінулі, невядомыя, ануляваныя або выконваныя ключы 401З кодам missing_api_key, invalid_api_key, revoked_api_key або expired_api_keyЗапіс мадэляў, аўдыёмадэляў і галасоў, а таксама метадаў аплаты не патрабуе ключа.

Фота, відэа, гаворка, транскрипцыя і ўбудовы могуць таксама плаціць за адзін запыт у той час над Lightning без ключа ўсяго: адправіць запыт без аднаго і заплаціць рахунак у 402 Здаровая: Здаровая Плаціць на заказ без ключа.

Ключавое кіраванне, сукупнасць рахункаў і аўтаматычныя топ-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 Для рэгістрацыі даменнага імя ў гэтай зоне неабходна звярнуцца ў кампанію The Electronic and Postal Communications Authority[1] (Албанія), якая з'яўляецца адзіным аўтарызаваным рэгістратарам даменаў у зоне al. anthropic/claude-sonnet-5Для таго, каб зрабіць гэта, трэба набыць баланс. Спіс мадэляў Кожнаму з іх давядзецца ID.

Што коштуе заяўка

API вылічвае рахункі менавіта так, як робіць прыклад.

  • А які баланс! nymbot/auto Вырабіце гэта Стандарт астатні баланс (10 sats a credit). Кожная іншая мадэль чатуе Пра баланс (100 sats a credit). Стандартны генератар малюнкаў і стандартны голас расходуюць стандартныя крэдыты; кожны іншы генератар расходуе Pro. Убудовы расходуюць стандартныя крэдыты. Транскрипцыя расходуе стандартныя крэдыты, калі стандартны баланс можа пакрыць яго, і Pro крэдыты інакш.
  • Як многа Запрабаванне чату працэнтуецца на токены, якія мадэль фактычна прачытала і напісала, па апублікаваных тарифах пастаўшчыка. Такая цана мае 5% падатку і затым умножаецца на 1,5, так што вы плаціце 1,575 разы лістную цану пастаўшчыка. Ён канвертуецца ў sats па жывым Bitcoin цане і зарэгістраваны ў тысячадзевых крэдыту. Про здымкі, відэа і гаворка працэнтуюцца па пакаленні, па секунды або па характары, і транскрыпцыі па секунды аўдыё, з той жа падаткай і маргінам. Стандартная карціна з'яўляецца плоскім 5 стандартных крэдытаў і стандартны голас плоскі 3.
  • І мінімум Кожнае мэтавае патрабаванне, якое выконвае кошт не менш за 0,05 крэдыту: паловина сядзеў на стандартным балансе, 5 стаў на Pro. Фракцыі крэдыту пераносяцца, а не закруглены кожны раз.
  • Заставайце, а затым сядзець Перш чым запыт запусціцца, найбольш кошт, які ён можа каштаваць, захоўваецца з вашага балансу, на аснове таго, што вы адпраўляеце, і найбольш токенаў, якія ён можа напісаць. Тэст знешняга звычайнага ASCII памеркаваны з яго UTF-8 байт, і ASCII лічбы і пунктуальнасць лічыцца як токен кожны, так што тэкст у любым сцэне, кодзе і нумары захоўваюцца ў поўным узроўні. Хватка ў цэлым крэдытах, не менш за адзін, так што любому патрабаванню патрэбны не менш за 10 стаўкаў бясплатна на стандартным балансе або 100 стаўкаў на Pro, каб пачаць. 402 insufficient_balance У гэтым выпадку пешаходы, якія сканчаюць пераход, уяўляюць істотную небяспеку (owed_sats У на nymbot (Рэгістратар - гэта проста кампанія, праз якую вы можаце зарэгістраваць сваё даменнае імя ў абмен на штогадовую плату.)
  • Не дастаткова грошай. Калі баланс не можа пакрыць падтрымку, просьба адмовіцца з 402 У гэтым выпадку пешаходы, якія сканчаюць пераход, уяўляюць істотную небяспеку (мал. max_tokens Гэта значыць меншую колькасць.
  • Неўзабаве Запрабаванне, якое не спрацавала нічога не коштала, калі пастаўшчык не аплаціў за працу, якую ён зрабіў, перш чым не спрацавала, або вэб-шукаванне або nymbot/auto Кніга, якую называюць беларускім “высокім” фэнтэзі, расказвае пра хлопца Яся, што апынуўся ў дзівоснай краіне Эферыі.
  • Сайт пошуку кошт $ 0,008 пошук, канвертаваны ў sats, кожны раз, калі пошук быў запушчаны, ці мадэль тады адказвае або няправільна.

– Раскажы, каб чытачам было больш зразумела, колькі часу патрабуецца для працы над адным мультфільмам? nymbot аб'ект з балансам, з якога ён быў выплачаны, плату ў крэдытах і sats, і што застаецца:

Кошт аб'екта

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

Арганізатар спеўных варштатаў у межах праекта «CHOICE-Беларусь: спадчына i сучаснасць» разважае, як можна пракласці мост паміж музеем і людзьмі.

ХідэрЗначэнне
X-Nymbot-Cost-SatsКолькі гэта кошт, у sats.
X-Nymbot-Balance-SatsШто застаецца на балансе, з якога было выплачана, у sats.
X-Request-IdУзнікае пытанне: калі іх ведае увесь свет, ці можна назваць іх няўдачнікамі?

Кошт на мільён токенаў, ужо ўключаючы плату і марж, знаходзіцца ў Спіс мадэляў у доларах і станах, і на Ціна на лістКалі кошт Bitcoin не можа быць прачытаны, выплачаныя патрабаванні вяртаюцца 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
  }
}
СтатусКалі
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 Хрэсьбіны адбыліся так, як задумалася каманда.
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), кошт Bitcoin не можа быць прачытаны (price_unavailable), або частка паслугі зніжаецца (service_unavailable, media_hosting_unavailable). Retry-After Кажуць, калі папрабуюць зноў, калі ведаюць.

Два выключэнні:

  • /api/v1/messages Адказвае ў формаце памылкі 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-up60 на гадзіну за нім і 120 на гадзіну за адрас.
Загрузіць NWC Wallet10 гадзін за нюм і 30 гадзін за адрас. wss:// У Стандартным порце
Загрузіць Токены60 заявак за хвіліну.
АдказацьIPv6 адрас лічыцца як яе цэлы /64 у кожным ліміце адрасы, і IPv4 накіраваны IPv6 адрас як яго IPv4 адрас.
JSON Заявы4 Мб; 64 Кб для запытаў, падпісаных з вашым нім.
Multipart request body (загрузіць)32 Мб. Карціна для рэдагавання можа быць да 20 Мб, аўдыёфайл да 25 Мб. На больш чым 64 частках, кожная з максімальна 8 Кб частковых заголоваў, і межа 1 да 70 характараў; інакш 400 invalid_multipart.
Фота ў адным чаце20.У кожнага з нас ёсць https:// або http:// Наступным крокам з'яўляецца выбар адпаведнага абсталявання для data:image/… Урэшце URL
Вынікі пошуку - generations request1 з 4 (n)
Выхадны токенВыкарыстоўвайце максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максімальную максіму. max_tokens Зніжаецца да яго, а не адмаўляецца.
Інтэрв'ю для выступу800 знакаў для стандартнага голасу, 2000 для Aura 2.
Транскрипцыя30 хвілін аўдыё, 25 Мб. Даўжыня запісу адмовіцца з 413 І не забывайце пра тое, што не бачыце, калі вы чуеце мовы.
Вяртанне100 працэнтаў на заяву.
ВідеоПравіцьЗ тых часоў мінула 24 гады, а з тых часоў існавала не менш за 10 гадоў.
Хочаш гісторыюПрацягласць 90 дзён.
Актыўны ключ на німТолькі апошнія 50 загінулых ключоў захоўваюцца.

Напэўна, мы не з’яўляемся нейкімі паддоследнымі суб’ектамі, на якіх Бог эксперыментуе, спасылаючы нейкія цяжкасці і выпрабаванні.

Што можа бачыць агонь

API не з'яўляецца прыватным у выглядзе прыкладанняў, і варта быць точным пра тое, як.

  • Гэта не канчатковы крэдыт. У прыкладах, паведамленне запечатана на прыладзе да ключаў толькі Nymbot захоўвае і падарожнічае як Дзіцячы WrapЗапыт API звычайны HTTPS: ён зашыфраваны на шляху да Nymbot, і сервер Nymbot чытае яго ў ясным, каб спрабаваць яго.
  • Заявы і адказы не спасылаюцца. Тое, што захоўваецца, гэта рахунак: для кожнага запыту час, мадэль, тып, токен лічыцца, кошт, баланс, ключ і ці гэта паспяхова, на працягу 90 дзён, што гэта тое, што Запрашаем на гісторыю Запіскі выкарыстання таго ж патрабавання (час, тып, мадэль, кошт токена, кошт, працягласць і калі ён выкарыстоўваў вэб-шук або ўдалося) таксама захоўваецца на працягу 90 дзён, а таксама ўласнай прыкладання.
  • Усё іншае, што захоўваецца для німа, маленькае і знойдзена тут. Крыніца ключа з'яўляюцца захоўваюцца як хаш, ніколі ключ, з іх ім, кароткі наклік, капуста расходаў, перыяд пераўтварэння, выпадак і калі яны былі зроблены і апошні раз выкарыстаны; толькі апошнія 50 скасаваныя ключы захоўваюцца. Аўтаматычны top-up Заявы па платформе захоўваюцца зашыфраваныя, з яго пагрозай, сумай і вынікам апошняга надпісу. Відеопрацы захоўваюцца на працягу 24 гадзін. Заявы, якія плацілі за выкананне, пакідаюць толькі хеш плацяжоў Lightning на 7 дзён і хеш-паўторны токен на 30 дзён, звязаны з ніякай нім. Абаланс, які не мог пакрыцца, захоўваюцца як падатковыя, пакуль надпіс не заплаціць іх.
  • Загрузіць app выключыць гэта. A Загрузіць Wipe Укладайце больш ва ўласную журналістыку, СМІ і змагайцеся за свабоду слова.
  • Прадстаўніца мадэлі бачыць вашу просьбуКаталогічныя мадэлі працуюць на іх вытворцах; стандартныя маршруты і ўбудовы працуюць на Cloudflare.
  • Вытворчасць журналістаў — гэта публічнасць. Фота і відэа, якія даступныя ў якасці спасылак, загружаюцца на публічныя файлы Blossom, дзе адрас файла з'яўляецца яго хашавым. b64_json Ілюстрацыя да апісання кнігі выклікае раздражненне, і яна ніколі не перадаецца.
  • Так і здымкі, якія вы даеце генератар. Фота, якую вы загружаеце Эдыабо накіраваць як data: URL у генератары image_url, загружаецца на публічны Blossom хост перш за ўсё так, што генератар можа выйграць яго, і тое ж самае важны для яго. https:// Карціны ў чат-запрашэнні ідуць да пастаўшчыка мадэлі, а не Blossom.
  • Ключ звязаны з вашым нім. Усё, што ключ траціць, выходзіць з балансу вашага німа, так што выкарыстанне API не АнонімныКалі вы хочаце выкарыстоўваць API, каб захоўваць адрозненне ад вашага штодзённага нім, зрабіце ключы з асобнай нім з сваёй сабой балансу.

Калі вы хочаце прымусіць свой мозг працаваць, прыходзьце ў Клуб інтэлектуальных гульняў УЗВ!

Кожны край

Крайні пунктШто ён робіцьаўто
GET /api/v1/modelsСпіс мадэляўЗ цінамНіхто
POST /api/v1/chat/completionsЧат завершаныключы
POST /api/v1/responsesАпавяданнеключы
POST /api/v1/messagesАнтропічныя паведамленніключы
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}Загрузіць, загрузіць і праверыць відэаключы, або Сцяг Для стартаў 1
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Распаўсюджваецца Lightningключы
GET /api/v1/topup/status/{invoice_id}Чэкі і крэдытыключы
GET /api/v1/queries/historyКошт кожнай заявыКлюч або нім
GET /api/v1/accountрахункі сумыНім
/api/v1/keysСтварыць, змяняць і адмяняць ключыНім
/api/v1/nwc-auto-topupАўтаматычны Top-upsНім
GET /api/v1/l402/refunds, POST /api/v1/l402/refunds/redeemЧэкаваць або выкупіць токен на возвратВынікі пошуку - nym to redeem

“Nym” азначае запыт, падпісаны вашым ключам Nostr, апісаны ў Заявы на рахунакНаступным крокам з'яўляецца выбар адпаведнага абсталявання для Інструменты і SDK, і для кодавых агентаў, такіх як Клод Код, Кодэкс і Клайн, см. Код інструментаў.