Tushen ilimi / Wasanni

Ƙararrawa API

The models, generators and balance you use in the app, daga code. The API yana magana da OpenAI da Anthropic format, don haka mafi kayan aiki da SDKs aiki ta canza asali URL da key.

An fassara wannan shafin na inji don dacewa. Asalin Ingilishi shine sigar da ke aiki.

Yadda za a API

HTTP API a kan nymbot.ai da yaushe da samfurori da OpenAI ko Anthropic client ya sa. Za ka samu:

• Tsarin ChatƘananan Yanar Gizo kuma Anthropic sabuntawa, tare da streaming, kayan aiki, hotuna, ra'ayin da kuma web search, ga kowane model a cikin takardar kebantawa kuma domin Nymbot ta auto-routing.
• Wasanni, Wasanni, Tuntube mu, Tsarin Transcription kuma Ƙananan.
• Naku Tuntube mu, Ƙararrawa Top-ups, Automatic top-ups daga wallet a Tarihin game da abin da kowane baƙi da kudi.

Yana da aka bayar da sama biyu Tuntube mu Kamar yadda app, a sama farashin. Akwai wani abokin ciniki da kuma ba tare da wani kudi a kan API: kowane abokin ciniki ne bayarwa daga credits ka samu.

What the API doesn't do is add anything of Nymbot's own. Yourmessages go to the model as you sent them: no Nymbot system prompt, no memory, no date or language hints. What comes back is the model's answer and a note of what it costs.

Tsarin URLs

Kowane Endpoint yana da al'ada /api/v1/Ƙungiyar Unknown ya zo 404 kuma wani alama mai ban sha'awa tare da alama mai ban sha'awa ya saita 405Duk da cewa JSON.

The API ya ce cross-origin bukatun daga kowane site, don haka wani browser page za a iya kira shi. Duk abin da ka saita zuwa wani browser za a iya karanta da abin da aka buga shi, amma, don haka kawai yi wannan tare da key wanda yana da m Kasa. Endpoints da aka saita tare da nym (keys, account summary, NWC auto-top-up da refund redemption) ne da ƙarshe: a cikin browser, su yi amfani da kawai Nymbot ta website. Takaddun shaida.

Sauke kowane JSON body tare da Content-Type: application/json. Duk wani irin yana rike da 415, kamar yadda wani tsari HTML format ko a text/plain tambaya daga wani yanar gizo ba za a iya samun API. tare da cURL, -H "Content-Type: application/json" Tare da -d.

Wasanni Key

Key ne a cikin app. Open Wasanni a cikin sidebar na web app, ko a menu a kan Android da iOS, kuma Zabi KeySauke shi wani sunan da kuma, idan kana so, wani cap da tsawon lokaci.

The key ne nuna wani lokaci. Kopi shi a wani wuri kafin ka shigar da sheet: Nymbot yana haifar kawai wani fingerprint daga shi, don haka ba za a iya nuna shi a kan ku. A kayyade key ba za a canza; canza shi kuma samar da wani.

Key yana nuna sk-nymbot- tare da 43 lambar, lambar, lambar, lambar da lambar. A app ya rubuta kowane lambar da sunansa da wani tsari kamar yadda: sk-nymbot-Qm7x…c2Lw.

• A key yana da nym. Yana amfani da kudinku, kuma kawai your nym zai iya yin, canza ko canza shi. Kowane wanda ya halarci key za a iya canza tare da shi, don haka saduwa shi kamar wani kaushe.
• Caps ne a sats. A key za a iya da wani gaskiya cap, da cap za a iya ƙirƙirar kowace rana, kowace rana (Monday) ko kowace rana (Monday), a 00:00 UTC. Yana daidaita dukkan kudi, wani standard credit a matsayin 10 sats da wani Pro credit a matsayin 100, don haka yana daidai da wannan sama kowace kudi da baƙi baƙi. Kafin da baƙi ya yi, mafi ya iya baƙi (samar da cikakken credits) an kafa a kan abin da aka haifar da kudi. 403 key_limit_reached, har ila yau, idan yanayin zai zama a karkashin cap; gabatarwa ya ce da yawa da kuma a lokacin da cap ya saita. max_tokens A samfurin da aka bayar da abin da ya kamata a gaskiya da kuma da aka sayar da cap, don haka idan samarwa ya gabatar da fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara fassara.
• A gaskiya cap kawai ba da gaskiya. A key a kan kapuce-aikace zai iya duba da kudin, karanta tarihinsa, list models, sayar da tokens, top up da kuma duba a cikin video da ya fara.
• Expiry ne mai ban sha'awa. Bayan bayan da aka saduwa, key zauna aiki.
• Ƙirƙirƙirƙirƙirƙirƙirƙirƙirƙirƙirƙirƙirƙirƙirƙirƙira Wannan kewayon ya zama a cikin lissafi, da aka rubuta da rubuta, don haka tarihin gaskiya yana da mahimmanci.
• Za ka iya zama har zuwa 25 aiki key, kowane tare da wani sunan. Za a canza tsari na key za a fara wani sabon tsari daga zero.

