Белем базасы / Разработчиклар

API аралаштируы

Сез кушымтада кулланарга моделләр, генераторлар һәм баланс — үз кодыннан. API OpenAI һәм Anthropic форматларында эшли, шуңа күрә күпчелек инструментлар һәм SDKлар төп URL һәм ключны үзгәртеп эшли.

Бу бит уңайлык өчен машинага тәрҗемә ителгән. Инглизчә оригиналь - кулланыла торган версия.

API нәрсә дигән нәрсә?

HTTP API 🌐 nymbot.ai OpenAI яки Anthropic клиенты исеме белән җибәрелгән үзем шул төрле сорауларга җавап бирә. Сез түшедегез:

• Чат тулыландырулары, шул Җаваплар API һәм Anthropic Хәбәрләре, стриминг, инструментлар, рәсемнәр, дәлләндерү һәм веб эзтәү белән, һәр модель өчен каталог һәм Nymbotның үзенең авто-маршрутлауы өчен.
• Суратлар, видео, рәкыть, транскрипция һәм эмбеддингләр.
• Сезнең баланс, Lightning тулдырулар, суга кошетекын автоматлы тутыру һәм а тарих һәр бир телче ниччә толаслыканның.

Бу шул икесеннән түләү ителә баланслар келген приложение кебек, һәм шул ук биклекләрдә. API өчен нинди дә Abunement яки безнә бесплатно файдарлану юк: һәрбер сорау сиз сатып алган кредитләрдән түләү ителә.

API Нымботның үзенең берничә дәүләм өстәми. Сезнең хәбәрләрегез моделгә аларны ничек җибәргән булсаSes, шундый хәбәр итеп бара: Нымбот системаlı промпты юк, интервью юк, дата яки тел буенча ишаралар да юк. Кайтарга модель җавабы һәм аның каннары ничкә торышы турындагы билге тәкъдим ителә.

Негавиз URLлар

Һәрбер конек точка ... астында яши /api/v1/Билгесез юл кайта була 404 һәм җаңыл метод белән чакырылган мәҗбүри юл кайтара 405, икесе дә JSON форматында.

API һәрBer сайттан киләге cross-origin сорауларға җавап бирә, шуңа күрә браузер страницасы аны чакыра ала. Ләкин браузергә җибәрегән һәр BER нәрсәне дә аны ачкан кеше укый ала, шуга күрә түбәндәгечә мәкаләләрне тик кичеклек ареалы булган ключ белән генә кулланыгыз капСезнең nym белән имзаланган конечлар (ачкычлар, аккаунт суммасы, NWC авто-пополнение һәм акча кайтару) а исключение: браузерда алар Nymbotның үз сайтларына гына җавап бирәләр. Карагыз аккаунт сорауларын имзалау.

Һәрбер JSON телен белән җибәрү Content-Type: application/json. Башы башка төрleләре киткерә 415, шундый жөнгай HTML форма яки text/plain бернисьә бер башка сайттан киләге сорату APIгә җитә алмый. cURL белән, җибәрегез -H "Content-Type: application/json" бергә -d.

API ачкычлары

Ачкычлар приложениеда ясала. Ач API веб- приложение сайдбарында яки Android һәм iOS менюсында, һәм басыгыз Ачкыч яратышМенә аңа исем бир һәм, әгәр теләсәң, кышма һәм срок тәләп ит.

Ачкыч бер генә күрсәтелә. Тәрекле ябышмасдан бирәр кур timings урынга күчертеп алыгыз: Nymbot аның тик ә fingerprints (бәреш) эшемен генә саклай, шуңа күрә ул аны сизге бер генә кайта күрсәтә алмый. Югалган ачкычны кайта алырга яки торнарга кирәк түгел; аны ангартсагыз һәм яңасын ясасагыз була.

Ачкыч шулай}}}, sk-nymbot- 43 төрле әйтекчә, цифр, дефис һәм аидлар белән тултырыла. За application һәр ачкычны үз исеме һәм кыска аралашыш белән күрсәтә, мәсәлән sk-nymbot-Qm7x…c2Lw.

