కంటెంట్‌కి దాటవేయండి
తిరిగి Nymbot కి

నాలెడ్జ్ బేస్ డెవలపర్లు

API అవలోకనం

మీరు యాప్లో ఉపయోగించే నమూనాలు, జనరేటర్లు మరియు బ్యాలెన్స్ మీ స్వంత కోడ్ నుండి. API ఓపెన్ఏఐ మరియు ఆంత్రోపిక్ ఫార్మాట్లను మాట్లాడుతుంది, కాబట్టి చాలా సాధనాలు మరియు SDKలు బేస్ URL మరియు కీని మార్చడం ద్వారా పనిచేస్తాయి.

ఏపీఐ అంటే ఏమిటి?

ఒక HTTP API ఆన్లో ఉంది nymbot.ai అదే OpenAI లేదా Anthropic క్లయింట్ ఇప్పటికే పంపే అభ్యర్థనలకు సమాధానమిస్తుంది. మీకు లభిస్తుంది:

అది అదే రెండింటి నుండి చెల్లించబడింది సంతులనం యాప్ వలెనే, అదే ధరలలో. APIకి సబ్‌స్క్రిప్షన్ లేదా ఉచిత అలవెన్స్ ఏదీ ఉండదు: మీరు కొనుగోలు చేసిన క్రెడిట్ల నుండి ప్రతి రిక్వెస్ట్ కోసం చెల్లించాల్సి ఉంటుంది.

What the API does not do is add anything of Nymbot's own. Your messages 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 cost.

బేస్ URLలు

ఉపయోగించండి.బేస్ URL
ఓపెన్ఏఐ ఎస్డికెలు మరియు ఓపెన్ఏఐ-అనుకూల సాధనాలుhttps://nymbot.ai/api/v1
ఆంత్రోపిక్ ఎస్డికెలు మరియు క్లాడ్ కోడ్https://nymbot.ai/api (SDK కలుపుతుంది /v1/messages స్వయంగా)

ప్రతి ఎండ్‌పాయింట్ దీని కింద ఉంటుంది /api/v1/ఒక తెలియని మార్గం తిరిగి వస్తుంది 404 మరియు తప్పు పద్ధతితో పిలవబడిన తెలిసిన పాత్ తిరిగి ఇస్తుంది 405, రెండూ JSON గా.

API ఏ సైట్ నుండి అయినా క్రాస్-ఆరిజిన్ అభ్యర్థనలకు సమాధానం ఇస్తుంది, కాబట్టి బ్రౌజర్ పేజీ దానిని కాల్ చేయవచ్చు. మీరు బ్రౌజర్కు పంపే దేనినైనా దానిని తెరిచిన వారు చదవగలరు, అయితే, చిన్న సైటు ఉన్న కీతో మాత్రమే దీన్ని చేయండి. టోపీ. The endpoints signed with your nym (keys, the account summary, NWC auto-top-up and refund redemption) are the exception: in a browser they answer only Nymbot's own sites. See ఖాతా అభ్యర్థనలపై సంతకం చేయడం.

ప్రతి జెఎస్ఓఎన్ బాడీని పంపండి Content-Type: application/jsonఏ ఇతర రకం తో తిరస్కరించబడింది. 415, కాబట్టి సాదా హెచ్. టి. ఎం. ఎల్ రూపం లేదా text/plain మరొక సైట్ నుండి అభ్యర్థన API కి చేరుకోలేదు. cURL తో, పాస్ చేయండి -H "Content-Type: application/json" తో పాటు -d.

API కీలు

కీలు యాప్‌లో చేయబడతాయి. తెరవండి API వెబ్ యాప్ యొక్క సైడ్ బార్లో, లేదా ఆండ్రాయిడ్ మరియు ఐఓఎస్ మెనూలో, ఆపై నొక్కండి కీని సృష్టించండి. దానికి ఒక పేరు పెట్టండి మరియు, మీకు ఇష్టమైతే, ఒక పరిమితిని మరియు గడువు తేదీని.

కీ ఒక్కసారి మాత్రమే చూపబడుతుంది. షీట్‌ను మూసివేసే ముందు దానిని సురక్షితమైన చోట కాపీ చేసుకోండి: Nymbot దాని యొక్క వేలిముద్రను మాత్రమే ఉంచుకుంటుంది, కాబట్టి అది మీకు దానిని మళ్ళీ చూపలేదు. పోగొట్టుకున్న కీని తిరిగి పొందలేరు; దానిని రద్దు చేసి మరొకటి తయారు చేసుకోండి.