The same sheet ya nuna kowane key ta gaskiya a wannan lokaci da a cikakken, a lokacin da aka amfani da karshe, duk da kudi, da kuma your karshe API tambayoyi. The endpoints a kan shi ne dokokin a karkashin takardar kebantawa.

Ƙirƙirar ƙirƙirar ƙirƙiri

Sauke key a cikin wani daga wadannan headers. Suna daidaitawa, don haka amfani da abin da abokin ciniki ya ba daidai:

Ƙara, Unknown, Cancelled ko Expired Key Returns 401, tare da code missing_api_key, invalid_api_key, revoked_api_key ko expired_api_keyListing samfurori, audio samfurori da kuma tallace-tallace, da kuma samfurori ba da bukatun.

Pictures, video, tallace-tallace, transcription da embeddings za a iya bayar da wani baƙi a lokaci a kan Lightning tare da ba tare da key a kowace: send da baƙi ba tare da wani kuma bayar da baƙi a cikin 402 Sauke bayarwa a kan tallace-tallace ba tare da key.

Key management, account summary da kuma automatic top-ups ne da ƙarshe: su zauna lissafi daga your nym a gundumar da key, don haka wani kauri ba za a iya samar da more keys. Takaddun shaida.

Ma'aikatanku

Sanya key a cikin yanayi mai girma, sa'an nan ba da wani model wani abu. A samfurin a cikin wadannan yanar gizo ya sa shi daga 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 shi ne Nymbot ta hanyar, da aka bayar daga cikin al'ada. Sauke ID na model na catalog, kamar yadda: anthropic/claude-sonnet-5, don amfani da wannan model daga Pro Balance. Lissafi da model Kira kowane ID.

Yadda za a ba da sha'awa

The API fassara daidai kamar yadda app ya yi.