• Ачкыч сезнең имягә тәнле. Ул сезнең балансыгызны тратыла, һәм аны тик сезнең nym гына ясаlı, үзгәрешләр кертә яки аның исемен гаты ясый ала. Ачкычны тотучы һәркем аның белән акча чыга ала, шуңа значит, аны пароль кебек бәяләгез.
• Caps sat-ларда. Ачкычның акчатрап җыелган лимиты булырга мөмкин һәм бу лимит һәр көнне, һәр ҳафта (Дәрнә) яки һәр айны (беренче) 00:00 UTC сәатендә яңдырыла ала. Ул ике балансты да санача: стандарт кредитне 10 sats, Pro кредитен 100 в качестве санача, шулай итека, ул нинди балансның акчасын югалтса да, бу бер теләк диска. Сезнең сорау эшчәнлеге башланарга кадәр, аның максаксинә ирергә мөмкин булган чыгым (бүтсел кредитка кадәр җыелган) лимитның калган суммасына карата билгеләнә. Әгәр ул лимитка җитмәсә, сорау түбәндәгеләр белән баш тартыла: 403 key_limit_reached, хәтәлек лимиттан аз булган җавап киләчәк булса да; хәтәлек ничтән калганlığını һәм лимитның кайта калгынына нигезләнеп язылган. Төшәрлек max_tokens бу иң олукай хәлне бетерә. Заказның баасы аның чыннан да чыгымлы булган суммасыннан алына һәм ул чиккә керә, шулай итеп, әгәр провайдер булып табылганнан артык токеннар турында хәбәр итсә, чиккә тугелгән соңгы заказ чиккә бер аз ашып китерә мөмкин; шундан соңге заказ түгелгә кабул ителми.
• Җителгән калп (cap) чыгымнарны тик генә туктата. Кашкәс җыелган ачкыч һали балансны тикшерергә, тарихын укырга, моделләр исемлеген күрсәтәргә, токеннарны саныйрга, балансны тулдырырга һәм ул башлаган видеоны тикшерәргә мөмкин.
• Мөһел срогын билгеләү ихтыяри. Сез тәябрләгән дата үткәчтән, тоткыч эшләмиdis
• Аңлау аерыту миттә һәм төптән үтә. Аңгарталган ключ киләчәк сорауны үткерелми. Ул тизмедә аңгарталган буlarak кала, шулай итеп аның чыгым тарихыш тә мәгънәле кала.
• Сезнең 25かいкагача актив ачкычларыгыз может, һәрберенең үз исеме була. Ачкычның яңарту периодын үзгәртү — яңа периоды 0нән башлап алып килә.

Шул төбәк лист яңа timescalesда һәм барлыкla һәр ачкычның чыгымнарын, аларның иңгәрәк каччан кулланылганлыгын, ике балансыгызны һәм яңа API сорауларыгызны күрсәтә. Аның артındaki эндpointлар түбәндәге документацияда бирелгән: ачкычларны башкару.

Сүзләшмәләрне тикшерү

Ачкычны бу заголовокларның берсендә җибәрегез. Алар бәлләк исеме, шу yüzden клиент сезнеңдә игътибарсыз калтырган сезгә урамны кулланыгыз:

Табылмаган, билгесез, аннукланган яки вакыты үткән ачкыч кайтара 401, код белән missing_api_key, invalid_api_key, revoked_api_key яки expired_api_keyМодельләрне, аудио модельләрне һәм ү𝗲зләрне исемекләү, шулай ук түләү ысулларын исемекләү өчен ключ кирәк түгел.

Сүрәтләр, видео, һәсәп, транскрипция һәм эмбеддингләрне дә Lightning аша бер бер тапшырма өчен бердән-бер төгәл ключсыз сатып алу мөмкин: ключсыз тапшырма җибәрегез һәм счёт-фактураны түләгез 402 җавап. Кара Ачкычсыз һәр сорау өчен түләү.

