Batayan ng kaalaman / mga developer

Paglalarawan ng API

Ang mga modelo, generators at balance na ginagamit mo sa app, mula sa iyong sarili na code. Ang API ay nagsasalita sa OpenAI at Anthropic format, kaya ang karamihan ng mga tool at SDK ay gumagana sa pamamagitan ng pagbabago ng isang base URL at isang key.

Ang pahinang ito ay isinalin sa makina para sa kaginhawahan. Ang orihinal na Ingles ay ang bersyon na naaangkop.

Ano ang Fire

Ang isang HTTP API ay nymbot.ai na tumugon sa parehong mga pangangailangan ng isang OpenAI o Anthropic client na nagpadala. Ikaw ay makakuha ng:

• Mga Kompleto ng Chat, ang Mga Reply sa API at Mga mensahe ng Anthropic, na may streaming, mga tool, mga imahe, pag-argument at web search, para sa bawat modelo sa ang catalogue at para sa Nymbot's own auto-routing.
• mga imahe, ang video, Tungkol sa, ang transcription at mga embeddings.
• Iyong Balanse ang, Mga pahinang tumuturo sa top-ups, Automatic top-ups mula sa iyong wallet sa a istorya Ano ang kinakailangan ng bawat request?

Ito ay binabayaran ng parehong dalawang Balanse ang Walang subscription at walang free allowance sa API: ang lahat ng mga request ay binayaran mula sa mga credits na nabili mo.

Ang iyong mensahe ay pumunta sa modelo kapag nagpadala mo ang mga ito: walang Nymbot system prompt, walang memory, walang petsa o language hints.

Basahin ang URL

Lahat ng mga endpoints ay may /api/v1/Isang Unknown Path Returns 404 at ang isang kilala na path na tinatawag na may mga error method ay bumalik 405Ang mga ito ay JSON.

Ang API ay tumugon sa cross-origin requests mula sa anumang site, kaya ang isang browser na pahina ay maaaring i-call ito. Ang anumang bagay na i-send sa isang browser ay maaaring i-read sa pamamagitan ng sinuman na i-open ito, kaya gawin ito lamang sa isang key na may isang maliit na ang capAng mga endpoints signed sa iyong nym (keys, account summary, NWC auto-top-up at refund redemption) ay ang pagkakaiba: sa isang browser sila ay tumugon lamang sa mga site ng Nymbot. Pangalan ng mga Request Account.

I-send ang lahat ng JSON body Content-Type: application/jsonAng lahat ng mga bagay ay inihayag sa 415, kaya ang isang simpleng HTML form o a text/plain Pagkatapos ng pag-request ng isang site, hindi mo makakakuha ng API. With cURL, -H "Content-Type: application/json" sa pamamagitan ng -d.

ang fire keys

Ang mga key ay ginawa sa app. Open ang fire sa sidebar ng web app, o sa menu sa Android at iOS, at i-tap Paggawa ng KeyGawin ito ng isang pangalan at, kung gusto mo, isang cap at isang petsa ng katapusan.

I-copy ito sa isang safe place before you close the sheet: Ang Nymbot ay nagbibigay lamang ng isang fingerprint ng ito, kaya ito ay hindi maaaring ipakita sa iyo sa taas. Ang isang lost key ay hindi maaaring i-recover; i-revoke ito at gumawa ng isang bagong.

Ang isang key ay sk-nymbot- Nagsimula sa pamamagitan ng 43 letters, digits, dashes at underscores. Ang app lists ang bawat key sa pamamagitan ng kanyang pangalan at isang short hint tulad ng: sk-nymbot-Qm7x…c2Lw.

