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

APIге кыскача обзор

Тиркемеде сиз колдонгон моделдер, генераторлор жана баланс — өз кодуңуздан. API OpenAI жана Anthropic форматтарын колдонот, ошондуктан көпчүлүк куралдар жана SDKs негизги URL жана ачкычты өзгөртүү менен иштейт.

Бул барак ыңгайлуулук үчүн машинада которулган. Англисче оригиналдуу версия колдонулат.

API деген эмне

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

• Chat Completions, Жооптор API жана Anthropic билдирүүлөрү, стриминг, куралдар, сүрөттөр, ой жүгүртүү жана веб издөө менен, ар бир модель үчүн каталог жана Nymbot'тун өзүнүн автоматтык маршрутташтыруусу үчүн.
• Сүрөттөр, видео, сөз, транскрипция жана эмбеддингдер.
• Сиздин баланс, Lightning толуктоолор, Сиздин капчыгыңыздан автоматтык түрдө толуктоолор жана тарых ар бир суроо-талаптын канча туранды

Ал ошол эле экөөдөн төлөнөт баланстар тиркеме сыяктуу эле, башкача баада эмес. API үчүн жазылуу же акысыз лимит жок: ар бир суроо-талап сиз сатып алган кредиттерден төлөнөт.

API Nymbot'дун өзүнөн эч нерсе кошпойт. Сиздин билдирүүлөрүңүз моделге кандай жөнөтүлсө, ошондой бойдон барат: Nymbot'тун системалык промпту жок, эс тутум жок, дата же тил боюнча белгилер жок. Кайра келген жооп — бул моделдин өз жообу жана анын баасы тууралуу эскертүү.

Негизги URL-лар

Ар бир чекит төмөнкүнүн алдында жайгашат /api/v1/Белгисиз жол кайтып келет 404 жана туура эмес метод менен чакырылган белгилүү жол кайтарылат 405, экөө тең JSON форматында.

API каалаган сайттан келген cross-origin суроолорго жооп берет, ошондуктан браузердин баракчасы аны чакыра алат. Бирок, браузерге жөнөткөн нерсеңиздин баарын аны ачкан адам окуй алат, ошондуктан муну кичинекей... капСиздин nym (ачкычтар, аккаунттун кыскача маалыматы, NWC автоматтык түрдө толуктоо жана кайтарым алуу) менен кол коюлган чекиттер өзгөчө болуп саналат: браузерде алар Nymbot'тун өзүнүн сайттарына гана жооп беришет. Караңыз аккаунт сурамдарын кол коюу.

Ар бир JSON денесин ... менен жөнөтүңүз Content-Type: application/json. Башка тип менен четке кагылат 415, ошондуктан жөнөкөй HTML формасы же а text/plain башка сайттан келген суроо API'ге жетпей жатат. cURL менен, өткөрүп бериңиз -H "Content-Type: application/json" менен бирге -d.

API ачкычтары

Ачкычтар тиркемеде жасалат. Ачуу API веб-тиркеменин каптал менюсунда же Android жана iOS менюсунда жана басыңыз Ачкыч түзүүАга ат коюңуз жана, эгер кааласаңыз, чектөө жана жарактуулук мөөнөтүн белгилеңиз.

Ачкыч бир жолу гана көрсөтүлөт. Баракчаны жапканга чейин аны коопсуз жерге көчүрүп алыңыз: Nymbot анын фингерпринтин гана сактайт, ошондуктан ал аны сизге кайра көрсөтө албайт. Жоголуп кеткен ачкычты кайра калыбына келтирүү мүмкүн эмес; аны жокко чыгарып, жаңысын жасаңыз.

Ачкыч ... сыяктуу көрүнөт sk-nymbot- андан кийин 43 тамга, цифра, сызыкча жана ал underscored (төмөн шилтеме) келет. Тиркеме ар бир ачкычты өзүнүн аталышы жана кыскача эскертүүсү менен тизмелейт, мисалы sk-nymbot-Qm7x…c2Lw.