ఒక కీ ఇలా కనిపిస్తుంది sk-nymbot- తరువాత 43 అక్షరాలు, అంకెలు, డ్యాష్‌లు మరియు underscores ఉంటాయి. యాప్ ప్రతి కీని దాని పేరు మరియు ఒక చిన్న హింట్ ద్వారా జాబితా చేస్తుంది, ఉదాహరణకు sk-nymbot-Qm7x…c2Lw.

  • ఒక కీ మీ ఎన్ఐఎమ్ కు చెందినది. ఇది మీ బ్యాలెన్స్ను ఖర్చు చేస్తుంది, మరియు మీ ఎన్ఐఎమ్ మాత్రమే దానిని తయారు చేయగలదు, మార్చగలదు లేదా ఉపసంహరించుకోగలదు. కీని పట్టుకున్న ఎవరైనా దానితో ఖర్చు చేయవచ్చు, కాబట్టి దానిని పాస్వర్డ్ లాగా పరిగణించండి.
  • క్యాప్స్ సాట్స్లో ఉంటాయి. ఒక కీకి ఖర్చు పరిమితి (spending cap) ఉండవచ్చు, మరియు ఆ పరిమితి ప్రతిరోజూ, ప్రతి వారం (సోమవారం) లేదా ప్రతి నెలా (మొదటి తేదీన), 00:00 UTC సమయానికి రీసెట్ కావచ్చు. ఇది రెండు బ్యాలెన్స్‌లను లెక్కిస్తుంది, ఒక స్టాండర్డ్ క్రెడిట్‌ను 10 sats గా మరియు ఒక ప్రో క్రెడిట్‌ను 100 గా పరిగణిస్తుంది, కాబట్టి ఏ బ్యాలెన్స్ ఉపయోగించినా ఫలితం ఒకేలా ఉంటుంది. ఒక అభ్యర్థన (request) అమలు కావడానికి ముందు, దానికి అయ్యే గరిష్ట ఖర్చు (పూర్తి క్రెడిట్‌లకు రౌండ్ అప్ చేయబడినది) పరిమితిలో మిగిలి ఉన్న మొత్తంతో పోల్చబడుతుంది. ఒకవేళ అది సరిపోకపోతే, ఆ అభ్యర్థన నిరాకరించబడుతుంది 403 key_limit_reached, సమాధానం పరిమితి (cap) లోపే ఉన్నప్పటికీ; ఎంత మిగిలి ఉందో మరియు పరిమితి ఎప్పుడు రీసెట్ అవుతుందో ఆ ఎర్రర్ చెబుతుంది. తగ్గించడం max_tokens చెత్త కేసును తగ్గిస్తుంది. అభ్యర్థనకు వాస్తవానికి ఎంత ఖర్చు అవుతుందో వసూలు చేయబడుతుంది మరియు అది పరిమితికి వ్యతిరేకంగా లెక్కించబడుతుంది, కాబట్టి ప్రొవైడర్ కేటాయించిన దానికంటే ఎక్కువ టోకెన్లను నివేదించినట్లయితే, సరిపోయే చివరి అభ్యర్థన కీని దాని పరిమితికి కొద్దిగా మించి తీసుకెళ్లవచ్చు; తదుపరిది తిరస్కరించబడుతుంది.
  • ఖర్చయిన క్యాప్ ఖర్చును మాత్రమే ఆపుతుంది. దాని క్యాప్‌ వద్ద ఉన్న కీతోనే ఇంకా బ్యాలెన్స్‌ను తనిఖీ చేయవచ్చు, దాని చరిత్రను చదవవచ్చు, మోడల్‌లను జాబితా చేయవచ్చు, టోకెన్లను లెక్కించవచ్చు, టాప్ అప్ చేయవచ్చు మరియు ఇప్పటికే ప్రారంభించిన వీడియోను తనిఖీ చేయవచ్చు.
  • కాలపరిమితి ఐచ్ఛికం. మీరు నిర్ణయించిన తేదీ తర్వాత, కీ పనిచేయడం ఆగిపోతుంది.
  • రద్దు చేయడం తక్షణమే మరియు అంతిమమైనది. రద్దు చేయబడిన కీ దాని తదుపరి అభ్యర్థన విఫలమవుతుంది. అది జాబితాలో ఉంటుంది, రద్దు చేయబడినట్లుగా గుర్తించబడుతుంది, తద్వారా దాని ఖర్చు చరిత్ర ఇప్పటికీ అర్థవంతంగా ఉంటుంది.
  • మీరు 25 క్రియాశీల కీలను కలిగి ఉండవచ్చు, ఒక్కో కీకి దాని స్వంత పేరు ఉంటుంది. ఒక కీ యొక్క రీసెట్ పీరియడ్‌ను మార్చడం వల్ల కొత్త పీరియడ్ సున్నా నుండి ప్రారంభమవుతుంది.

అదే షీట్ ఈ కాలంలో మరియు మొత్తం మీద ప్రతి కీ యొక్క ఖర్చును, అది చివరిగా ఎప్పుడు ఉపయోగించబడిందో, మీ ఇద్దరి బ్యాలెన్స్‌లను మరియు మీ ఇటీవలి API రిక్వెస్ట్‌లను చూపుతుంది. దీని వెనుక ఉన్న ఎండ్‌పాయింట్లు ఇక్కడ డాక్యుమెంట్ చేయబడ్డాయి: నిర్వహణ కీలు.

ఒక అభ్యర్థితను ధృవీకరించడం

ఈ హెడర్‌లలో ఏదో ఒక దానిలో కీని పంపండి. ఇవి సమానమైనవే, కాబట్టి మీ క్లయింట్ డిఫాల్ట్‌గా దేనిని పంపిస్తే దానిని ఉపయోగించండి.

శీర్షికపంపిన వారు
Authorization: Bearer sk-nymbot-…OpenAI SDKలు, చాలా సాధనాలు, Claude Code తో ANTHROPIC_AUTH_TOKEN
x-api-key: sk-nymbot-…Anthropic SDKలు
api-key: sk-nymbot-…Azure-శైలి క్లయింట్లు

తప్పిపోయిన, తెలియని, రద్దు చేయబడిన లేదా గడువు ముగిసిన కీ రిటర్న్స్ 401కోడ్తో missing_api_key, invalid_api_key, revoked_api_key లేదా expired_api_keyమోడల్‌లు, ఆడియో మోడల్‌లు మరియు వాయిస్‌లు, మరియు చెల్లింపు పద్ధతులను జాబితా చేయడానికి ఎటువంటి కీ అవసరం లేదు.