Ачкычларны башкару, счёт мәгълүматы һәм автоматтык тутырулар — бер өчтән: алар ачкыч урына сезнең nym-ыгыздан имза алалар, шуңа күрә ачыкланган ачкыч яңа ачкычлар ясый алмый. Карагыз аккаунт сорауларын имзалау.

Сезнең беренче сораугыз

Ачкычны эмергентлек үментерне (environment variable) исемендә куегыз, аннан модельгә берәр нәрсә сорагыз. Бу бит \}$ләр бетләре буенча мисаллар аны шуннан укыйлар 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ның үзенең маршрутлауы, стандарт баланс hefyd түләү ителә. Аның урына каталог моделеId-сын куегыз, мәсәлән: anthropic/claude-sonnet-5, Pro балансынан төрле модельне куллану өчен. Модельләрне исемләү һәрбер idны бирә

Сүзләшүләр ничә колли бәләди

API төлемне exactly приложение кебек исәптә.

• Кайсы баланс. nymbot/auto тратлый стандарт баланс (10 sats кредит). һәр башка чат-модельләр ... Профессионал баланс (100 sats кредит). Стандартлы рәсем генераторы һәм стандартлы ኣብәз генераторлар timescales стандарт кредитләр исәпләгән; башка барлык генераторлар Pro кредитләрен исәпләгән. Embeddings стандарт кредитләр исәпләгән. Транскрипция стандарт баланс аның өчен бирければ стандарт кредитләр исәпләгән, әллә башка хәлләрдә Pro кредитләр исәпләгән. Модельләр исемлеге һәр модель картасын timescales нинди баланс исәпләгән икәнен күрсәтә.
• Ничек. Чат сораусы модель ү réellement укыган һәм языкан токеннар буенча провайдер ялгын نرخнары буенча исәпләнә. Бу цена 5% комиссия өстәп, аннан 1.5 көбетеп алына, шулай итеп сез провайдерның список цененан 1.575 тапкыр акча түләсез. Ул Bitcoinның җитәкче ценасы буенча sats күләгенә әйләнә һәм кредитның миңдәге өлешләре белән түләнә. Проduсцияләр, видео һәм тавыш һәр генерация өчен, һәр секунд өчен яки һәр символ өчен ценалана, ә транскрипция аудионың һәр секунды өчен шул ук комиссия һәм маржа белән исәпләнә. Стандарт рәсем 5 стандарт кредит, стандарт тавыш исә 3 кредит бүләк итеп алына.
• Минималь. Үткәрелгән һәр метрланган сорау кем минимум 0,05 кредит төшә: стандарт баланста — ярым сато, Pro балансында — 5 сато. Кредит өлешләре һәр тапкыр тирәнләп алынырга кирәк түкыл, алар күчтәрелә.
• Токта, аннан соң тукта. Загратма (request) ураторнан алдыннан, сезнең балансыгыздан сез җибәргән нәрсә һәм ул яза алачак токеннарның максималь күләме нигезендә, иң күп бу может акча саклап торыла. ASCII чикләүләреннән тышкы текст UTF-8 байтлары буенча исәпләнә, ә ASCII цифрлары һәм пунктуация билгеләре һәрберсе бер токен була, шулай өчен ნәмезлекләр, код һәм сандар тулы күләмдә саклана. Саклау бүтын кредитлар белән ясала, киммум бер кредит, шуңа күрә һәрбер запросны башлау өчен стандарт баланста тынгы 10 sats яки Pro балансында 100 sats кирәк. Текълар чикләнгән чыгымнар гына алына; калган акча эш тәмамланганда timescales китә. Озын запрос үз саклауын эш якишкә кадәр саклап тота; әрければ сакланган кредитлар жетмәс булса, стрим туктала 402 insufficient_balance ошибка, һәм түгелге ясалган нәрсә өчен акча алына. Әгәр үземлеCost баланс түләп билешәдән күбрәк булса, бүтләп баланс алына, калган сумма түләргә кирәк (owed_sats ...да nymbot объект һәм боشش баланс). Төлләгән акча киләчәк баланска түшкән кредиттарның бернчесеннән түләнә. Төлләнгәнчә, бу баланстагы бернәрсе дә зарлап булмый: ни API, ни приложениедагы җаваплар, ни акча күчертү яки бүләк итү аша.
• Кредит жетлырмый. Әгәрде баланс блокка алынган сумманы cover итә алмаса, ул шулにく китте: 402 һечкере прежде ягу. Хата нинди баланс жетэшмәве, сурау нинди сатлар кирәклеген һәм нинди галли икәнен әйте ]. Кечкеннере max_tokens бу беер кечкерәк калдырыш диганне аңлата.
• Төрсенешләр. Тәгаш ясауның куелмавы бернәрсе дә туландырмай, әгәр провайдер куелмас яратып эшләгән эш өчен акча туласа, яки интернет эзләү яки nymbot/auto задача тикшерү үткәлгән булса; шунда сез £0.05 кредиттен кем, төгәл. Сез азат иткән стрим провайдер хәбәрләгән токеннар өчен түләнә: Nymbot шул саны тулы авазын алу өчен сез чыгып киткәчнән соң провайдерның стримын 25 секундка кадәр укып тора. Әгәр ул килмәс исә, түләү сез җибәргән һәм язылган нәрсәдән балылауyla исәпләнә, ә логик юллый модель өчен бу тәмамлап булган чыгарышның барлык лимитын э включает. Аерылу произошедши бәйләнешле сораулар тәмамлана һәм түләнеш була.
• Интернет эзләү һәр тикшереп торганда, модель җавап бирсен яисә билгеләп төшсен, тикшереү һәрвакыт sats-кка әйләндерелгән $0.008 стоят. Ул укыйган биtotalPages да модельгә керү эlemэнтләре качестве өлеше була, шуңа күрә алар үз токеннарын өстәләр.

