Msingi wa maarifa / Watengenezaji

Maonyesho ya API

Mifumo ya API inazungumzia muundo wa OpenAI na Anthropic, hivyo zana nyingi na SDKs zinafanya kazi kwa kubadilisha URL ya msingi na kifungo.

Ukurasa huu umetafsiriwa kwa mashine kwa urahisi. Toleo la asili la Kiingereza ndilo linalotumika.

Nini maana ya moto

API ya HTTP nymbot.ai ambayo inashughulikia maombi sawa ambayo mteja wa OpenAI au Anthropic tayari anatoa.

• Mwisho wa Chatkwa ajili ya Majibu ya API na Ujumbe wa Anthropic, na mtiririko, zana, picha, sababu na utafutaji wa wavuti, kwa kila mfano katika Orodha ya na kwa ajili ya Nymbot mwenyewe auto-routing.
• Picha ya, Video ya, Mjadala wa, Mabadiliko ya na Uingizaji.
• Wako usawa wa, Maonyesho ya Top-ups, Top-ups moja kwa moja kutoka kwa wallet yako ya a Historia ya kiasi cha gharama ya kila maombi.

ya kulipa kutoka kwa watu wawili sawa Uwiano wa Kama programu, kwa bei sawa. Hakuna usajili na hakuna upungufu wa bure juu ya API: kila ombi huchukuliwa kutoka kwa mikopo uliyopata.

Nini API haina kufanya ni kuongeza kitu chochote kutoka kwa Nymbot mwenyewe. ujumbe wako kwenda kwa mfano kama wewe kuwasilisha yao: hakuna Nymbot mfumo mwongozo, hakuna kumbukumbu, hakuna tarehe au tafsiri lugha.

Msingi wa URL

Kila mwisho wa maisha ni chini ya /api/v1/Njia isiyojulikana ya kurudi 404 na njia inayojulikana inayoitwa na njia mbaya inarejea 405Wote wawili kama JSON.

API inashughulikia maombi ya mstari kutoka kwa tovuti yoyote, hivyo ukurasa wa kivinjari unaweza kuita. Kila kitu unachotuma kwenye kivinjari kinaweza kusoma na mtu yeyote anayefungua, hata hivyo, tu kufanya hivyo na kifungo ambacho kina kiwango kidogo cha kichwaPointi za mwisho zilizosajiliwa na nym yako (kifungo, muhtasari wa akaunti, NWC auto-top-up na refund redemption) ni ubaguzi: katika kivinjari wanajibu tu kwenye maeneo ya Nymbot mwenyewe. Maombi ya kuandika akaunti.

Tuma kila mwili wa JSON na Content-Type: application/jsonMtu yeyote mwingine anaweza kukataliwa na 415, hivyo fomu ya kawaida ya HTML au text/plain maombi kutoka tovuti nyingine haiwezi kufikia API. Kwa cURL, -H "Content-Type: application/json" Pamoja na -d.

Nyumba ya moto

Kichwa hutengenezwa katika app. kufungua Moto wa katika bar ya upande wa programu ya wavuti, au katika orodha kwenye Android na iOS, na Tengeneza kichwaKutoa jina na, kama unataka, kifungo na tarehe ya mwisho.

Chaguo huonyeshwa mara moja. Kopea mahali fulani salama kabla ya kufunga karatasi: Nymbot inahifadhi tu picha ya fingerprint yake, hivyo haiwezi kuonyesha tena. chaguo lililopotea haiwezi kurejeshwa; kufuta na kufanya nyingine.

Njia moja inaonekana kama sk-nymbot- inayofuata na barua za 43, namba, vichwa na vichwa vya chini. programu inachagua kila kifungo kwa jina lake na alama fupi kama vile: sk-nymbot-Qm7x…c2Lw.