చిత్రాలు, వీడియో, ప్రసంగం, ట్రాన్స్క్రిప్షన్ మరియు ఎంబెడింగ్లను కూడా లైట్నింగ్ ద్వారా ఒక సమయంలో ఒక అభ్యర్థనకు ఎటువంటి కీ లేకుండా చెల్లించవచ్చుః ఒకటి లేకుండా అభ్యర్థనను పంపండి మరియు ఇన్వాయిస్లో చెల్లించండి. 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 is Nymbot's own routing, paid from the standard balance. Put a catalog model's id there instead, such as anthropic/claude-sonnet-5, ఆ మోడల్‌ను ఉపయోగించడానికి Pro బ్యాలెన్స్ నుండి. మోడళ్ల జాబితా ప్రతి ఐడిని ఇస్తుంది.

అభ్యర్థనకు ఎంత ఖర్చు అవుతుంది?

యాప్ చేసే విధంగానే API కూడా ఖచ్చితంగా బిల్లు చేస్తుంది.

  • ఏ సంతులనం. nymbot/auto ఖర్చు చేస్తాడు/చేస్తుంది ప్రామాణికం బ్యాలెన్స్ (10 సాట్స్ క్రెడిట్). ప్రతి ఇతర చాట్ మోడల్ ఖర్చు చేస్తుంది ప్రో. బ్యాలెన్స్ (100 సాట్స్ క్రెడిట్). ప్రామాణిక ఇమేజ్ జనరేటర్ మరియు ప్రామాణిక వాయిస్ ప్రామాణిక క్రెడిట్లను ఖర్చు చేస్తాయి; ప్రతి ఇతర జనరేటర్ ప్రో ఖర్చు చేస్తుంది. ఎంబెడింగ్లు ప్రామాణిక క్రెడిట్లను ఖర్చు చేస్తాయి. ప్రామాణిక బ్యాలెన్స్ దానిని కవర్ చేయగలిగినప్పుడు ట్రాన్స్క్రిప్షన్ ప్రామాణిక క్రెడిట్లను ఖర్చు చేస్తుంది, మరియు ప్రో క్రెడిట్లు లేకపోతే. నమూనాల జాబితా ప్రతి మోడల్ ఖర్చులను సమతుల్యం చేస్తుంది.
  • ఎంత? చాట్ రిక్వెస్ట్ అనేది మోడల్ నిజంగా చదివిన మరియు వ్రాసిన టోకెన్ల ఆధారంగా, ప్రొవైడర్ ప్రకటించిన ధరల ప్రకారం లెక్కించబడుతుంది. ఆ ధరకు 5% ఫీజు జోడించబడుతుంది మరియు ఆపై 1.5 తో గుణించబడుతుంది, కాబట్టి మీరు ప్రొవైడర్ జాబితా ధర కంటే 1.575 రెట్లు చెల్లిస్తారు. ఇది లైవ్ బిట్‌కాయిన్ ధర వద్ద సాట్స్‌ (sats) కి మార్చబడుతుంది మరియు క్రెడిట్ యొక్క వేయి వంతులలో ఛార్జ్ చేయబడుతుంది. ప్రో పిక్చర్స్, వీడియో మరియు స్పీచ్ ధరలు ప్రతి జనరేషన్, ప్రతి సెకను లేదా ప్రతి క్యారెక్టర్ ఆధారంగా ఉంటాయి, మరియు ట్రాన్స్‌క్రిప్షన్ ఆడియో యొక్క ప్రతి సెకనుకు లెక్కించబడుతుంది, వీటన్నింటికీ అదే ఫీజు మరియు మార్జిన్ వర్తిస్తాయి. స్టాండర్డ్ పిక్చర్ కి ఖచ్చితంగా 5 స్టాండర్డ్ క్రెడిట్లు మరియు స్టాండర్డ్ వాయిస్ కి ఖచ్చితంగా 3 క్రెడిట్లు పడతాయి.
  • కనిష్టము. నడుస్తున్న ప్రతి మీటర్ అభ్యర్థనకు కనీసం 0.05 క్రెడిట్ ఖర్చు అవుతుందిః ప్రామాణిక బ్యాలెన్స్పై సగం సాట్, ప్రోపై 5 సాట్స్. క్రెడిట్ యొక్క భిన్నాలు తీసుకువెళతారు, ప్రతిసారీ పూర్తి చేయబడవు.
  • పట్టుకోండి, ఆపై స్థిరపడండి. ఒక రిక్వెస్ట్ నడవడానికి ముందు, మీరు పంపిన దాని ఆధారంగా మరియు అది వ్రాయగల గరిష్ట టోకెన్ల ఆధారంగా, అయ్యే గరిష్ట ఖర్చు మీ బ్యాలెన్స్ నుండి హోల్డ్ చేయబడుతుంది. plain ASCII కాకుండా ఇతర టెక్స్ట్ యొక్క పరిమాణం దాని UTF-8 బైట్ల నుండి లెక్కించబడుతుంది, మరియు ASCII అంకెలు మరియు విరామ చిహ్నాలు ఒక్కొక్కటి ఒక టోకెన్‌గా పరిగణించబడతాయి, కాబట్టి ఏ స్క్రిప్ట్‌లోని టెక్స్ట్ అయినా, కోడ్ మరియు నంబర్లు కూడా పూర్తిగా హోల్డ్ చేయబడతాయి. ఈ హోల్డ్ మొత్తం క్రెడిట్‌లలో, కనీసం ఒకటి ఉంటుంది, కాబట్టి ఏదైనా రిక్వెస్ట్ ప్రారంభించడానికి స్టాండర్డ్ బ్యాలెన్స్‌లో కనీసం 10 sats లేదా Pro లో 100 sats ఖాళీగా ఉండాలి. కేవలం వాస్తవ ఖర్చు మాత్రమే వసూలు చేయబడుతుంది; మిగిలినది రిక్వెస్ట్ పూర్తయినప్పుడు విడుదల చేయబడుతుంది. ఒక సుదీర్ఘమైన రిక్వెస్ట్ అది నడుస్తున్నంత కాలం దాని హోల్డ్‌ను ఉంచుతుంది; ఒకవేళ హోల్డ్ చేసిన క్రెడిట్‌లు అందుబాటులో లేకపోతే, స్ట్రీమ్ ఈ విధంగా ఆగిపోతుంది: 402 insufficient_balance దోషం సంభవించినప్పుడు, ఉత్పత్తి చేయబడినదానికి రుసుము వసూలు చేయబడుతుంది. వాస్తవ వ్యయం బకాయి చెల్లించగల దానికంటే ఎక్కువగా ఉంటే, మొత్తం బకాయి తీసుకోబడుతుంది, మిగిలినది చెల్లించబడుతుంది (owed_sats లో nymbot ఆబ్జెక్ట్, మరియు నెగటివ్ బ్యాలెన్స్). ఆ బ్యాలెన్స్ని చేరుకునే తదుపరి క్రెడిట్ల నుండి మొదట చెల్లించవలసినది. అది చెల్లించబడే వరకు, ఆ బ్యాలెన్స్పై ఏమీ ఖర్చు చేయలేముః API ద్వారా కాదు, యాప్లో ప్రత్యుత్తరాలు, బదిలీ లేదా బహుమతి.
  • తగినంత క్రెడిట్ లేదు. బ్యాలెన్స్ హోల్డ్ను కవర్ చేయలేకపోతే, అభ్యర్థన తిరస్కరించబడుతుంది 402 ఏదైనా రన్ కావడానికి ముందు. ఏ బ్యాలెన్స్ తక్కువగా ఉందో, అభ్యర్థనకు ఎన్ని సాట్స్ అవసరమో మరియు ఎన్ని ఉచితం అని ఎర్రర్ చెబుతుంది. చిన్నది max_tokens అంటే చిన్న పట్టు అని అర్థం.
  • వైఫల్యాలు. విఫలమైన రిక్వెస్ట్ వల్ల ఎటువంటి ఖర్చు ఉండదు, సదరు రిక్వెస్ట్ విఫలమవకముందు చేసిన పనికి ప్రొవైడర్ బిల్లు వేయనంత వరకు, లేదా వెబ్ సెర్చ్ లేదా ఆ... nymbot/auto టాస్క్ ముందుగానే రన్ అయి ఉంటే; అప్పుడు మీరు కనీసం 0.05 క్రెడిట్ చెల్లించాలి. మీరు నిలిపివేసిన స్ట్రీమ్ కోసం ప్రొవైడర్ రిపోర్ట్ చేసిన టోకెన్లకు ఛార్జ్ చేయబడుతుంది: ఆ కౌంట్‌ను పొందడానికి మీరు వెళ్ళిపోయిన తర్వాత కూడా Nymbot గరిష్టంగా 25 సెకన్ల వరకు ప్రొవైడర్ యొక్క స్ట్రీమ్‌ను చదువుతూనే ఉంటుంది. ఒకవేళ అది రాకపోతే, మీరు పంపిన మరియు వ్రాయబడిన దాని నుండి ఛార్జీ అంచనా వేయబడుతుంది, మరియు రీజనింగ్ చేసే మోడల్ కోసం ఇది హోల్డ్ యొక్క పూర్తి అవుట్‌పుట్ అలవెన్స్‌ను కలిగి ఉంటుంది. కనెక్షన్ డ్రాప్ అయిన రిక్వెస్ట్ కూడా పూర్తవుతుంది మరియు దానికి ఛార్జ్ చేయబడుతుంది.
  • వెబ్ శోధన ఒక్కో సెర్చ్‌కు $0.008 ఖర్చవుతుంది, దీనిని satsలోకి మార్చబడింది, సెర్చ్ జరిగిన ప్రతిసారీ, మోడల్ సమాధానం ఇచ్చినా లేదా విఫలమైనా ఇది వర్తిస్తుంది. అది చదివే పేజీలు కూడా ఇన్‌పుట్‌గా మోడల్‌కు పంపబడతాయి, కాబట్టి అవి వాటి టోకెన్లను జోడిస్తాయి.