Һәрбер җавап аның кадәр стоятлыгын әйтә. 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 тагамаллаганнан бик better.

Хәтерләр

Һәрбер хато бер тегеллеккә ия, 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).
• Стриминг-заGR@т, ул беренче байт алынганга кадәр файлдә очраса, ивентылар стримы түгел, ә выше статуслы гади JSON шляхлы хата була. Стрим башлангачтан соңгы очраган хата стримның последний ивенты булаlarak, шу нүктеләрнең үз форматында җибәрелә.

Хәтә хәбәрләре башка сервисның эчке мәгълүматларын никогда тотмам. Провайдерның үз хәтәсе сезгә җиткәнчы кайта языла.

Чикләр

Суратка караган сыллык публик хостқа барып кал должен: шәбәкәтнең шәхси яки локаль адресы яки Nymbotның үз сайтындагы адрес кабул ителми. Приложениедә кулланыла торган провайдер темпоральえлешмәсе биредә дә эшли, шуңа күрә бер лә провайдергә күпләгән таләпләрне җибәрү, кичектерү түгел, ә темпораль еллаштыру аша чирелешә мөмкин.

API нинди нәрсә күрә алади

API приложениеләр кебекэ приват түгел, һәм бу нинди икәнен төгәл әйтәргә дөрес.