• Ta yaya Balance. nymbot/auto Ƙididdiga takardun kudi (10 sats a credit). Kowane sauran chat model rufe Wanda Ƙararrawa (100 sats a credit). Ƙararrawa na image da kuma Ƙararrawa na Voice ya yi amfani da Ƙararrawa na Standard; kowane sauran Ƙararrawa ya yi amfani da Pro. Ƙararrawa ya yi amfani da Ƙararrawa na Standard. Ƙararrawa ya yi amfani da Ƙararrawa na Standard a lokacin da Ƙararrawa na Standard za a iya ƙararrawa shi, da Ƙararrawa na Pro. Ƙararrawa na Model ya ce abin da Ƙararrawa na kowane model ya yi amfani.
• Ko da yawa. Wannan farashin yana da wani 5% farashin da aka saita da kuma ya saita da 1.5, don haka za ka bayar 1.575 tsawon farashin list na samarwa. Yana da aka gyara zuwa farashin a kan live Bitcoin farashin da aka saita a cikin thousandths na ajiya. Pro images, video da kuma tallace-tallace suna da farashin a kowace jiki, a kowace jiki ko a kowace jiki, da kuma transcription a kowace jiki na audio, tare da sama farashin da margiyoyin. A standard image ne a flat 5 standard credits da kuma standard voice a flat 3.
• da kuma minimum. Kowane daidaitacce baƙi da ke aiki da kudi ne a karkashin 0.05 credit: yarda a set a kan daidaitacce baƙi, 5 sats a kan Pro. Fractions na wani credit suna tafi, ba tare da rage a kowace lokaci.
• Sauke, sauke kuma sauke. Tare da abin da aka saita a cikin asusun ASCII, da rubutu na ASCII da kuma rubutu na ASCII da aka saita a matsayin token, don haka rubutu a cikin kowane script, code da yawanci suna saita a cikakken lokaci. A saita ne a cikin cikakken credits, a kowace daya, don haka kowane tambayoyi ya bukatar a kowace 10 sats free a kan asusun Standard ko 100 sats a kan Pro don fara. Duk da gaskiya na ASCII da punctuation suna saita a matsayin token kowane, don haka rubutu a cikin kowane script, code da yawanci suna saita a cikakken lokaci. Idan da aka saita Credits ba su zama samuwa a kowace lokaci, wani tsari ya saita tare da wani 402 insufficient_balance Ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan ƙananan (owed_sats a cikin nymbot Object, da kuma wani hasken rana). Yana da aka bayar da farko daga cikin gaba credits da aka samu wannan hasken rana. Ko da aka bayar, wani abu a kan wannan hasken rana za a iya amfani: ba tare da API, yanayin a cikin app, wani canjawa ko wani kyauta.
• ba tare da kredit. If the balance cannot cover the hold, da bukatun da aka ba da 402 kafin abin da aka yi aiki. A gabatarwa ya ce abin da aka shakka, da yawa da ake bukata da kuma da yawa ne free. max_tokens Yadda za a yi da wani ƙarfi.
• Ƙananan Kyakkyawan da ke ba da kyakkyawa ba da kyakkyawa ba, idan ba da kyakkyawa don aiki da aka yi da kafin kyakkyawa, ko wani yanar gizon ko nymbot/auto Task check da aka yi aiki; sa'an nan shi ne abin da ka bayar, a kan 0.05 ajiya. A tsari da ka cut off ne daidaita ga token da provider ya gabatar da: Nymbot yana daidaita sa'a na provider ta tsari ko zuwa 25 seconds bayan ka saita don samun wannan tsari. Idan shi ba ya zama, daidaitaccen da aka sayar daga abin da ka saita da kuma abin da aka rubuta, da kuma ga wani model da hanyoyin da ya hada da cikakken ƙarƙwalwar ƙarƙwalwar ƙarƙwalwar. A samfurin wanda aka riga da ƙarƙwalwar ƙarƙwalwar ƙarƙwalwar ƙarƙwalwar ƙarƙwalwar.
• Wasanni cost $0.008 a search, yi canja a sats, a kowane lokaci da wani search riga, ko da model ya sa ko yaushe. The sayarwa da ya sa ne kuma ya rubuta zuwa model a matsayin input, don haka su sa su tokens.

Kowane matsaloli ya ce kudi. JSON matsaloli yana ƙunshi a nymbot object tare da kudin da aka bayarwa daga, kudi a cikin credits da sats, da kuma abin da aka ba da:

Ƙararrawa Objects

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

Ma'aikatan da aka biya yana da wadannan headers, wanda shi ne inda za ka duba da kudi na wani yanayin da ba ne JSON, kamar tallace-tallace:

Rates per million tokens, ya hada da kudi da marufi, ne a cikin Sabuwar Models dollar da kuma sats, da kuma a The price sheetIf the Bitcoin price can't be read, bayar da abokin ciniki ya saita 503 price_unavailable Ƙaddamar Retry-After: 60 Yadda za a gyara.

Yanzu

Kowane gabatarwa yana da abu, wanda OpenAI abokan ciniki ya sani. code shi ne mai ban sha'awa da za ka iya matsaloli; message shi ne ga mutane da za a iya canza.

Ƙararrawa Body

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

Tare da biyu:

• /api/v1/messages yanar gizo a format na Anthropic, kamar yadda shi ne abin da Anthropic abokan ciniki bincike: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. Type ya ce status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error ko overloaded_error (503).
• Streaming samfurin da ke ba da kyakkyawa kafin farko bauta ya samu wani m JSON gabatarwa tare da hali a karkashin, ba tare da wani matakan matakan. A kyakkyawa bayan matakan da aka fara ne a matsayin matakan na farko na matakan, a cikin matakan da aka yi a kan endpoint.

Ma'aikatar gabatarwa ba tare da bayanai na sauran sabis. Ma'aikatarwar gabatarwa ba za su rigawa kafin ya zo ka.

Tuntube mu