ప్రతి స్పందన దాని ఖర్చు ఎంత అని చెబుతుంది. JSON స్పందనలు ఒకదాన్ని కలిగి ఉంటాయి nymbot చెల్లింపు చేసిన బ్యాలెన్స్, క్రెడిట్స్ మరియు సాట్స్ (sats) రూపంలో ఛార్జీ, మరియు మిగిలిన దానితో కూడిన ఆబ్జెక్ట్:

ఖర్చు వస్తువు

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

చెల్లింపు ప్రతిస్పందనలు కూడా ఈ శీర్షికలను కలిగి ఉంటాయి, ఇక్కడ ప్రసంగం వంటి JSON కాని ప్రతిస్పందన ఖర్చు కోసం వెతకాలిః

శీర్షికఅర్థం
X-Nymbot-Cost-Satsఈ అభ్యర్థనకు సాట్స్లో ఎంత ఖర్చు అవుతుంది.
X-Nymbot-Balance-Satsఅది చెల్లించిన బ్యాలెన్స్‌లో సాట్స్‌ (sats) లో ఇంకా ఎంత మిగిలి ఉంది?
X-Request-Idప్రతి స్పందనపై, అభ్యర్థన కోసం ఒక ఐడి. మీరు సపోర్ట్‌ను సంప్రదిస్తే దానిని ఉటంకించండి.