• Chaguo moja ni ya nym yako. Inatumia kiwango chako, na tu nym yako inaweza kufanya, kubadilisha au kuondoa. Mtu yeyote ambaye ana kichwa anaweza kutumia na hilo, hivyo kutibu kama password.
• Hifadhi ni ya thamani. Kundi linaweza kuwa na kiwango cha matumizi, na kiwango cha matumizi kinaweza kurekebishwa kila siku, kila wiki (Jumanne) au kila mwezi (ya kwanza), saa 00:00 UTC. Inategemea viwango viwili, kiwango cha kiwango cha chini kama 10 sats na kiwango cha juu kama 100, hivyo inamaanisha sawa bila kujali kiwango ambacho maombi hutumia. Kabla ya kuendesha maombi, kiwango cha juu kinachoweza kulipa (kupunguzwa hadi mikopo yote) huwekwa dhidi ya kile kilichobaki cha kiwango cha juu. 403 key_limit_reached, hata kama jibu litakuja chini ya cap; makosa inasema ni kiasi gani kilichobaki na wakati cap inasimamisha. max_tokens Maombi inahesabiwa kile kinachohesabiwa na gharama halisi na hiyo inachukuliwa dhidi ya kifungo, hivyo ikiwa mtoa huduma anatoa tokens zaidi kuliko ilivyowekwa peke yake, maombi ya mwisho ambayo yanafaa yanaweza kuchukua kifungo kidogo zaidi ya kifungo chake; baadaye ni kukataliwa.
• Mkopo uliotumika tu huacha matumizi. Kichwa kwenye kifungo chake bado inaweza kuangalia usawa, kusoma historia yake, orodha mifano, kuhesabu tokens, juu na kuangalia video ambayo tayari ilianza.
• Kuondolewa ni chaguo. Baada ya tarehe unayoweka, kifungo kinaacha kufanya kazi.
• Kuondolewa ni ya haraka na ya mwisho. Kichwa kilichochukuliwa haina ombi lake jipya. Inabaki katika orodha, iliyoonyeshwa na kufutwa, hivyo historia yake ya matumizi bado ina maana.
• Unaweza kuwa na kifungo cha 25 cha kazi, kila moja na jina lake mwenyewe. Kubadilisha kipindi cha kurejesha kifungo huanza kipindi kipya kutoka zero.

Karatasi hiyo inaonyesha matumizi ya kila kifungo kwa kipindi hiki na kwa jumla, wakati ulikuwa unatumika kwa mara ya mwisho, uwiano wako, na maombi yako ya API ya hivi karibuni. Usimamizi wa Key.

Uhakiki wa maombi

Tuma kifungo katika yoyote ya vichwa hivi. Wao ni sawa, hivyo kutumia kile mteja wako anatoa kwa default:

Kutokuwepo, kutokujulikana, kufutwa au kuishia kurudi chaguo 401Pamoja na msimbo wa missing_api_key, invalid_api_key, revoked_api_key au expired_api_keyOrodha ya mifano, mifano ya sauti na sauti, na mbinu za malipo hauhitaji kifungo.

Picha, video, sauti, transcription na embeddings pia inaweza kulipwa kwa ombi moja kwa wakati juu ya Lightning bila muhimu kabisa: kutuma ombi bila moja na kulipa fidia katika 402 Jibu: Angalia Malipo kwa maombi bila kichwa.

Usimamizi wa kichwa, muhtasari wa akaunti na top-ups za moja kwa moja ni ubaguzi: wanachukua saini kutoka kwa nym yako badala ya kichwa, hivyo kichwa kilichopatikana haiwezi kufanya makala zaidi. Maombi ya kuandika akaunti.

Maombi yako ya kwanza

Weka muhimu katika variable ya mazingira, kisha kuuliza mfano kitu. mifano katika kurasa hizi kusoma kutoka 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 ni usafiri wa Nymbot mwenyewe, kulipwa kutoka kwa usawa wa kawaida. Weka id ya mfano wa orodha huko badala yake, kama vile anthropic/claude-sonnet-5Hivyo kujiandaa kutumia kuongezeka na zawadi kwa upendo. Orodha ya mifano Kutoa id ya kila mtu.

Nini gharama ya maombi

API inachukua malipo kwa njia sawa kama app inavyofanya.