• Ачкыч сенин nym-иңан таандык. Ал сиздин балансыңызды колдонот жана аны сиздин nym гана түзө, өзгөртө же жокко чыгара алат. Ачкычты кармаган каалаган адам аны менен балансты жумшай алат, ошондуктан аны сырсөз сыяктуу сактаңыз.
• Каппалар саттарда. Ачкычтын чыгаша лимити болушу мүмкүн жана бул лимит күн сайын, жума сайын (дүйшөмбү) же ай сайын (биринчи күнү), 00:00 UTC убактысында кайра орнотулушу мүмкүн. Ал эки балансты тең эсепке алат: стандарттык кредитти 10 сатоши, ал эми Pro кредитин 100 сатоши катары эсептейт, демек, суроо-талап кайсы балансты колдонуп жатса да, жыйынтык бирдей болот. Суроо-талап аткарыла электе, анын максималдуу наркы (бүтүн кредиттерге тегеректелген) лимитте калган суммага карата коюлат. Эгерде ал лимиттин алкагына кирбесе, суроо-талап төмөндөгүдөй четке кагылат: 403 key_limit_reached, ал тургай жооп чектөөдөн ашпаган болсо да; ката билдирүү канча калганын жана чектөө качан кайра башталарын айтат. Төмөндөтүү max_tokens бул эң начар вариантты азайтат. Суроо-талап анын иш жүзүндөгү баасы канча болсо, ошончо суммада алынат жана ал чектөөгө кошулат, ошондуктан эгерде провайдер бөлүнгөнчө токендерден көбүрөөк отчет берсе, чектөөгө туура келген акыркы суроо-талап ачкычты чектөөдөн бир аз ашырып кетиши мүмкүн; андан кийинки суроо-талап четке кагылат.
• Чыгымдалып бүткөн капитал чыгашаны гана токтотот. Ачкычтын өзүнөн өзү балансты текшерүүгө, тарыхын окууга, моделдердин тизмесин чыгарууга, токендерди саноого, балансты толтурууга жана мурун баштаган видеосун текшерүүгө мүмкүндүк берет.
• Мөөнөтүн бүтүү кажетил эмес. Сиз белгилеген датадан кийин ачкыч иштебей калат.
• Алуу дароо жана акыркы болуп саналат. Жогорулкуну артка кайтарган ачкыч кийинки суроо-талапты аткара албайт. Ал тизмеде жокко чыгарылган белгиси менен калат, ошондуктан анын короно турган тарыхы логикалык жактан туура бойдон калат.
• Сизде ар биринин өзүнүн аталышы бар 25 чейин активдүү ачкыч болушу мүмкүн. Ачкычтын кайра орнотуу мезгилин өзгөртүү нөлдон баштап жаңы мезгилди баштайт.

Ошол эле баракчада ар бир ачкычтын ушул мезгилдеги жана жалпы чыгымдары, акыркы колдонулган убактысы, экөөңүздүн баланстарыңыз жана сиздин акыркы API суроолоруңуз көрсөтүлөт. Анын иштеген эндпоинттери төмөнкү жерде документтештирилген: ачкычтарды башкаруу.

Сурамды тастыктоо

Ачкычты бул заголовоктардын биринде жөнөтүңүз. Алар барабар, ошондуктан кардар @client сиздин кайсынысын стандарттуу түрдө жөнөтсө, ошону колдонуңуз:

Жоголгон, белгисиз, жокко чыгарылган же мөөнөтү өткөн ачкыч кайтарылат 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 балансынан ал модельди колдонуу үчүн Моделдерди тизмектөө ар бир ID'ни берет.

Суроо канча турат

API эсептегенде так тиркемедей эле эсептейт.