ఫీజు మరియు మార్జిన్‌ను ఇప్పటికే కలిపి, ప్రతి మిలియన్ టోకెన్ల రేట్లు...లో ఉన్నాయి. మోడళ్ల జాబితా డాలర్లలో మరియు సాట్స్‌లో, మరియు పై ధరల పట్టికబిట్కాయిన్ ధరను చదవలేకపోతే, చెల్లించిన అభ్యర్థనలు తిరిగి వస్తాయి. 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
  }
}
స్థితిఎప్పుడు?
400 invalid_request_errorబాడీ చెల్లుబాటు అయ్యే JSON కాదు (invalid_json), ఒక తప్పనిసరి ఫీల్డ్ లోపించింది (missing_required_parameter), ఒక విలువ తప్పుగా ఉంది, లేదా రిక్వెస్ట్ మోడల్ లేదా ఎండ్‌పాయింట్ చేయలేని దానిని అడుగుతోంది, ఉదాహరణకు టూల్స్ ఆన్ nymbot/auto (unsupported_tool). param రంగం పేరును పేర్కొనండి. అలాగే upstream_rejected అభ్యర్థనను ప్రొవైడర్ తిరస్కరించినప్పుడు.
401 authentication_errorకీ లేదు, తెలియదు, రద్దు చేయబడింది లేదా గడువు ముగిసింది, లేదా సంతకం చేసిన అభ్యర్థన చెల్లదు లేదా తిరిగి ఉపయోగించబడుతుంది.
402 insufficient_quotaబకాయి అభ్యర్థనను కవర్ చేయదు. కోడ్ insufficient_balance, తో balance, required_sats మరియు balance_sats.
403 permission_errorఅభ్యర్థన కీ యొక్క టోపీకి సరిపోదు (key_limit_reached, తో limit_sats, used_sats మరియు reset_at), లేదా ఖాతా సేవను ఉపయోగించకపోవచ్చు (account_denied).
404 not_found_errorతెలియని మార్గం (unknown_endpoint), ఉనికిలో లేని నమూనా (model_not_found), లేదా తెలియని కీ, ఇన్వాయిస్ లేదా వీడియో.
405మార్గం ఉంది కానీ ఆ పద్ధతితో కాదు (method_not_allowed). ఆ Allow శీర్షిక అది తీసుకునే పద్ధతులను జాబితా చేస్తుంది.
413బాడీ లేదా ఫైల్ చాలా పెద్దదిగా ఉంది (payload_too_large, file_too_large), లేదా రికార్డింగ్ చాలా పొడవుగా ఉంటుంది (audio_too_long). చూడండి పరిమితులు.
415 invalid_request_errorబాడీ గా పంపబడలేదు application/json (లేదా, అప్లోడ్ ఎండ్ పాయింట్ల కోసం, multipart/form-data): unsupported_media_type.
422వచనంలో ప్రసంగానికి కలిసి వెళ్ళని స్వరం మరియు భాష (voice_language_mismatch, unsupported_language).
429 rate_limit_errorఈ కీ నుండి, ఈ అడ్రస్ నుండి, లేదా ధృవీకరించడంలో విఫలమైన క్రెడెన్షియల్స్‌తో అతి తక్కువ సమయంలో మరీ ఎక్కువ రిక్వెస్ట్‌లు వచ్చాయి (rate_limit_exceeded), లేదా ప్రొవైడర్ రేట్-లిమిటింగ్ చేస్తోంది (upstream_rate_limited). సెకన్ల తరబడి వేచి ఉండండి. Retry-After.
500 api_errorSomething went wrong on Nymbot's side (internal_error).
502 api_errorప్రొవైడర్ సమాధానం ఇవ్వలేదు (upstream_error), లేదా మెరుపు ఇన్వాయిస్ తయారు చేయలేకపోయింది (invoice_unavailable).
503 api_errorప్రొవైడర్ ఓవర్లోడ్ చేయబడింది (upstream_overloaded), బిట్‌కాయిన్ ధరను చదవలేము (price_unavailable), లేదా సేవలో ఏదైనా భాగం నిలిచిపోయినట్లయితే (service_unavailable, media_hosting_unavailable). Retry-After ఎప్పుడు మళ్ళీ ప్రయత్నించాలో చెబుతుంది, అది ఎక్కడో తెలిసినప్పుడు.

రెండు మినహాయింపులు:

  • /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 లోపం వస్తుంది. స్ట్రీమ్ ప్రారంభమైన తర్వాత వైఫల్యం ఆ ఎండ్ పాయింట్ యొక్క సొంత ఆకృతిలో స్ట్రీమ్ యొక్క చివరి ఈవెంట్గా పంపబడుతుంది.