• Ang isang key ay nasa iyong nym. Ito ay gumagamit ng iyong balanse, at lamang ang iyong nym ay maaaring gumawa, baguhin o i-revoke ito. Anyone holding the key can spend with it, kaya magtatrabaho ito tulad ng isang password.
• Ang mga ito ay sa sats. Ang isang key ay maaaring magkaroon ng isang spending cap, at ang cap ay maaaring i-reset araw-araw, araw-araw (Monday) o araw-araw (ang unang), sa 00:00 UTC. Ito ay binubuo ang parehong balanse, ang isang standard credit bilang 10 sats at ang isang Pro credit bilang 100, kaya ito ay nangangahulugan na ang parehong balanse kung saan ang isang request ay binibigay. 403 key_limit_reachedPero kapag nalaman niyang nakilala mo siya dahil binasa mo ang diary... get ready for the consequences. max_tokens Ang isang request ay naka-charge kung ano ang tunay na gastos at kung ano ang ibinigay laban sa cap, kaya kung ang provider ay inilathala ng higit sa mga tokens kaysa sa nakalipas, ang huling request na matatagpuan ay maaaring makuha ang key isang maliit na higit sa kanyang cap; ang susunod na ito ay inihayag.
• Ang isang nakalipas na cap lamang ay nagsisimula ng gastos. Ang isang key sa kanyang cap ay maaaring i-check ang balance, i-read ang kanyang kasaysayan, i-list ang mga modelo, i-count ang tokens, i-top up at i-check ang isang video na ito ay nagsimula.
• Ang Expiry ay optional. Pagkatapos ng petsa na itakda, ang key ay hindi gumagana.
• Ang revocation ay immediate at final. Ang isang revoked key ay hindi nag-aalok ng kanyang susunod na request. Ito ay matatagpuan sa listahan, na sinubukan na revoked, kaya ang kanyang history ng gastos ay pa rin makakalimutan.
• Maaari kang magkaroon ng hanggang sa 25 active keys, bawat isa sa kanyang sarili na pangalan. Ang pagbabago ng reset ng isang keys ay nagsisimula ng isang bagong panahon mula sa zero.

Ang parehong pahina ay nagpapakita ng gastos ng bawat key sa panahon na ito at sa kabuuan, kapag ito ay ginagamit na unang, ang iyong balanse, at ang iyong mga nakaraang mga pangangailangan ng API. Pangalan ng mga keys.

I-authenticate ang isang request

I-send ang key sa anumang mga headers na ito. Ang mga ito ay katumbas, kaya gamitin ang kung ano ang iyong client ay nagpadala sa default:

A missing, unknown, revoked or expired key return 401Sa pamamagitan ng code missing_api_key, invalid_api_key, revoked_api_key o sa expired_api_keyAng listahan ng mga modelo, mga modelo ng audio at mga salita, at mga paraan ng pagbabayad ay hindi kinakailangan ng isang key.

Pictures, video, speech, transcription at embeddings ay maaari din magbayad para sa isang request sa isang oras sa pamamagitan ng Lightning nang walang key sa lahat: ipadala ang request nang walang isa at magbayad ang invoice sa 402 Ipinapakita ang Pagbabayad sa pamamagitan ng request na walang key.

Ang key management, ang account summary at ang automatic top-ups ay ang pagkakaiba: sila ay makuha ng isang signature mula sa iyong nym sa halip ng isang key, kaya ang isang leaked key ay hindi maaaring gumawa ng higit pa ng mga keys. Pangalan ng mga Request Account.

ang first request

Ipasok ang key sa isang environment variable, pagkatapos ay magtanong ng isang modelo ng isang bagay. Ang mga halimbawa sa lahat ng mga pahina na ito ay nabasa mula sa 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 ay ang Nymbot's own routing, pagbayad mula sa standard balance. Ipasok ang isang catalog model's id dito sa lugar, tulad ng anthropic/claude-sonnet-5, upang gamitin ang modelo mula sa Pro balance. Listahan ng mga modelo Gawin ang lahat ng id.

Ano ang isang request cost

Ang API bills eksaktong kung paano ang app ay gawin.

