Te turanga matauranga / Kaiwhakawhanake

Te whakarāpopototanga o te API

Ngā tauira, ngā kaihanganga me te taurangi e whakamahia ana i roto i te pūmanawa, mai i tō kōdi ake. Ka kōrero te API i ngā hanganga OpenAI me Anthropic, nō reira ko ō ngā taputapu me ngā SDK katoa e mahi ana mā te neke i te tūāpapa URL me tētahi kī.

He mihini tenei wharangi kia pai ai. Ko te reo Ingarihi taketake te putanga e tika ana.

He aha te API?

He HTTP API kei runga nymbot.ai e whakautu ana i ngā tono e tuku ana i tēnei rā e te client OpenAI rānei Anthropic rānei. Ka whiwhi koe i:

• Whakaputa Kōrero Atāwhai, te API o ngā whakautu a Ngā Karere a Anthropic, me te streaming, ngā taputapu, ngā whakaahua, te whaiwhakaaro me te rapu i te web, mō ia tauira i roto i te pukapuka rārangi me mō te aronga ā-motuhake tōna ake a Nymbot.
• Ngā Whakaahua, whakaata, kōrero, tuhinga whakawhitiwhiti a embeddings.
• To tauauau, Whakakapi Lightning, ngā whakakaha moni matua ā i tō kete moni me he kōrero tuku iho he aha te utu o ia tono.

He utu mai i taua rua katoa ngā tauira pūtea hei te app katoa, i teitei o ngā utu pēnei tonu. Kāore he rēti me he kāore he rēti noa i te API: he utu katoa ngā tono katoa mai i ngā kōrito i hoko koe.

Ko te mea kāore e mahi ai te API ko te tāpiri i tētahi mea nō Nymbot anō. Ka haere atu ō rerenga kōrero ki te tauira i te āhua i tono ai i a koe: kāore he whakamārama raupapa a te pūnaha Nymbot, kāore he mahara, kāore he tohu rāhui rānei mō te rā me te reo. Ko te mea puta mai ko te whakautu a te tauira me te pūtake o te utu.

Ngā Tūāpapa URL

Kei raro i tēnei ngā endpoint katoa /api/v1/. He ara kore e mōhiotia te hokinga mai 404 me he ara mōhiotia i karanga i te anga hē e hoki mai ana 405, tēnā hoki hei JSON.

Ka whakautu te API i ngā tono puta atu i te nohoanga matua mai i tētahi nohoanga katoa, nō reira ka taea e tētahi whāpage pūrere pānui te karanga ki a ia. Heoi, ka taea te pānui i ngā mea katoa e tuku ana koe ki tētahi pūrere pānui e tētahi tangata e whakatuwhera ana i tērā, nō reira kia mahia tērā anake me tētahi kī e whai ana i tētahi iti kapiKo ngā mutunga i whāitihia ki tō nym (ngā raweke, te whakarāpopototanga o te akaunau, te NWC auto-top-up me te whakawhiti moni hoki) ko te rerekētanga: i roto i te pūrere pānui, ka whakautu rātou ki ngā wāhi a Nymbot anake. Tirohia whakapuaki i ngā tono ake o te ake.

Tuku i nga JSON body katoa me Content-Type: application/json. He momo atu kē e whakahamia ana me te 415, nō reira he whakapāpare HTML noa rānei he text/plain te tono i tētahi atu pae kāinga e kore e taea te rongo ki te API. Mā cURL, tuku -H "Content-Type: application/json" me te -d.

Ngā tuhingā API

Ka hangaia ngā tuaka i roto i te app. Whakatuwhera API i roto i te taha o te pūmanawa web, tērā rānei i te menū i Android me iOS, ka pā atu Hangia te tuakiriTūhia tētahi ingoa me, mehemea i pai ki a koe, he tapu me te rā mutunga.

Ka whakaaturia te kī he tahi anake. Tuhi kia rānei i wāhi haumaru i mua i te kati i te pepa: ko te tohu noa iho te pupuri a Nymbot, nō reira e kore e whakaatu atu ai ki a koe anō. Ka kore e taea te whakaoho i te kī i ngaro; whakakore i tēnā, ka hanga tētahi atu.

He āhua te kī e rite ana ki sk-nymbot- e whai ake ana i ngā reta 43, ngā tau, ngā kōwhiri me ngā pūtoetoe. Ka whakarārangi i te app i ia kihi mā tōna ingoa me tētahi tohu iti pēnei i sk-nymbot-Qm7x…c2Lw.