ఎర్రర్ మెసేజ్‌లు ఎప్పుడూ మరొక సర్వీస్‌కు సంబంధించిన అంతర్గత వివరాలను కలిగి ఉండవు. ఒక ప్రొవైడర్ యొక్క సొంత ఎర్రర్ మీ వద్దకు చేరుకునే ముందే మార్చబడుతుంది.

పరిమితులు

పరిమితివిలువ.
ప్రతి కీ అభ్యర్థనలునిమిషానికి 120. అంతకంటే ఎక్కువ, 429 తో Retry-After.
కీ లేకుండా అభ్యర్థనలుప్రతి అడ్రస్‌కు నిమిషానికి 120, మోడల్, ఆడియో మరియు పేమెంట్ మెథడ్ లిస్టింగ్స్, రీఫండ్ టోకెన్ చెక్లు, మరియు కీ లేదా పేమెంట్ లేకుండా పిలవబడిన పెయిడ్ ఎండ్‌పాయింట్స్ కోసం. అంతకంటే ఎక్కువ, 429 తో Retry-After.
ధృవీకరణ విఫలమైందికీలు, సంతకాలు, చెల్లింపు ఆధారాలు మరియు ధృవీకరించని రీఫండ్ టోకెన్ల కోసం చిరునామాకు నిమిషానికి 30 రూపాయలు. అంతకు మించి, ధృవీకరణ పత్రాన్ని కలిగి ఉన్న చిరునామా నుండి ప్రతి అభ్యర్థన పొందుతుంది. 429 తో Retry-After ఆ నిమిషం ముగిసే వరకు. బాడీని చదివే ముందు క్రెడెన్షియల్స్ తనిఖీ చేయబడతాయి.
కొత్త కీలుప్రతి nym కి గంటకు 60 మరియు ప్రతి అడ్రస్ కి గంటకు 120.
టాప్-అప్ ఇన్‌వాయిస్‌లుప్రతి nym కి గంటకు 60 మరియు ప్రతి అడ్రస్ కి గంటకు 120.
ఎన్డబ్ల్యుసి వాలెట్ కనెక్షన్లుఎన్ఐఎమ్కు గంటకు 10 మరియు చిరునామాకు గంటకు 30. వాలెట్ రిలే ఉపయోగించాలి wss:// ప్రామాణిక నౌకాశ్రయంలో.
తిరిగి చెల్లింపు టోకెన్లుప్రతి టోకెన్కు నిమిషానికి 60 అభ్యర్థనలు.
చిరునామాలుప్రతి చిరునామా పరిమితిలో (per-address limit) ఒక IPv6 చిరునామా దాని పూర్తి /64 గా పరిగణించబడుతుంది, మరియు ఒక IPv4-mapped IPv6 చిరునామా దాని IPv4 చిరునామాగా పరిగణించబడుతుంది.
జెఎస్ఒఎన్ అభ్యర్థన సంస్థ4 MB; మీ nym తో సంతకం చేసిన అభ్యర్థనల కోసం 64 KB.
బహుళ భాగాల అభ్యర్థన సంస్థ (అప్లోడ్ లు)32 MB. ఎడిట్ చేయడానికి ఒక చిత్రం 20 MB వరకు, ఒక ఆడియో ఫైల్ 25 MB వరకు ఉండవచ్చు. గరిష్టంగా 64 భాగాలు, ప్రతి భాగంలో గరిష్టంగా 8 KB పార్ట్ హెడర్లు, మరియు 1 నుండి 70 అక్షరాల బౌండరీ; లేకపోతే 400 invalid_multipart.
ఒక చాట్ రిక్వెస్ట్‌లో చిత్రాలు20. ప్రతిదీ ఒక https:// లేదా http:// పబ్లిక్ హోస్ట్కు లింక్ చేయండి, లేదా data:image/… URL.
ప్రతి జనరేషన్ రిక్వెస్ట్‌కు చిత్రాలు1 నుండి 4 (n)
అవుట్పుట్ టోకెన్లుమోడల్ యొక్క స్వంత గరిష్ట స్థాయి వద్ద పరిమితం చేయబడింది. ఒక పెద్ద max_tokens అది తగ్గించబడింది, తిరస్కరించబడలేదు.
వాయిస్ ఇన్‌పుట్స్టాండర్డ్ వాయిస్ కోసం 800 అక్షరాలు, Aura 2 కోసం 2,000 అక్షరాలు.
ట్రాన్స్క్రిప్షన్30 నిమిషాల ఆడియో, 25 MB. అంతకంటే ఎక్కువ నిడివి ఉన్న రికార్డింగ్‌ను తిరస్కరించడమైనది 413 విస్పర్ విన్న తర్వాత మాత్రమే దాని పొడవు తెలిసినప్పటికీ ఛార్జ్ చేయబడదు.
ఎంబెడెడ్లుప్రతి రిక్వెస్ట్‌కు 100 ఇన్‌పుట్‌లు.
వీడియో ఉద్యోగాలుఅవి సమర్పించిన తర్వాత 24 గంటల పాటు ఉంచబడతాయి; ఒక రెండర్ గంట తర్వాత వదులు చేయబడుతుంది. ప్రతి nym కి ఒకేసారి గరిష్టంగా 10 రెండరింగ్.
ప్రశ్నల చరిత్ర90 రోజుల పాటు ఉంచబడింది.
ప్రతి ఎన్ఐఎమ్ కు క్రియాశీల కీలు25. కేవలం కొత్తగా రద్దు చేయబడిన 50 కీలు మాత్రమే ఉంచబడతాయి.