• Кайсы баланс. nymbot/auto чыгындарат стандарт баланс (10 sats кредит). Ар бир башка чат моделдери... Профессионал баланс (100 sats кредит). Стандарттык сүрөт генератору жана стандарттык үн стандарттык кредиттерди сарптайт; калган бардык генераторлор Pro кредиттерди сарптайт. Embeddings стандарттык кредиттерди сарптайт. Транскрипция стандарттык баланс жата бергенде стандарттык кредиттерди, болбосо Pro кредиттерди сарптайт. Моделдердин тизмеси ар бир модель кайсы балансты сарптай турганын көрсөтөт.
• Канча? Чат суроо-талаптары провайдердин жарыялаган тарифлери боюнча моделдин иш жүзүндө окуган жана жазган токендерине жараша эсептелет. Ал баага 5% комиссия кошулуп, андан кийин 1.5га көбөйтүлөт, ошондуктан сиз провайдердин баасынан 1.575 эсе көп төлөйсүз. Ал учурдагы Биткоин баасы боюнча сатсге (sats) айландырылып, кредиттин миңден бир бөлүгү менен алынат. Профессионалдык сүрөттөр, видео жана сүйлөө ар бир генерация үчүн, ар бир секунд же ар бир белги үчүн бааланса, транскрипция аудионун ар бир секунду үчүн ошол эле комиссия жана маржа менен бааланат. Стандарттык сүрөт 5 стандарттык кредитти, ал эми стандарттык үн 3 кредитти турат.
• Минималдуу. Ар бир эсептелген суроо-талап кеминде 0.05 кредит турат: стандарттык баланста жарым сат, Pro баланста 5 сат. Кредиттин бөлчөктөрү ар бир жолу тегеректенип эмес, кийинкиге өткөрүлүп турат.
• Күт, анан жайгаш. Сурам аткарыла электе, сиз жиберген маалыматка жана жазылышы мүмкүн болгон максималдуу токендердин санына жараша, эң көп дегенде мүмкүн болгон чыгым балансыңыздан кармалып калат. Жөнөкөй ASCIIден тышкаркы текст UTF-8 байттары боюнча өлчөнөт, ал эми ASCII цифралары жана тыныш белгилери ар бири бир токен катары эсептелет, ошондуктан каалаган жазуу түрүндөгү текст, код жана сандар толук көлөмдө кармалат. Броньлоо бүтүн кредиттер менен жүргүзүлөт, кеминде бир кредит, ошондуктан каалаган сурамды баштоо үчүн стандарттык баланста кеминде 10 sats же Pro баланста 100 sats болушу керек. Иш жүзүндө гана чыгым алынат; калган сумма сурам аткарылып бүткөндө кайтарылат. Узак сурам өзүнүн броньун аткарылып жаткан убакыттын ичинде сактайт; эгер кармалган кредиттер жеткиликтүү болбой калса, агым токтоп калат 402 insufficient_balance ката учуру, жана түзүлгөн сумма эсептен чыгарылат. Эгерде иш жүзүндөгү чыгым баланстагы каражаттан ашып кетсе, бүтүндөй баланс алынат, калган сумма карыз калат (owed_sats ичинде nymbot объект, жана терс баланс). Карыз болгон сумма ал баланска түшкөн кийинки кредиттерден биринчи кезекте төлөнөт. Ал төлөнгөнгө чейин, ал баланстагы эч нерсени коротууга мүмкүн эмес: API тарабынан да, колдонмодагы жооптор менен да, которуу же белек аркылуу да.
• Кредит жетишсиз. Эгерде баланс бөгөттөлгөн сумманы жабууга жетпей калса, өтүнч төмөнкүдөй четке кагылат 402 эч нерсе иштебей турганда. Ката кайсы баланс жетишсиз экенин, суроо канча sat керек экенин жана канчасы бош экенин көрсөтөт. Кичинекей max_tokens кичинекей кармоо дегенди билдирет.
• Ийгиликсиздиктер. Ишке ашпаган суроо-талап эч нерсеге туш келбейт, эгерде провайдер ишке ашпай тургандан мурун аткарган иши үчүн төлөм күүлөбөсө же веб-издөө же nymbot/auto тапшырма ал мурда иштеп калган болсо; анда сиз аประชาлык төлөйсүз, кеминде 0.05 кредит. Сиз үзүп салган поток үчүн провайдер билдирген токендер үчүн төлөм алынат: Nymbot ошол санды алуу үчүн сиз чыгып кеткенден кийин провайдердин потогун 25 секундка чейин окууну улантат. Эгерде ал келбесе, төлөм сиз жөнөткөн жана жазылган нерселерден баалансын, ал эми логикалык ой жүгүртүүчү модель үчүн бул холдин бардык чыгарылыш лимитин камтыйт. Байланышы үзүлгөн суроо-талап да бүтөт жана акы алынат.
• Веб издөө ар бир издөө жүргүзүлгөндө, модель жооп берсе да, ал эми иштебей калса да, издөөгө 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).
• Биринчи байты келгенге чейин ишке ашпай калган стриминг суроосу жогорудагы статус менен кадимки JSON катасы катары берилет, окуялардын агымы (event stream) катары эмес. Стрим башталгандан кийинки ката ошол эндпоинттин өзүнүн форматында стримдин акыркы окуясы катары жөнөтүлөт.

Ката билдирүүлөрү башка кызматтын ички маалыматтарын эч качан камтыбайт. Провайдердин өзүнүн катасы сизге жеткенге чейин кайра түзүлөт.

Чектөөлөр

Сүрөттүн шилтемеси ачык хостко багытталышы керек: жеке же жергиликтүү тармактагы даректерди же Nymbot'тун өз сайттарындагы даректери баш тартат. Тиркемеде колдонулуучу провайдердин темптөөсү бул жерде да жарактуу, ошондуктан бир провайдерге жиберилген сурамдардын көптүгү ката берип токтотулбай, анын ылдамдыгын азайтуу аркылуу иштетилиши мүмкүн.

API эмнени көрө алат

API тиркемелер сыяктуу купуя эмес жана бул эмне экенин так айтууга арзыйт.