• Uwiano wa nini. nymbot/auto Tumia kwa Kiwango cha usawa (10 sats a credit). Kila mfano mwingine wa mazungumzo huchukua kwa ajili ya kiwango cha ubadilishaji (kushoto cha 100). Generator ya picha ya kiwango na sauti ya kiwango huchukua kiwango cha ubadilishaji; kila generator mwingine huchukua Pro. Uingizaji huchukua kiwango cha ubadilishaji. Transcription huchukua kiwango cha ubadilishaji wakati kiwango cha ubadilishaji kinaweza kufunika, na viwango vya Pro vinginevyo. Orodha ya mifano inasema kiwango ambacho kila mfano huchukua.
• kwa kiasi gani. Utaratibu wa mazungumzo unazingatiwa kwenye tokens ambayo mfano una kusoma na kuandika, kwa viwango vya kuchapishwa vya mtoa huduma. Bei hiyo ina ada ya 5% iliongezwa na kisha huongezwa kwa 1.5, hivyo unalipa mara 1.575 ya bei ya orodha ya mtoa huduma. Inabadilishwa kwa sats kwa bei ya Bitcoin ya kuishi na inachukuliwa kwa maelfu ya mkopo. Picha za Pro, video na hotuba zinahesabiwa kwa kizazi, kwa sekunde au kwa tabia, na usambazaji kwa sekunde ya sauti, na ada na kiwango sawa. Picha ya kiwango ni sarafu ya 5 na sauti ya kiwango ni sarafu ya 3.
• Kiwango cha chini. Kila ombi linalohesabiwa linalotumia gharama ya angalau 0.05 ya mkopo: nusu ya mkopo kwenye kiwango cha kawaida, 5 ya mkopo kwenye Pro.
• Kisha uendelee na uendelee. Kabla ya ombi kuendesha, gharama kubwa zaidi inaweza kuhifadhiwa kutoka kwa kiwango chako, kulingana na kile unachotuma na tokens nyingi inaweza kuandika. maandishi nje ya ASCII rahisi ni ukubwa kutoka kwa bytes yake UTF-8, na takwimu ASCII na punctuation hesabu kama token kila, hivyo maandishi katika script yoyote, nambari na namba zinahifadhiwa kwa kamili. Kuhifadhi ni katika mikopo yote, angalau moja, hivyo ombi lolote inahitaji angalau mikopo 10 bure juu ya usawa wa kawaida au mikopo 100 juu ya Pro kuanza. tu gharama halisi inahesabiwa; wengine hutolewa wakati inapofanyika. Ombi ndefu huhifadhiwa kwa muda mrefu kama inafanya kazi; kama mikopo iliyohifadhiwa haipatikani 402 insufficient_balance Ukiwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika wa kuwa na uhakika (owed_sats Katika ya nymbot kitu, na kiwango cha chini). Kile kinachohitajika kinalipa kwanza kutoka kwa mikopo inayofuata ambayo hufikia kiwango hicho. Kabla ya kulipwa, hakuna chochote juu ya kiwango hicho kinachoweza kutumika: si kwa API, majibu katika programu, uhamisho au zawadi.
• Hakuna malipo ya kutosha. Ikiwa hesabu haiwezi kufunika uhifadhi, ombi linafutwa na 402 Kabla ya kitu chochote kuendesha. makosa inasema ambayo usawa ni mfupi, ni kiasi gani cha taratibu inahitajika na ni kiasi gani ni bure. max_tokens Hii inamaanisha kuwa kiwango cha chini.
• ya kushindwa. Maombi ambayo hayakufanikiwa haina gharama yoyote, isipokuwa mtoa huduma alihesabiwa kwa kazi aliyoifanya kabla ya kushindwa, au utafutaji wa wavuti au nymbot/auto udhibiti wa kazi tayari ulikuwa umefanyika; basi hiyo ni nini unalipa, angalau 0.05 kiwango. mtiririko unachangia unahesabiwa kwa tokens ambayo mtoa huduma anasema: Nymbot inaendelea kusoma mtiririko wa mtoa huduma hadi sekunde 25 baada ya kuondoka ili kupata hesabu hiyo. Ikiwa haijafika, malipo yanahesabiwa kutoka kwa kile ulichotuma na kile kilichoandikwa, na kwa mfano kwa sababu hiyo inajumuisha upatikanaji wote wa output wa kuhifadhi.
• Utafutaji wa wavuti gharama $ 0.008 utafutaji, kubadilishwa kwa sats, kila wakati utafutaji ulifanyika, kama mfano basi anajibu au kushindwa. kurasa anasoma pia kutumwa kwa mfano kama input, hivyo wanaongeza tokens zao.

Kila jibu linaelezea gharama gani. majibu ya JSON yana nymbot kitu na kiwango cha malipo kutoka kwake, malipo katika mikopo na taratibu, na kile kilichobaki:

Vifaa vya gharama

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

Majibu ya kulipwa pia yana vichwa hivi, ambayo ni mahali ambapo kutafuta gharama ya majibu ambayo sio JSON, kama vile hotuba:

Viwango kwa kila token milioni, tayari ikiwa ni pamoja na ada na margin, ni katika Orodha ya mifano katika sarafu ya fedha, na juu ya Orodha ya beiIkiwa bei ya Bitcoin haiwezi kusoma, maombi ya kulipwa yanarudi 503 price_unavailable kwa Retry-After: 60 badala ya kufikiri.

Makosa ya

Kila makosa ina sura sawa, moja ambayo wateja wa OpenAI tayari wanaelewa. code ni jina la kudumu ambalo unaweza kufanana na; message ni kwa ajili ya watu na inaweza kubadilika.

Mfano wa mwili

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

Kuna mambo mawili ya pekee:

• /api/v1/messages majibu katika muundo wa makosa ya Anthropic, kwa sababu hii ndiyo ambayo wateja wa Anthropic wanachunguza: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}Aina hii inafuata hali: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error au overloaded_error (503).
• Maombi ya mtiririko ambayo haifai kabla ya bajeti yake ya kwanza inapata makosa ya JSON ya kawaida na hali hapo juu, sio mtiririko wa matukio.

Ujumbe wa makosa hauna maelezo ya ndani ya huduma nyingine. Makosa ya mtoa huduma inabadilishwa kabla ya kuwasili kwako.

mipaka ya