• Ano ang balanse. nymbot/auto Gawin ang ang standard balance (10 sats a credit). Ang lahat ng iba pang mga modelo ng chat ay gumagamit ng ang pro balanse (100 sats isang credit). Ang standard image generator at ang standard voice spend standard credits; lahat ng iba pang generator spend Pro. Embeddings spend standard credits. Transcription spend standard credits kapag ang standard balance can cover it, at Pro credits sa iba pa. Ang list ng mga modelo ay sabi kung ano ang balance ng bawat modelo spends.
• Ano ang maraming. Ang isang pag-chat request ay matatagpuan sa mga tokens na ang modelo ay tunay na nabasa at nabasa, sa mga rate na inilathala ng provider. Ang presyo ay may isang 5% fee na idinagdag at pagkatapos ay na-multiply sa 1.5, kaya magbayad ka ng 1.575 beses ang mga presyo ng listahan ng provider. Ito ay na-convert sa sats sa live Bitcoin presyo at na-charge sa mga thousandths ng isang credit. Pro pictures, video at speech ay na-priced per generation, per second o per character, at transcription per second ng audio, na may parehong fee at margin. Ang standard na larawan ay isang flat 5 standard credits at ang standard voice ay isang flat 3.
• ang minimum Ang bawat metric request na gumagana ay nagkakahalaga ng hindi bababa sa 0.05 credit: half a sat sa standard balance, 5 sats sa Pro. Ang mga fractions ng isang credit ay naka-transport, hindi rounded up bawat pagkakataon.
• Pagkatapos ay i-set up. Kapag bumalik na ako sa UP, i'll start building a new me. Ibig sabihin, not counted... hindi ibig sabihin kapuri-puri ka dahil marami kang tinapos na kurso. marami kang tinapos na kurso. 402 insufficient_balance Ang maliliit na negosyo sa mga sumusunod na sektor ay kinakailangan: pagproseso ng produktong agrikultural (owed_sats sa mga nymbot Object, at isang negatibo na saldo). Ang kung ano ang kinakailangan ay binabayaran sa unang mula sa mga sumusunod na mga credits na dumating sa saldo na ito. Upang ito ay binabayaran, walang bagay sa saldo na ito ay maaaring i-spend: hindi sa pamamagitan ng API, mga reply sa app, isang transfer o isang regalo.
• Hindi na kailangan ng credit. Kung hindi ka makakakuha ng account, ang request ay inalis. 402 Ang error ay nagpapakita kung ano ang balanse ay short, kung ano ang mga sats na kinakailangan ng request at kung ano ang ilang ay libre. max_tokens Ito ay isang maliit na hold.
• ang mga failure. Ang isang pag-aayos na pag-aayos ay walang gastos, kung hindi ang provider inilathala para sa trabaho na ginawa nito bago ang pag-aayos, o isang web search o ang pag-aalala ng pag-aayos. nymbot/auto Task check ay na-run; pagkatapos ay ito ay kung ano ang iyong magbayad, halos 0.05 credit. Ang isang stream na i-cut ay inilathala para sa mga tokens na inilathala ng provider: Nymbot ay patuloy na mag-read ang provider's stream para sa hanggang sa 25 segundo pagkatapos mo pumunta upang makakuha ng na count. Kung ito ay hindi dumating, ang karagdagang ay inihayag mula sa kung ano ang i-send at kung ano ang inilathala, at para sa isang modelo na mga dahilan ito ay naglalaman ang buong output allowance ng hold.
• Paghahanap WEB gastos $0.008 isang paghahanap, na i-convert sa sats, sa lahat ng isang paghahanap ay dumating, kung ang modelo ay pagkatapos ay tumugon o hindi. Ang mga pahina na ito ay inilathala ay din ibinigay sa modelo bilang input, kaya hinihikayat nila ang kanilang tokens.

Ang lahat ng mga responses ay sinasabi kung ano ang gastos. JSON responses carry a nymbot ang object na may balanse na itinatag mula sa kanya, ang load sa credits at sats, at kung ano ang ibinigay:

ang cost object

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

Ang mga pagbabayad na mga salita ay may mga headers na ito, na kung saan upang makikita ang gastos ng isang salita na hindi JSON, tulad ng salita:

Ang mga rate per million tokens, na naglalaman ng fee at margin, ay sa Listahan ng mga modelo sa mga dollar at sats, at sa ang price sheetKung hindi makikita ang presyo ng Bitcoin, i-return ang mga nangangailangan ng pagbabayad 503 price_unavailable sa Retry-After: 60 Sa halip naman ng guessing.

Mga error

Ang lahat ng mga error ay may parehong format, ang isa na ang mga client ng OpenAI na ngayon ay malaman. code ang isang stabilong pangalan na maaari mong matatagpuan sa; message Ito ay para sa mga tao at maaaring magbabago.

ang body error

{
  "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
  }
}

Dalawang mga exception:

• /api/v1/messages ang mga solusyon sa format ng error ng Anthropic, dahil ito ay kung ano ang mga client ng Anthropic parse: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Ang uri ay sumusunod sa status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error o sa overloaded_error (503).
• Ang isang pag-streaming request na nangangailangan bago ang kanyang unang byte ay makakuha ng isang normal na JSON error na may status sa itaas, hindi isang event stream.

Ang mga mensahe ng error ay hindi naglalaman ng mga internal na detalye ng isang iba pang serbisyo. Ang mga error ng isang provider ay reworded bago ito ay dumating sa iyo.

limitasyon