• Ал учурдан учурга шифрленген эмес. Тиркемелерде, билдирүү сиздин түзмөгүңүздө Nymbot гана ээлик кылган ачкычтар менен мөөр толтурулат жана төмөнкүдөй жөнөтүлөт: подарочтуу кагазга ороо. API суроосу — бул кадимки HTTPS: ал Nymbot'ко бара жаткан жолу шифрленет, ал эми Nymbot'тун сервери аны иштетүү үчүн ачык түрдө окуйт.
• Суроолор жана жооптор сакталбайт. Алар моделге өтөт жана жооп кайра кайтып келет. Сакталып калган нерсе — эсеп: ар бир суроо үчүн убактысы, модели, түрү, токендердин саны, баасы, балансы, ачкычы жана ийгиликтүү болгон-болбогону, 90 күндүк мөөнөткө, бул эмне дегенди билдирет сурамдардын тарыхы сизге көрсөтөт. Ошол эле сурамдын колдонуу тарыхы (убактысы, түрү, модели, токендердин саны, баасы, узактыгы жана веб издөө колдонулганы же ийгиликтүү болгону) колдонмонун өзүнүн тарыхы менен бирге 90 күн бою сакталат.
• nym үчүн башка бардык нерселер кичинекей жана ушул жерде тизмеленген. API ачкычтары хэш катары сакталат, эч качан ачкыч катары эмес, алардын аты, кыскача белгиси, чыгарып салуу чеги, кайра орнотуу мезгили, мөөнөтү жана алар качан түзүлгөнү жана акыркы жолу качан колдонулганы менен бирге; жокко чыгарылган ачкычтардын эң акыркы 50 гана сакталат. An автоматтык түрдө толуктоо капчык байланышы шифрланган түрдө сакталат, анын босогосу, суммасы жана акыркы толуктоонун жыйынтыгы менен бирге. Видео тапшырмалар 24 саатка сакталат. Ар бир чалуу үчүн төлөнүүчү сурамдар 7 күнгө Lightning төлөмүнүн хешин жана 30 күнгө анонимдүү түрдө байланыштырылган хештелген кайтарым токэнин гана калтырат. Баланс жаба албаган төлөмдөр толуктоо жүргүзүлгөнгө чейин карыз катары сакталат.
• Тиркемени сүзүү аны өчүрөт. A Түзүлүштү тазалоо бардык API ачкычтарын жок кылат жана алып салат, ошондой эле суроо-талаптардын тарыхын, колдонууну, капчыкка байланыштырууну жана видео тапшырмаларды жок кылат. Баланс жана карыз болгон бардык төлөмдөр nymде калат.
• Моделдин провайдери сиздин сурооңузду көрөт, тиркемеден болгондой эле. Каталог моделдери өз жасаган адамдарында иштейт; стандарттуу маршруттар жана эмбеддингдер Cloudflare платформасында иштейт.
• Генерацияланган медиа коомчулукка ачык. Шилтеме катары берилген сүрөттөр жана видеолор ачык Blossom файл хостторуна жүктөлөт, ал жерде файлдын дареги анын хеши болуп саналат. Шилтемеси бар каалаган адам аны ача алат жана Nymbot аны кайра алып сала албайт. Сураңыз... b64_json жана жоопто түзүлгөн сүрөт келет жана ал эч качан жүктөлбөйт.
• Демек, сиз берген сүрөттөр генераторбу? Сиз жүктөй турган сүрөт түзөтүү, же ... катары жөнөтүңүз data: генератордун URL'ү image_url, алгач генератор аны алса боло турган ачык Blossom хостуна жүктөлөт, ошол эле нерсе бул үчүн да колдонулат. Сүрөт жөнөтүлсө https:// шилтеме ошол шилтеме катары өткөрүлөт. Чат суроосундагы сүрөттөр модельдин провайдерине жөнөтүлөт, Blossom'го эмес.
• Ачкыч сиздин nym менен байланышкан. Ачкыч жумшаган бардык нерселер сиздин nym'дин балансынан кемитилет, ошондуктан API колдонуу эмес анонимдүүЭгер сиз API'ны күнүмдүк nym'иңизден бөлүп колдонгуңуз келсе, анда ачкычтарды өзүнүн балансы бар башка nym'ден жасаңыз.

Эгер сизге колдонмолордун коргоосу керек болсо, колдонмолорду колдонуңуз. API моделдер өз куралдарыңызда керек болгон учурлар үчүн.

Ар бир чекит (endpoint)

“Nym” сиздин Nostr ачкычыңыз менен кол коюлган сурамды билдирет, ал төмөнкүлөрдө сүрөттөлгөн аккаунт сурамдарын кол коюуБул форматтарды колдогон куралдар үчүн, төмөнкүлөрдү караңыз: куралдар жана SDKs, ал эми Claude Code, Codex жана Cline сыяктуу код жазуучу агенттер үчүн, караңыз коддоо куралдары.