చిత్రానికి సంబంధించిన లింక్ పబ్లిక్ హోస్ట్‌ను సూచించాలి: ప్రైవేట్ లేదా లోకల్ నెట్‌వర్క్‌లోని అడ్రస్, లేదా Nymbot యొక్క సొంత సైట్‌ల అడ్రస్‌ను తిరస్కరించడం జరుగుతుంది. యాప్‌లో వర్తించే ప్రొవైడర్ పేసింగ్ ఇక్కడ కూడా వర్తిస్తుంది, కాబట్టి ఒకే ప్రొవైడర్‌కు వరుసగా పంపే రిక్వెస్ట్‌లను విఫలం చేయడం కంటే వేగాన్ని తగ్గించడం జరుగుతుంది.

API ఏమి చూడగలదు

అనువర్తనాలు ఉన్న విధంగా API ప్రైవేట్ కాదు, మరియు ఎలా అనే దాని గురించి ఖచ్చితమైనదిగా ఉండటం విలువ.

  • ఇది ఎండ్-టు-ఎండ్ ఎన్క్రిప్టెడ్ కాదు. In the apps, a message is sealed on your device to keys only Nymbot holds and travels as a బహుమతి ప్యాకింగ్ఒక API రిక్వెస్ట్ సాధారణ HTTPS: ఇది Nymbot కి వెళ్లే దారిలో ఎన్‌క్రిప్ట్ చేయబడుతుంది, మరియు Nymbot సర్వర్ దానిని హ్యాండిల్ చేయడానికి క్లియర్ టెక్స్ట్‌గా చదువుతుంది.
  • ప్రాంప్ట్‌లు మరియు సమాధానాలు నిల్వ చేయబడవు. అవి మోడల్‌లోకి వెళ్తాయి మరియు సమాధానం తిరిగి వస్తుంది. నిల్వ చేయబడేది బిల్లు: ప్రతి రిక్వెస్ట్‌కు సమయం, మోడల్, రకం, టోకెన్ సంఖ్యలు, ఖర్చు, బ్యాలెన్స్, కీ మరియు అది విజయవంతమైందో లేదో అనే వివరాలు, 90 రోజుల పాటు, అది ఏమిటంటే ప్రశ్నల చరిత్ర మీకు చూపిస్తుంది. అదే రిక్వెస్ట్‌కు సంబంధించిన వినియోగ రికార్డు (సమయం, రకం, మోడల్, టోకెన్ల సంఖ్య, ఖర్చు, వ్యవధి మరియు అది వెబ్ సెర్చ్ ఉపయోగించిందా లేదా విజయవంతమైందా అనే వివరాలు) యాప్‌ యొక్క స్వంత రికార్డులతో పాటు 90 రోజుల పాటు భద్రపరచబడతాయి.
  • nym కోసం ఉంచుకున్న మిగిలినవన్నీ చిన్నవి మరియు ఇక్కడ జాబితా చేయబడ్డాయి. API కీలు వాటి పేరు, చిన్న సూచన, ఖర్చు పరిమితి, రీసెట్ వ్యవధి, గడువు మరియు అవి ఎప్పుడు తయారు చేయబడ్డాయి మరియు చివరిసారిగా ఉపయోగించబడ్డాయి అనే వాటితో హాష్గా నిల్వ చేయబడతాయి, కొత్త 50 రద్దు చేయబడిన కీలు మాత్రమే ఉంచబడతాయి. ఆటోమేటిక్ టాప్-అప్ వాలెట్ కనెక్షన్ నిక్షిప్తపరచబడింది ఎన్‌క్రిప్ట్ చేయబడిన పద్ధతిలో, దాని త్రెషోల్డ్, మొత్తం మరియు చివరి టాప్-అప్ ఫలితంతో పాటు. వీడియో జాబ్స్ 24 గంటల పాటు ఉంచబడతాయి. ప్రతి కాల్‌కు చెల్లించే రిక్వెస్ట్‌లు కేవలం 7 రోజుల వరకు లైట్నింగ్ పేమెంట్ హాష్‌ను మరియు 30 రోజుల వరకు హాష్ చేయబడిన రీఫండ్ టోకెన్‌ను మాత్రమే ఉంచుతాయి, ఇవి ఎటువంటి nym తో అనుసంధానించబడవు. బ్యాలెన్స్ కవర్ చేయలేని ఛార్జీలు, టాప్-అప్ ద్వారా చెల్లించే వరకు బకాయిలుగా ఉంచబడతాయి.
  • యాప్‌ను వైప్ చేయడం వల్ల అది డిలీట్ అవుతుంది. A పరికరాన్ని తుడిచివేయండి ప్రతి API కీని ఉపసంహరించుకుంటుంది మరియు తొలగిస్తుంది, మరియు ప్రశ్న చరిత్ర, వినియోగ రికార్డులు, వాలెట్ కనెక్షన్ మరియు వీడియో ఉద్యోగాలను తొలగిస్తుంది. బ్యాలెన్స్ మరియు ఏవైనా ఛార్జీలు ఇప్పటికీ NIM పైనే ఉంటాయి.
  • మోడల్ యొక్క ప్రొవైడర్ మీ అభ్యర్థనను చూస్తారుఅనువర్తనం నుండి మాదిరిగానే. కేటలాగ్ నమూనాలు వాటి తయారీదారుల వద్ద నడుస్తాయి; ప్రామాణిక మార్గాలు మరియు ఎంబెడింగ్లు క్లౌడ్ఫ్లేర్లో నడుస్తాయి.
  • జనరేటెడ్ మీడియా అనేది పబ్లిక్. Pictures and video delivered as links are uploaded to public Blossom file hosts, where a file's address is its hash. Anyone with the link can open it, and Nymbot cannot take it down again. Ask for b64_json మరియు ఒక జనరేట్ చేయబడిన చిత్రం ప్రతిస్పందనలో తిరిగి వస్తుంది మరియు ఎప్పుడూ అప్‌లోడ్ చేయబడదు.
  • అంటే మీరు ఇచ్చే చిత్రాలు ఒక జనరేటరా? మీరు అప్‌లోడ్ చేసే చిత్రం సవరించండి, లేదా ఒక గా పంపండి data: జనరేటర్ యొక్క URL లో image_url, మొదట పబ్లిక్ Blossom హోస్ట్‌కు అప్‌లోడ్ చేయబడుతుంది తద్వారా జనరేటర్ దానిని పొందగలదు, మరియు అదే దానికి కూడా వర్తిస్తుంది. ఒక చిత్రం పంపబడినప్పుడు https:// లింక్ ఆ లింక్‌గానే పంపబడుతుంది. చాట్ రిక్వెస్ట్‌లో ఉన్న చిత్రాలు మోడల్ యొక్క ప్రొవైడర్‌కు వెళ్తాయి, Blossom కి కాదు.
  • ఒక కీ మీ నిమ్కు అనుసంధానించబడి ఉంటుంది. ఒక కీ ఖర్చు చేసే ప్రతిదీ మీ నిమ్ బ్యాలెన్స్ నుండి వస్తుంది, కాబట్టి API ఉపయోగం కాదు అనామకమీరు API వాడకాన్ని మీ రోజువారీ NIM నుండి వేరుగా ఉంచాలనుకుంటే, దాని స్వంత బ్యాలెన్స్ తో ప్రత్యేక NIM నుండి కీలను తయారు చేయండి.