• He tuara tēnei ki tō nym. Ka whakamahi i tō tauira pūtea, ā, ko tō nym anake e taea ai whakakāinga, whakarerekē rānei te whakakore i tēnei. Ko tō whāinga kei te kī katoa e taea ai te whakamahi i tēnei, nō reira kia manaaki i te kī hei kōrero huna.
• Kei te sats ngā Caps. Ka taea te whai i te rārangi whakahao mō tētahi raweke, ā, ka taea te whakaoho anō i te rārangi i ia rā, i ia wiki (Rāhina) rānei, i ia marama rānei (te rā tuatahi), i te 00:00 UTC. Ka taupāia ngā tauira e rua, he pūtea māmā hei 10 sats me he pūtea Pro hei 100, he tikanga ko te mea kotahi te whakatau i runga i te tauira ka whakamahia e te tono. I mua i te tīmatanga o te tono, ka whakarite te utu nui rawa e taea ana (e whakatau ana ki te rārangi pūtea katoa) ki te tāpiritanga o te rārangi kua mahue. Ki te kore e taea, ka whakakoreia te tono me te 403 key_limit_reached, ahakoa ko te ngā aha i puta i raro i te rārangi w限; e kī ana te hapa he aha te nui kua noho tonu me te wā ka whakaara anō te rārangi w限. Te Whakaiti max_tokens E whakatau ana i taua take kino rawa. Ka whakatau te utu o tētahi tono i te utu tūturu a ia, ā, ka whai wāhi tērā ki te tapu, nō reira, mehemea ka pānui te kaiwhakarite i te nui ake o ngā tukatuka (tokens) i te mea i whakaritea, ka taea e te tono whakamutunga i te hāngai ana te whakawhiti i te tapu o te tuhinga (key) mō tētahi wā iti; ka whakakore i te tono e whai ake nei.
• He rāhui kua whakamahi noa ka mutu te whakapānga pūtea. He tuakiri i tōna pūtake ka taea tonu te tirotiro i te tauhanga, te pānui i tōna hītori, te rāwari i ngā tauira, te taurangi i ngā tokeni, te whakakapi i te pūtea me te tirotiro i tētahi wikī kua tīmata katoa.
• He mea taketake te whakamutu. I muri i te rā i whakarite ai koe, ka mutu te mahi o te tuakiri.
• He tere, he whakamutunga hoki te whakakore. Ka kore e taea te whakatau i te tono a muri ake nei o tētahi tuakae kua whakakore. Ka noho tonu i roto i te rārangi, kua tāpiritia te tohu kua whakakore, kia mārama tonu ai tōna hītori whakangia.
• Ka taea te whai i ngā tuaka matatika e up to 25, he ingoa motuhake rānei ia tätahi. Ko te whakatakoto hou i te wā tūmomo o tētahi tuako ka tīmata i te wā hou i te zero.

E whakaatu ana te pepa anō i te kēngenga o ia kī i tēnei wāhanga me te katoa, i te wā whakamahia tino।) i, ngā tauira pūtea e rua, me ō ngā tono API i mua nei. Kei te tuhi ngā wāhanga whakamahi i muri i a ia i raro i te whakahaere i ngā tuaka.

Whakamātau i tētahi tono

Tuku i te kī i roto i tētahi o ēnei header. He rite tonu rātou, nō reira whakamahia te mea e tuku ana tō manatū i te tūmatanui:

He kī mīti, kore e mōhiotia, kua whakakorehia rānei, kua pāmua rānei te hokinga mai 401, me te kōdi missing_api_key, invalid_api_key, revoked_api_key kei te mea anō expired_api_key. Te tautuhi i ngā tauira, ngā tauira rongo, me ngā reo, me ngā huarahi utu kāore he tuhingā matua e hiahiatia ana.

Ka taea hoki te utu mō ngā pikitia, video, kōrero, tuhingataki me ngā embeddings i roto i tētahi tono kotahi mā te Lightning me te kore rānei i te kī: tīpokohia te tono me te kore rānei, ā, whai te pūtea i roto i te 402 whakaara. Tirohia te utu mō ia tono me te kore he kī.

Ko te whakamahinga i ngā kī, te whakarāpopoto i te ake akauneti, me te whakakapi i ngā moni i runga i te rārangi katoa ko te rerekētanga: ka mau i a rātou he tautoko nym i te mea he kī, nō reira ka kore e taea te hanga i te whānui i ngā kī i puta mai te raru. Tirohia whakapuaki i ngā tono ake o te ake.

Tō tuatahi tono