Yanar gizo zuwa hotunan da ya kamata ka nuna zuwa wani jama'a: wani adireshin a kan wani cibiyar sadarwa ko yanar gizo, ko a kan yanar gizo na Nymbot, an ba daidai. Providers pacing da aka yi amfani da a cikin app yana da yin amfani da a nan, don haka wani burst na bukatun zuwa wani provider za a iya ci gaba da sauƙi fiye da ci gaba.

Yadda za a iya ganin API

API ba ne musamman a matsayin apps ne, kuma ya kamata a zama daidai game da yadda.

• Yana ba zai zama end-to-end cryptic. A cikin aikace-aikace, bayanin da aka girmama a na'urorinka zuwa keys kawai Nymbot ya gudu da tafiya a matsayin Tuntube mu. A API request ne m HTTPS: shi ne encrypted a kan tafiya zuwa Nymbot, da kuma Nymbot's server ya sa shi a cikin sauri don yin amfani da shi.
• Shigarwa da kuma matsaloli ba zaune. Za su ta hanyar zuwa model da matsaloli ya yi tafi. Yadda aka sa shi ne bill: ga kowane baƙi da lokaci, model, type, token sayarwa, kudin, balance, key da kuma ko ya yiwuwa, ga 90 kwanakin, wanda shi ne abin da Tsarin Tarihi Kayan amfani da wannan samfurin (aikace-aikace, type, model, token tallace-tallace, kudin, tsawon lokaci da kuma idan ya yi amfani da yanar gizo ko yaushe) ne kuma haifar da 90 kwanaki, tare da app ta.
• Duk wani abu da aka gane ga wani nym ne mai ban mamaki da aka rubuta a nan. Wasanni Key a matsayin hash, ba tare da key, tare da sunansa, short hint, gaskiya cap, reset tsawon lokaci, mataki da kuma a lokacin da su aka yi da kuma na farko amfani; kawai cikin latest 50 da aka gyara keys suna samu. A takardar kebantawa tambayoyi da aka saita a kan lissafi, tare da kudi, kudi da kuma mataki na karshe top-up. Video jobs suna saita a kan 24 hours. Requests da aka bayar da kudi ba kawai wani Lightning biya hash a kan 7 kwanaki da kuma wani hashed refund token a kan 30 kwanaki, da aka gabatar da ba nym. Takaddun sha'awar ba za a iya saita kamar yadda aka ba a lokacin da wani top-up ba su saita su.
• Sauke app ya sauke shi. A takardar kebantawa ya canza da sauke kowane API key, kuma ya canza yanar gizo istoric, amfani records, wallet connectivity da video jobs. The kudin da kuma duk haƙƙoƙin kudi za su zama a kan nym.
• Model's provider yana sani da bukatunku, kamar yadda ya yi daga app. Catalog models yi aiki a cikin makara; standard routes da embeddings yi aiki a kan Cloudflare.
• Ƙaddamar da media ne jama'a. Hotuna da video da aka gabatar da a matsayin links suna karfafawa zuwa jama'a Blossom file hosts, inda adireshin fayil ne haƙuri. Kowane mutum tare da wata mahada za a iya buga shi, kuma Nymbot ba za a iya ƙirƙirar shi. b64_json kuma hotunan da aka generated ya zo a cikin matsaloli da kuma ba a karkashin.
• Kuma suna da hotuna da ka ba da wani generator. Hotuna da ka upload to Tuntube mu, ko saita a data: URL a cikin generator image_url, da aka saita zuwa wani jama'a Blossom host farko don cewa generator za a iya saita shi, da kuma daidai da shi. A picture sent by https:// takardar shaida a matsayin wannan takardar shaida. Pictures a cikin chat request go to model's provider, ba tare da Blossom.
• A key yana daidaita tare da nym. Duk abin da keyword ya gaskiya ne daga balans na your nym, don haka amfani da API ba ne Anonymous. Idan kana so ka amfani da API da aka sauke daga cikin yau da kullum nym, yi keys daga wani musamman nym tare da tasiri.

Idan kana bukatar kawar da aikace-aikace, amfani da aikace-aikace. The API ne don lokacin da kana bukatar aikace-aikace a cikin kayan aiki.

Kowane Endpoints

“Nym” yana da ƙirƙirar ƙirƙirar da Nostr key Takaddun shaida. Ga kayan aiki da suka yi amfani da wadannan format, duba kayan aiki da SDKs, da kuma domin coding kayayyakin kamar Claude Code, Codex da Cline, duba Koda kayan aiki.