Ang isang link sa isang larawan ay dapat ipinakita sa isang public host: ang isang address sa isang private o local network, o sa mga site ng Nymbot, ay inihayag. Provider pacing na ginagamit sa app ay tinatanggap din dito, kaya ang pag-atake ng mga requests sa isang provider ay maaaring i-slow rather than failed.

Ano ang dapat makita ng API

Ang API ay hindi private sa paraan na ang apps ay, at ito ay mahalaga na maging eksaktong tungkol sa kung paano.

• Hindi ito end-to-end na naka-encrypt. Sa mga apps, isang mensahe ay tinutukoy sa iyong device sa mga keys lamang ang Nymbot ay nagtatampok at naglalakbay bilang isang Mga pahinang wrapAng isang request ng API ay normal na HTTPS: ito ay encrypted sa paglipad sa Nymbot, at ang server ng Nymbot ay makikita ito sa clear upang magtatrabaho ito.
• Ang mga sumusunod at mga reaksiyon ay hindi naka-save. Ano ang tinutukoy ay ang bill: para sa bawat request ang oras, modelo, uri, token count, gastos, balance, key at kung ito ay lumabas, para sa 90 araw, na kung ano ang Tungkol sa History Ang isang log ng paggamit ng parehong request (time, type, model, token count, cost, duration at kung ito ay gumagamit ng web search o nangangahulugang) ay din natagpuan para sa 90 araw, kasama ang app's sarili.
• Ang lahat ng iba pang itinatag para sa isang nym ay maliit at itinatag dito. ang fire keys ay ibinigay bilang isang hash, hindi ang key, na may kanilang pangalan, isang short hint, spending cap, reset period, expiration at kapag sila ay ginawa at unang ginagamit; lamang ang pinakabagong 50 revoked keys ay ibinibigay. Automatic ang top-up ang koneksyon ng wallet ay naka-encrypted, na may kanyang threshold, halaga at ang resulta ng last top-up. Video jobs ay tinutukoy para sa 24 oras. Ang mga request na ibinigay sa bawat pag-call ay humihingi lamang ng isang Lightning payment hash para sa 7 araw at isang hashed reimbursement token para sa 30 araw, na naka-link sa walang nym. Charges na isang saldo ay hindi maaaring matatagpuan ay tinutukoy bilang inaasahan hanggang sa isang top-up bayaran ang mga ito.
• I-wipe ang app at i-delete ito. A Paggamit ng Wipe i-revoke at i-delete ang lahat ng API key, at i-delete ang history ng query, usage records, wallet connection at video jobs.
• Ang provider ng modelo ay nakikita ang iyong requestAng mga modelo ng Catalog ay gumagana sa mga makina nila; ang mga standard routes at embeddings ay gumagana sa Cloudflare.
• Ang mga media ay public. Ang mga imahe at video na ibinigay bilang mga link ay i-upload sa mga pampublikong Blossom file hosts, kung saan ang address ng isang file ay ang kanyang hash. Anyone with the link can open it, at Nymbot ay hindi maaaring i-download ito din. b64_json at ang isang imahe na nilikha ay bumalik sa reaksyon at hindi mai-upload.
• Kaya ang mga imahe na ibinigay mo sa isang generator. Ang isang larawan na i-upload sa ang edit, o magpadala ng isang data: URL sa isang generator image_url, ay i-upload sa isang public Blossom host na unang upang ang generator ay maaaring i-pick it, at ang parehong katumbas sa kanya. https:// Ang mga imahe sa isang request sa chat ay pumunta sa provider ng modelo, hindi sa Blossom.
• Ang isang key ay naka-link sa iyong nym. Ang lahat ng mga gastos ng isang key ay dumating mula sa balanse ng iyong nym, kaya ang paggamit ng API ay hindi ang anonymousKung nais mong gamitin ang paggamit ng API na itinatag mula sa iyong araw-araw na nym, gawin ang mga keys mula sa isang partikular nym na may kanyang sarili na balanse.

Kung kailangan mo ng proteksyon ng mga apps, gamitin ang apps. Ang API ay para sa kapag kailangan mo ng mga modelo sa iyong mga tool.

Lahat ng mga Endpoint

“Nym” ay isang request na sinulat sa pamamagitan ng iyong Nostr key, na itinuturing sa Pangalan ng mga Request AccountPara sa mga tool na nagsalita ng mga format na ito, tingnan ang Mga Tool at SDK, at para sa mga code agent tulad ng Claude Code, Codex at Cline, tingnan ang Mga Tool ng Coding.