• Бу озынлыктан озын шифрләнешне тәэмин итми. Приложениядә хәбәр сезegезнең устройствегендә махсус кодланган, аны Nymbot гына ач ала һәм ул... качестве тик калганнарна җитмәгән хәбәр була сыйлагыч белән кагаз белән тутыру. API запиты — гади HTTPS: ул Nymbot я terraces кенә кайтып киләсендә шифрлана, ә Nymbot сервере аны эшчәнлеккә кабул итү өчен ачык күнекмәдә укый.
• Промптлар һәм җаваплар сакланмый. Алар модельгә үтәләр һәм җавап керә. Сакланып кала ук счёт: һәр сорау өчен вакыт, модель, төр, токенлар саны, чыгым, баланс, ключ һәм уңышлы булганмы дигән җавап, 90 көн өчен, ул нәрсә... сораулар тарихы сиңа күрсәтә. Шул ук сорауның файдалану көтерүе (вакыт, төрле, модель, токен саны, чыгым, дәвамлылыгы һәм веб-эзтәүне кулланырганы яки уңышлы булганы) приложения үзенең көтерүләре белән бергә 90 көн өчен саклана.
• Ным өчен башка барлык вейсыллар кечкенә һәм монда күрсәтелгән. API ачкычлары хэш исеме белән сакланалар, ачкыч түгел; аларның исеме, кыска ишарасы, чыгындарга чиге, яңартү периоды, срокту катнату вакыты һәм алар ясалган һәм кулланылган вакытлары белән бергә; тик иң яңа 50 ангалтылган ачкыч гына саклана. А Автоматлы тултыру кошелек bağlantы саклана шифрланган, аның чиккалыгы, суммасы һәм соңгы тутырыу нәтиҗәсе белән бергә. Видео эшләр 24 сәгатькә саклана. һәр арыз өчен түләүләр 7 көнлеккә Lightning түләү хешен һәм 30 көнлеккә хэшланган кайтарыш токенын гына калдыра, алар никемгә дә бәйләнешле түгел. Баланс белән түләп булмыйган түләүләр тутырыу ясалгачка кадәрCarн төләм буларак саклана.
• Мәгълүматны сызып ташлау приложениены үчерә. A тәхәтне чиндирү барлык API ачкычларын ангалатып уңыштын һәм сурау тарихын, куллану бердәмлекләрен, кошелек толанышын һәм видео эшләрне үчер. Баланс һәм һали төләмләр nymдә кала.
• Модель провайдеры сезне сорауны күредә, кебек приложениедән эшләгән кебек. Каталог модельләр үз ясаучыларында эшли; стандарт юллар һәм embeddingләр Cloudflareдә эшли.
• Генерацияланган медиа ачык. Сүрәтләр һәм видеолар сылкеләр ирелә итеп бирү Blossomның публик файл хостингнарына юклана, анда файлның адресы аның хэш-коды булып тора. Сылке эйдәле һәркем аны ача ала һәм Nymbot аны кайтадан алырга алмый. Сора... b64_json һәм җиткерүдә яңадан ясалган рәсем килә һәм ул һич каччан юкладылмый.
• Дänen туа бирген рәсемнәр генератормы? Сез юкладырган рәсем тәҗриба белән үткәрү, яки а වශයෙන් җибәрегез data: Генераторның URL-ы image_url, алгач Blossom хостына җа publiques итеп юклана, шунда генератор аны алырга мөмкин була, һәм бу үзенсе аңа да кагылышлы. җибәрелгән рәсем https:// ссылка сол ссылка буларак үткәрелә. Чат соравындагы рәсемнәр модель провайдерына бара, Blossom-га түгел.
• Ачкыр сезнең nym белән бәйләнгән. Ачкыш саклаган һәр нәрсә сезнең nymъ балансыңнан алына, шуңа күрә API куллану... анонимӘгәрде сезнең күнлек nym-ыннан төрле булган API кулланырга теләсәгез, ачкычларны үз балансы булган башка nym аша ясагыз.

Әгәр сегә приложениеларның курканышы кирәк булса, приложениеларны кулланыгыз. API модельләр үз инструментларыгызда кирәк булганда өчен.

Һәрбер конеч пункт

“Nym” — ул сезнең Nostr ачкычыгыз белән куелган, түбәндәгечә тасвирланган ышара. аккаунт сорауларын имзалауБу форматларны узача сөйләгән инструментлар өчен, карагыз инструментлар һәм SDKлар, ә Claude Code, Codex һәм Cline кебек код язу агентлары өчен карагыз кодлау инструментнары.