Whakatūria te kī ki roto i tētahi tūāhua taiao, ka pātai rānei i tētahi mahere rorohiko. Ko ngā tauira i roto i ēnei whārangi kei te pānui i ia rā mai i 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 ko te whakamahi a Nymbot i tōna ake huarahi, e utu ana i te tauira mātāmua. Whakauru i te id o te tauira kētia i reira, pēnei i anthropic/claude-sonnet-5, kia whakamahia taua tauira i te tauira Pro. Whakarārangi tauira homai ngā huarahi katoa.

He aha te utu o tētahi tono

He rite tonu te utu a te API i te utu a te app.

• Ko tēhea te taurangi. nymbot/auto ngākau o te tūāpapa tauhanga (10 sats he kōpū). Ko ia atu katoa ngā tauira kōrero e whakangia ana te Pro tauhanga (100 sats he tuatahi). Ko te hanga pikitia matua me te pūtake reo matua e whakamahi ana i ngā tuatahi matua; ko ia hanga anō e whakamahi ana i te Pro. Ko ngā embeddings e whakamahi ana i ngā tuatahi matua. Ko te whakamāori reo e whakamahi ana i ngā tuatahi matua ki te taea e te tauhanga matua te tautoko i a ia, ā ko ngā tuatahi Pro i te wā anō. Ko te rārangi tauira e kī ana i te tauhanga e whakamahi ana ia tauira.
• He aha te utu. Ka tāpiritia he utu 5% ki te utu i whakatauia e te kaiwhakarato, ā, ka whakanohohia i te 1.5, nō reira ka utu koe i te 1.575 i te utu rārangi a te kaiwhakarato. Ka huri tēnā ki te sats i te utu Bitcoin o te wā nei, ā, ka tango i te tōnga i roto i te tōnga kura (credit) e te mano. Ko ngā whakaahua, te wikītiō, me te reo e whakatauia ana i te tāhanga, i te hāora, i te hāora rānei, me te tuhituhi i te hāora o te reo, me te waiata me te pūtake katoa e aunei. Ko te whakaahua tere ko te 5 kura tere, ā ko te reo tere ko te 3 kura tere.
• Te iti rawa. Ko ia tono e tauria ana e tū te utu ki te kia 0.05 i te tūmatatenga: he setengahā ki te tauira tere, 5 sats ki te Pro. Ko ngā wāhanga o te tūmatatenga ka whai ake tonu, ehara i te whakatau ki runga i ia wā.
• Whakaeke, ka whakatū. Ahakoa mua i te whakahaere i tētahi tono, ka tuitui te nui rawa o te utu ka taea te utu mai i tō tauira, e whakarite ana i runga i tō mea i tono me te nui rawa o ngā token ka taea te tuhi. Ko te tuhinga i waho i te plain ASCII e te ngāau UTF-8 e te nui, ā ko ngā tau me ngā tohu ASCII he token kotahi rātau katoa, nō reira ko te tuhinga i roto i tētahi aha rāhoui, te kōdi, me ngā tau ka tuituihia i te katoa. Ko te tuitui i roto i ngā kirediti katoa, kia neke atu i te kotahi, nō reira he pono he iti noa i te 10 sats noa i te tauira mātāmua, tētahi rānei he 100 sats i te Pro kia tīmata ai. Ko te utu tika noa iia te whakakī; ka whakarerehia te toetoe ki te mutu te mahi. He tono roa ka mau tonu te tuitui i te wā katoa e whakahaere ana; mehemea ka kore e taea te whakamahi ngā kirediti i tuituia, ka mutu te tere i tētahi 402 insufficient_balance hapa tukunga, ā, ka whai utu te mea i hangaia. Ki te kaha ake te utu sebenarnya i te tauira ka taea te whai utu, ka mau katoa te tauira, ā, ka whai utu te toetoe (owed_sats i roto i te nymbot whakaaro, me te tauira kino rānei). Ko te mea e owed ana ka whai utu tuatahi i ngā koha e tae ana ki taua tauira i muri iho. Kaua e taea te whakamahi i tētahi mea i taua tauira i te wā e whai utu ana: e kore e taea e te API, ngā whakautu i roto i te app, he transfer rānei he koha rānei.
• Kāore i enough te pūtea. Ki te kore e taea te taupua e whaihua te tūtohi, ka whakahitia te tono me te 402 ka mua i te tīmata i tētahi mea katoa. E kī ana te hapa he aha te pūtea i ngaro, he aha te nui o ngā sats e hiahia ana te tono, ā, he aha te nui kei te wātea. He iti ake max_tokens he iti ake te pupuri.
• Ngā raru. He tono e kore e taea e whai hua he kore te utu, i muri i te mea kua whakatau te whakarato i te mahi i mahia i mua i te kore e taea, i te tātari web rānei ko te nymbot/auto mahi kua whakahaerea atu rānei; koia te mea ka utu koe, kia neke atu i te 0.05 credit. Ko te akau i whakakore atia e whai utu mō ngā token e pānui ana te kaiwhakarato: ka haere tonu te pānui a Nymbot i te akau a te kaiwhakarato mō te 25 hāora kei muri i tō haere kia whiwhai ai i taua tauira. Ki te kore e tae mai, ka whakarite te utu mai i ngā mea i whakamahia e koe me ngā mea i tuhia, ā mō tētahi mōhiohio e whai rongo, ka whai ake i te katoa o te tūtohu tuhinga o te tūmanako. Ko te tono e ngaro ana te hononga e mutu tonu ana, ā e whai utu ana.
• Rapu web e utu ana i te $0.008 ia rapu, kua huri ki te sats, i tētahi wā katoa ka rere he rapu, ahakoa ka whakahau te tauira mehemea ka raru rā. Ko ngā whārangi e pānui ana hoki ka tukuna ki te tauira hei whakauru, nō reira ka tāpiri i ō rātou token.