మీకు యాప్‌ల రక్షణ కావాలంటే, యాప్‌లను ఉపయోగించండి. మీ స్వంత టూల్స్‌లో మోడల్స్ కావాలనుకున్నప్పుడు API ఉపయోగపడుతుంది.

ప్రతి ముగింపు బిందువు

ముగింపు బిందువుఅది ఏమి చేస్తుందిఔత్.
GET /api/v1/modelsమోడళ్ల జాబితాధరలతోఏమీ లేదు
POST /api/v1/chat/completionsచాట్ ముగింపులుకీ
POST /api/v1/responsesరెస్పాన్సెస్ APIకీ
POST /api/v1/messagesఆంత్రోపిక్ మెసేజెస్కీ
POST /api/v1/messages/count_tokensఇన్పుట్ టోకెన్లను అంచనా వేస్తుందికీ
POST /api/v1/images/generationsచిత్రాలను రూపొందిస్తుందికీ లేదా మెరుపు
POST /api/v1/images/editsచిత్రాన్ని సవరించండికీ లేదా మెరుపు
POST /api/v1/videos, GET /api/v1/videos, GET /api/v1/videos/{id}వీడియోలను ప్రారంభిస్తుంది, జాబితా చేస్తుంది మరియు తనిఖీ చేస్తుందికీ, లేదా మెరుపు ఒకదాన్ని ప్రారంభించడానికి
POST /api/v1/audio/speechప్రసంగానికి వచనముకీ లేదా మెరుపు
GET /api/v1/audio/models, GET /api/v1/audio/voicesఆడియో నమూనాలు మరియు స్వరాలుఏమీ లేదు
POST /api/v1/audio/transcriptions, POST /api/v1/audio/translationsవచనంతో మరియు ఆంగ్లంలో మాట్లాడండికీ లేదా మెరుపు
POST /api/v1/embeddingsఎంబెడెడ్లుకీ లేదా మెరుపు
GET /api/v1/credits/balance (లేదా POST)రెండూ సంతులనంకీ
GET /api/v1/topup/payment-methodsచెల్లింపు మార్గాలుఏమీ లేదు
POST /api/v1/topup/create/btc-lightningఒక మెరుపు ఇన్వాయిస్కీ
GET /api/v1/topup/status/{invoice_id}దాన్ని తనిఖీ చేసి క్రెడిట్ చేయండికీ
GET /api/v1/queries/historyప్రతి అభ్యర్థనకు ఎంత ఖర్చు అవుతుందికీ లేదా నిమ్
GET /api/v1/accountఖాతా సారాంశంనీమ్.
/api/v1/keysకీలను తయారు చేస్తుంది, మారుస్తుంది మరియు ఉపసంహరించుకుంటుందినీమ్.
/api/v1/nwc-auto-topupఆటోమేటిక్ టాప్-అప్స్నీమ్.
GET /api/v1/l402/refunds, POST /api/v1/l402/refunds/redeemరీఫండ్ టోకెన్ను తనిఖీ చేస్తుంది లేదా రీడీమ్ చేస్తుందిరీఫండ్ టోకెన్; రిడీమ్ చేయడానికి nym

“Nym” means a request signed by your Nostr key, described in ఖాతా అభ్యర్థనలపై సంతకం చేయడంఇప్పటికే ఈ ఫార్మాట్లను మాట్లాడే సాధనాల కోసం, చూడండి సాధనాలు మరియు SDKలు, మరియు Claude Code, Codex మరియు Cline వంటి కోడింగ్ ఏజెంట్ల కోసం, ఇక్కడ చూడండి కోడింగ్ సాధనాలు.