Kiungo cha picha kinapaswa kuonyesha mwenyeji wa umma: anwani kwenye mtandao wa kibinafsi au wa ndani, au kwenye tovuti ya mwenyeji wa Nymbot, inasitishwa. hatua ya mtoa huduma ambayo inatumika katika programu pia inatumika hapa, hivyo mlipuko wa maombi kwa mtoa huduma mmoja unaweza kupunguzwa badala ya kushindwa.

Nini moto unaweza kuona

API si ya kibinafsi kwa njia ambayo programu ni, na ni thamani ya kuwa sahihi kuhusu jinsi.

• Sio mwisho kwa mwisho encrypted. Katika programu, ujumbe unafungwa kwenye kifaa chako kwa vidole tu Nymbot inachukua na kusafiri kama Ujumbe wa WrapMaombi ya API ni HTTPS ya kawaida: ni encrypted kwenye njia ya Nymbot, na seva ya Nymbot inasoma kwa wazi ili kushughulikia.
• Maombi na majibu hayawezi kuhifadhiwa. Wao kupita kupitia kwa mfano na jibu inapita nyuma. kile kinachopatikana ni akaunti: kwa kila ombi wakati, mfano, aina, token hesabu, gharama, usawa, muhimu na kama imeshindwa, kwa siku 90, ambayo ni nini Maoni ya Historia kumbukumbu ya matumizi ya ombi hilo (masaa, aina, mfano, idadi ya token, gharama, muda na kama ilitumia utafutaji wa wavuti au ulikuwa na mafanikio) pia imehifadhiwa kwa siku 90, pamoja na programu yake mwenyewe.
• Kila kitu kingine kilichohifadhiwa kwa nym ni ndogo na kutaja hapa. Nyumba ya moto ni kuhifadhiwa kama hash, kamwe kifungo, na jina lake, alama fupi, kifungo cha matumizi, muda wa kurejesha, kumalizika na wakati waliyofanywa na kutumika mwisho; tu vifungo vya hivi karibuni vya 50 vilivyofutwa vimehifadhiwa. Top-up ya moja kwa moja uhusiano wa wallet ni kuhifadhiwa encrypted, na kiwango chake, kiasi na matokeo ya mwisho up-up. kazi video ni kuhifadhiwa kwa masaa 24. maombi kulipwa kwa wito kuondoka tu malipo ya Lightning hash kwa siku 7 na hashed kurudi token kwa siku 30, iliyounganishwa na hakuna nym. malipo ambayo usawa hawezi kufunika ni kuhifadhiwa kama kulipwa mpaka up-up kulipa.
• Kuondoa app huondoa. A Mfumo wa Wipe kuondoa na kufuta kila kifungo cha API, na kuondoa historia ya maswali, rekodi za matumizi, uhusiano wa wallet na kazi za video.
• Mtoa huduma wa mfano anaweza kuona ombi lakoMifano ya orodha inafanya kazi kwa watengenezaji wao; njia za kiwango na uingizaji hufanya kazi kwenye Cloudflare.
• Vyombo vya habari vinavyotengenezwa ni vya umma. Picha na video zilizotolewa kama viungo hupelekwa kwenye mwenyeji wa faili ya Blossom ya umma, ambapo anwani ya faili ni hash yake. Mtu yeyote na kiungo kinaweza kufungua, na Nymbot haiwezi kuchukua tena. b64_json na picha iliyotengenezwa inakuja tena katika majibu na haijachapishwa kamwe.
• Hivyo ni picha ambayo wewe kutoa jenereta. Picha ambayo unaweza kupakia Edit yaau kutuma kama a data: URL ya Generator image_url, inasambazwa kwenye mwenyeji wa umma wa Blossom kwanza ili jenereta inaweza kupokea, na hiyo ni sawa. picha iliyotumwa na https:// Picha katika ombi la mazungumzo huenda kwa mtoa huduma wa mfano, sio kwa Blossom.
• Kichwa kinaunganishwa na nym yako. Kila kitu kinachotumia kifungo kinachotokana na usawa wa nym yako, hivyo matumizi ya API sio ya AnonymousIkiwa unataka matumizi ya API kuhifadhiwa mbali na nym yako ya kila siku, chaguo kutoka nym tofauti na usawa wake mwenyewe.

Kama unahitaji ulinzi wa programu, matumizi ya programu. API ni kwa wakati unahitaji mifano katika zana yako mwenyewe.

Kila hatua ya mwisho

“Nym” inamaanisha ombi lililoandaliwa na kifungo chako cha Nostr, kilichoelezwa katika Maombi ya kuandika akauntiKwa vifaa ambavyo tayari vinasema muundo huu, angalia Vifaa na SDKs, na kwa watumiaji wa coding kama Claude Code, Codex na Cline, angalia Vifaa vya coding.