Ko ia whakautu e kī ana i te utu. Ko ngā whakautu JSON e pupuri ana i te a nymbot te whārangi e mōhio ana ki te te tauira i whakamutatia mai ai, te utu i roto i ngā kōriki me ngā sats, me te mea kua noho noa:

Te kaupapa utu

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

He whai atu hoki ēnei rārangi ingoa ki ngā whakautu kōutae, ko reira rā te wāhi hei rapu i te utu mō tētahi whakautu e kore e JSON, pēnei i te kōrero:

Ko ngā utu mō ngā tūmahi tora mairangi, kua whai ake tonu i te utu me te marini, kei roto i te rārangi tauira i roto i ngā tāra me ngā sats, me te runga te pepa utu. Ki te kore e taea te pānui i te utu o te Bitcoin, ka hoki ngā tono kua utu 503 price_unavailable me Retry-After: 60 me ingia kau i te tūmanako.

Ngā hapa

He rite tonu te āhua o ia raru, te āhua kua mārama ai ngā kaiwhakamahi OpenAI. code he ingoa pūmau e taea ai te whakatairite ki; message he mea mō te iwi, ā, ka taea te huri.

Tinana hapa

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

E rua ngā rerekētanga:

• /api/v1/messages ngā whakautu i roto i te tauira raru a Anthropic, nō te mea ko tērā te mea e tātari ana ngā kaipiri a Anthropic: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}. E whai ana te momo i te āhua: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error kei te mea anō overloaded_error (503).
• He tono rerenga e kore e oti i mua i te tae atu o te kōpaka tuatahi, ka puta he raru JSON māmā me te status i runga, ehara i te rerenga whakahoutanga. He raru i muri i te tīmata o te rerenga ka tuku ki te whakahoutanga whakamutunga o te rerenga, i roto i te aha o taua tuhinga.

E kore e whai i roto i ngā pānui raru i ngā kōrero huna o tētahi rārangi mahi anō. Ka whakarerekēhia te raru o te kaiwhakarato i mua i te tae atu ki a koe.

Ngā Tūāpapa

Me whakahāngai te hono ki tētahi whakaahua ki tētahi tūranga tūmatanui: e whakahēria ana he wāhi i runga i tētahi pūtea tūmataiti, he pūtea hangarau i te rohe rānei, ki ngā tūranga a Nymbot rānei. Ka whakatau tonu te takatū a te kaiwhakarato e whakamahia ana i roto i te pūmanawa ki konei hoki, kia taea te whakaiti i te tere o ngā tono nui ki tētahi kaiwhakarato, kaua te whakakore i te mahi.

He aha te mea ka kite te API

Ehara i te mea he tūmataiti te API i te huarahi e tūmataiti ai ngā pūmanawa, ā, he pai te whai tino tika mō te huarahi e puta ai ia.

• Ehara i te mea he whakamahi whakawhitiwhiti mō te katoa i te tata ki te tata. I roto i ngā taupāpata, he kauhau e kuraia ana i runga i tō pūrere, kia huna ai ki ngā kī e Nymbot anake e pupuri ana, ā, e haere ana hei a whāriki koha. He tono API he HTTPS noa iho: he taunaha ia i te haerenga ki Nymbot, ā, ka pānui te tūranga Nymbot i te mea mārama kia taea ai te whakatau.
• Kāore e pupurihia ngā whakaoho me ngā whakautu. Ka haere atu rātou ki te tauira, ā, ka hoki mai te whakautu. Ko te pūtea te mea ka tū: mō ia tono te wā, te tauira, te momo, ngā tauake, te utu, te tāpaetanga, te kī, me te whether i ora ai, mō 90 rā, ko tēnā ko te whati hītori pātai e whakaatu ana ki a koe. Ka tiakihia hoki he rēkoreiti whakamahi mō te ingoa rānei (wā, momo, mahere, tauira, tau token, utu, roa me te whether i whakamahia te rapu web rānei, i angitu rānei) mō 90 rā, hei tata ki te rēkoreiti o te app anake.
• He iti katoa ā ingoa atu e pupuri ana mō tētahi nym, ā, kua whakarātea atu i konei. Ngā tuhingā API e tūpato ana hei hash, kaua i te kī, me tō rātou ingoa, he tohu poto, te pūtake utu, te wā mutunga, te wā whakakore me te wā i hangaia me te whakamahia i te whakamutunga; ko ngā 50 o ngā kī whakakore hou nhất anake kei te pūngao. An whakakāinga i runga i te hungaHere Ka tiakina te hononga pūtea i te kōpaka, me tana taumata, te nui, me te hua o te whakakapi pūtea i te wā whakamutunga. Ka tiakina ngā mahi wikiō mō te 24 haora. Ko ngā tono i utuia i ia karanga ka waiho anake i te hash utu Lightning mō te 7 rā me te tohu hokinga utu i kōpaka mō te 30 rā, kāore e hono ki tētahi ingoa. Ko ngā utu kāore e taea e te pūtea e whai ake, ka tiakina hei utu mō te wā kia whakakapi ai te pūtea.
• Mahea te app ka muku i a ia. A muku pūrere whakakore me te whakakore i ngā kī API katoa, ka whakakore hoki i te hītori pātai, ngā rēkoti whakamahi, te hononga pūtea, me ngā mahi ataata. Ka noho tonu te tauira i te pūtea me ngā utu katoa e hala ana ki te nym.
• E kitea ana e te kaiwhakarato o te tauira tō tono, pēnei i te app. Catalog ngā tauira catalog e rere ana i ā rātou kaihanga; ngā huarahi me ngā embedding tūmatanui e rere ana ki te Cloudflare.
• He mea tūmatanui ngā media kua hangaia. Ko ngā whakaahua me ngā wikiti kua tukuna hei hononga kei te whakaputa ki ngā takere mahi Blossom mārama, ko te tauira o te tāpae he tauira hash. Ko tētahi katoa kua whiwhi hononga ka taea te whakatuwhera, ā ka kore e taea e Nymbot te whakakore i tēnā anō. Pātai atu mō b64_json ā he whakaahua hangaia ka hoki mai i te whakautu, ā, e kore e tukungia i tētahi wā.
• Nā reira, he kaihanga ngā whakaahua e tukuna ana e koe. He whakaahua ka tuhia e koe ki te whakapai ake, rānei tuku hei data: Te URL i roto i te kaitukuna image_url, ka tukuna ki tētahi Blossom host tūmatanui i mua kia taua generator e taea ai te tiki mai, ā, ko te mea pēnei anō mōna. He pikitia i timata mai e https:// ka tuku te hono hei tauira i taua hono. Ka haere ngā pikitia i roto i te tono kōrero ki te kaiwhakahaere o te mahere, kaua ki Blossom.
• He kaupapa tēnei e hono ana ki tō nym. Ko ngā mea katoa e whakatika ana te kī, ka tūtake mai i te tauira nym, nō reira ehara i te whakamahi API nāhiaheiaKi te hiahia koe kia motuhake te whakamahinga i te API i tō ingoa mātua o ia rā, hangaia ngā tuaka i tētahi ingoa mātua motuhake e whai ana i tōna ake pūtea.

Me whakamahi i ngā apps ki te hiahia koe ki te tiaki a ngā apps. Ko te API mō te wā e hiahia ana koe ki te whai i ngā tauira i roto i ō āu taputawa ake.

Ia te matamutunga katoa

"Nym" he tono i whainaia e tō Nostr key, e whakamāramahia ana i roto i whakapuaki i ngā tono ake o te ake. Mō ngā taputapu e kōrero ana i ēnei hangahanga kua oti, tirohia ngā taputapu me ngā SDKs, ā, mō ngā pūmanawa whakamanawa tuhingarauhi pēnei i te Claude Code, Codex me te Cline, tirohia ngā taputapu tūhono rorohiko.