بڕۆ بۆ ناوەڕۆکەکە
گەڕانەوە بۆ Nymbot

بنکەی زانیاری گەشەپێدەران

کورتەی API

مۆدێلەکان، بەرهەمهێنەرەکان و هاوسەنگییەکە کە لە ئەپەکەدا بەکاردێنیت، لە کۆدی خۆتەوە. API زمانی فۆرماتەکانی OpenAI و Anthropic بەکاردێنێت، بۆیە زۆربەی ئامرازەکان و SDKەکان کار دەکەن لە ڕێگەی گۆڕینی URLێکی بنەڕەتی و کلیلێکەوە.

API چییە

HTTP API لەسەر nymbot.ai ئەو وەڵامەی هەمان داواکارییەکان دەداتەوە کە کڕیارێکی OpenAI یان Anthropic پێشتر دەیڕەوێنێتەوە. تۆ دەستکەوت دەبێت:

ئەوە لە هەمان دوو دەدرێت. هاوسەنگییەکان وەک ئەپەکە، بە هەمان نرخەکان. هیچabشتێکی مانگانە و هیچ ڕێژەیەک بۆ بەکارهێنانی بە خۆڕایی لە API نییە: هەر داواکارییەک بە پارەی ئەو کرێدانەی کە کڕیوتە، دەبێت.

ئەوەی API ئەنجامی نادات ئەوە نییە شتێکی تایبەت بە Nymbot زیاد بکات. نامەکان وەک ئەوە دەچن بۆ مۆدێلەکە کە ناردووت they: هیچ پرۆمپتێکی سیستەمی Nymbot، هیچ یادەوەرییەک، هیچ ئاماژەیەکی ڕێکەوت یان زمان نییە. ئەوەی دەگەڕێتەوە وەڵامی مۆدێلەکەیە و تێبینییەک لەسەر ئەوەی چەند تێچووە.

ناونیشانی بنەڕەتی URLەکان

بکاربهێنەناونیشانی سەرەکی (Base URL)
OpenAI SDKوەکان و ئامرازە هاوشێوەکانی OpenAIhttps://nymbot.ai/api/v1
Anthropic SDK-ەکان و Claude Codehttps://nymbot.ai/api (SDKەکە زیاد دەکات /v1/messages خۆی

هەموو کۆتاییگەیەک (endpoint) لەژێر دەژی /api/v1/ڕێگەیەکی نەناسراو دەگەڕێتەوە. 404 و ڕێگەیەکی ناسراو کە بە ڕێگەی هەڵە بانگ دەکرێت دەگەڕێتەوە 405هەردووکیان وەک JSON.

APIیەکە وەڵامی داواکارییەکانی cross-origin لە هەر سایتێکەوە دەداتەوە، بۆیە لاپەڕەی وێبگەڕێک دەتوانێت بانگیدەی بکات. بەڵام هەرچییەک بنێریت بۆ وێبگەڕێک دەکرێت لەلایەن هەر کەسێکەوە بخوێندرێتەوە کە بیکاتەوە، بۆیە تەنها بە کلیلێک ئەوە بکە کە دەستگەیشتنی کەمە کڵاوەبەرەسپۆڕەکان (endpoints) کە بە ناوی تۆ (کلیلەکان، کورتەی ئەکاونت، NWC auto-top-up و refund redemption) واژۆ کراون بڕگەیەکی جیاوازن: لە وێبگەڕێکدا تەنها وەڵامی ماڵپەڕەکانی خۆی لە Nymbot دەدەنەوە. ببینە واژەکردنی داواکارییەکانی هەژمار.

هەموو جەستەی JSON بنێرە لەگەڵ Content-Type: application/jsonهەر جۆرێکی تر لەگەڵ ڕەت دەکرێتەوە 415, کەواتە فۆرمێکی سادەی HTML یان text/plain داواکاری لە ماڵپەڕێکی تر ناتوانێت بگاتە API. بە cURL، ڕەوانە بکە -H "Content-Type: application/json" لەگەڵ -d.

کلیلەکانی API

کلیلەکان لە ئەپەکەدا دروست دەکرێن. کرانەوە API لە بەشی لایەنی ئەپی وێبەکە، یان لە مینیو لەسەر ئەندرۆید و ئایۆس، و دەست لێ بدە کلیلەکە دروست بکەناوێکی بۆ دابنێ و ئەگەر حەز دەکەیت، سەری و ڕێکەوتێکی بەسەرچوون بۆ دابنێ.

کلیلەکە تەنها جارێک نیشان دەدرێت. پێش ئەوەی لاپەڕەکە دابخەیت، لە شوێنێکی سەلامەت کۆپی بکە: Nymbot تەنها پەنجەمۆرێکی (fingerprint) کلیلەکە دەپارێزێت، بۆیە ناتوانێت دووبارە پیشانی بداتەوە. کلیلێک کە ون بێت ڕێکدەخرێتەوە؛ هەڵوەشاندنەوەی بکە و کلیلێکی تر دروست بکە.

کلیلەکە وەک ئەمەیە 🗝️ sk-nymbot- بەدوای ٤٣ پیت، ژمارە، هێڵی و ژمارەیی (underscore) لەپاشیدا دێت. ئەپەکە هەر کلیلێک بە ناوی خۆی و ئاماژەیەکی کورت لیست دەکات وەک sk-nymbot-Qm7x…c2Lw.

  • کلیلێک هی ناوی تۆیە. بە تێدەپەڕاندنی باڵانسەکەت، و تەنها nym دەتوانێت دروستی بکات، گۆڕینی بکات یان هەڵوەشێنێتەوە. هەر کەسێک کلیلەکە لەدەست بکات دەتوانێت بە بەکارهێنانی خەرج بکات، بۆیە وەک وشەی نهێنی (password) مامەڵەی لەگەڵ بکە.
  • کاپەکان لە ساتدانەکاندان. کلیلێک دەتوانێت سنووری خەرجکردن هەبێت، و سنوورەکە دەتوانێت ڕاوەستێتەوە هەموو ڕۆژێک، هەموو هەفتەیەک (دووشەممە) یان هەموو مانگێک (یەکەم)، لە کاتی 00:00 UTC. ئەمەش هەردوو هاوسەنگیی (balances) دەژمێرێت، کرێیە ئاساییەکە وەک ١٠ سات و کرێی Pro وەک ١٠٠، بۆیە واتە هەمان شتە بە هەر هاوسەنگییەک داواکارییەکە خەرج بکات. پێش ئەوەی داواکارییەکە کار بکات، زۆرترین بڕی تێچوو کە دەکرێت (کە بۆ تەواوی کرێیەکان ڕاوەستێنراوە) دەیخاتە بەر ئەوەی لە سنوورەکەدا ماوەتەوە. ئەگەر گونجاو نەبوو، داواکارییەکە ڕەت دەکرێتەوە بە... 403 key_limit_reached، تەنانەت ئەگەر وەڵامەکە لە ژێر سنوورەکەشدا دەهات؛ هەڵەکە دەڵێت چەند ماوە و کەی سنوورەکە ڕێکدەچێتەوە. کەمکردنەوە max_tokens ئەو خراپترین بارودۆخە کەم دەکاتەوە. داواکارییەک بەوە کرێ دەکرێت کە لە ڕاستیدا تێچووی هەبووە و ئەوە لە بەرامبەر سنوورەکەدا هەژمار دەکرێت، بۆیە ئەگەر دابینکەر زیاتر لەو تۆکەنەی کە دانراوە ڕاپۆرت بکات، دوا داواکارییەکە کە گونجا بێت دەتوانێت کلیلەکە کەمێک لە سنوورەکەی تێپەڕ بکات؛ دواتر داواکارییەکەی داهاتوو ڕەت دەکرێتەوە.
  • کۆڵەکەیەکی خەرجیی بەسەرچووە تەنها ڕێگری لە خەرجکردن دەکات. یەک کلیل لە سەر کڵاوەکەی خۆی هێشتا دەتوانێت هاوسەنگی بپەرسینەوە، مێژووەکەی بخوێنێتەوە، مۆدێلەکان لیست بکات، تووکەنەکان بژێرێت، بارکردنەوە بکات و چاوپێکەوتنی ڤیدیۆیەکی بکات کە پێشتر دەستی پێکردووە.
  • کاتی بەسەرچوون ئارەزوومەندانەیە. دوای ئەو بەروارەی تۆ دیاری دەکەیت، کلیلەکە کار ناکات.
  • هەڵوەشاندنەوەکە دەستبەجێ و کۆتاییە. کلیلێکی هەڵوەشاوە لە داواکارییەکەی داهاتوودا سەرکەوتوو ناهێڵێت. لە لیستەکەدا دەمێنێتەوە و وەک هەڵوەشاوە نیشان دەکرێت، بۆ ئەوەی مێژووی خەرجییەکەی هێشتا مانای هەبێت.
  • دەتوانیت تا ٢٥ کلیلەی چالاک هەبێت، هەر یەکێکیان ناوی تایبەتی خۆی هەبێت. گۆڕینی ماوەی نوێبوونەوەی کلیلێک ماوەیەکی نوێ لە سفرەوە دەست پێ دەکات.

هەمان لاپەڕە میزان و خەرجی هەر کلیلێک لەم ماوەیەدا و بە گشتی، کاتی دوایین بەکارهێنانی، هەردوو باڵانسی تۆ، و داواکارییە ڕێکەوتەکانی API نوێیەکەت نیشان دەدات. ئەو خاڵانەی کۆتایی کە لە پشتەوەی هەن لەژێر ئەم ناونیشانەدا دۆکیومێنت کراون: بەڕێوەبردنی کلیلەکان.

ڕاستکردنەوەی داواکارییەک

کلیلەکە لە هەر یەکێک لە ئەم سەرلەدەستەکانەدا بنێرە. ئەوان وەک یەک ودان، بۆیە هەر کامەیەک کڕیارەکەت بە شێوەی ئۆتۆماتیکی دەنێرێت بەکاربهێنە:

سەرناولەلایەن ناردراوە
Authorization: Bearer sk-nymbot-…SDK-ên OpenAI، زۆربەی ئامرازەکان، 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لیستی مۆدێلەکان، مۆدێلە دەنگییەکان و دەنگەکان، و ڕێگاکانی پارەدان پێویستی بە کلیل نییە.

وێنە، ڤیدیۆ، قسە، دەقگۆڕینی دەنگ بۆ نووسین و embedding دەکرێت لە یەک کاتدا بۆ یەک داواکاری لە ڕێگەی Lightning بەبێ هیچ کلیلێکیدا پارەیان بۆ بکرێت: داواکارییەکە بەبێ کلیل بنێرە و پسوڵەکە دابخە... 402 وەڵام بدەرەوە. ببینە بە هەر داواکارییەک پارەدان بەبێ کلیل.

بەڕێوەبردنی کلیل، کورتەی ئەژمار و پڕکردنەوەی خۆکار هەڵگێڕانەوەن: ئەوان واژۆ لە نێو nymەکەتەوە وەردەگرن لەبری کلیل، بۆیە کلیلێکی دزەپێکراو ناتوانێت کلیلەکانی زیاتر دروست بکات. ببینە واژەکردنی داواکارییەکانی هەژمار.

داواکاری یەکەمت

کلیلەکە بخەرە ناو گۆڕاوێکی ژینگە (environment variable)، پاشان شتێک لە مۆدێلەکە بپرسە. نموونەکان لە دەمەوە دەخوێننەوە لە 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 ڕێڕەوی تایبەتی Nymbotە، کە لە ڕێگەی هاوکاتە ستانداردەکەوە دەیدەspay. لە جیاتی ئەوە، ناسنامەی (id) مۆدێلێکی کاتەلۆگ دابنێ، وەک: anthropic/claude-sonnet-5, بۆ بەکارهێنانی ئەو مۆدێلە لە باڵانسی Pro. لیستکردنی مۆدێلەکان هەموو ناسنامەکان (id) دەدات.

داواکارییەکە چەند تێچووێکی هەیە

تێچووی API ڕێک وەک ئەپەکە ئەنجام دەدات.

  • کامیان هاوسەنگییە؟ nymbot/auto خەرجی دەکات بۆ ستاندارد باڵانس (١٠ سات کرێدیت). هەر مۆدێلێکی تری چاتەکە کاتەکە خەرج دەکات پڕۆفێشناڵ باڵانس (١٠٠ sats بە کۆرێدیت). بەرهەمهێنەری وێنەی ستاندارد و دەنگی ستاندارد کۆرێدی ستاندارد بەکار دەهێنن؛ هەر بەرهەمهێنەرێکی تری ڕەنگە Pro بەکار بهێنێت. Embeddings کۆرێدی ستاندارد بەکار دەهێنێت. Transcription کۆرێدی ستاندارد بەکار دەهێنێت ئەگەر باڵانسی ستاندارد بەس نەبێت، و ئەگەر بەس نەبوو، کۆرێدی Pro بەکار دەهێنێت. لیستی مۆدێلەکان دەڵێت هەر مۆدێلێک کام باڵانس بەکار دەهێنێت.
  • بە چەند؟ داواکاری گفتگۆ بەپێی ئەو تۆکنانە کرێ دەکرێت کە مۆدێلەکە لە ڕاستیدا خوێندبوو و نووسیویەتی، بە نرخەکانی بڵاوکراوەی دابینکەر. ئەو نرخە ٥٪ کارمەند (fee) بۆ زیاد دەکرێت و پاشان لە ١.٥ جێگیر دەکرێت، بۆیە تۆ ١.٥٧٥ جار نرخە لیستەی دابینکەر دەدەیتی. بە نرخە زیندووەکەی بیتکۆین دەگۆڕدرێت بۆ sats و بە هەزار یەکێکی کرێدیت لێ وەردەگیرێت. وێنەی پرۆفیشناڵ، ڤیدیۆ و دەنگ بەپێی هەر بەرهەمهێنانێک، هەر چرکەیەک یان هەر پیتێک نرخ دەکرێن، و نووسینی دەنگ (transcription) بەپێی هەر چرکەیەک لە دەنگ، بە هەمان کارمەند و هامۆنشی (margin). وێنەی ستاندارد بە شێوەیەکی جێگیر ٥ کرێدیتی ستانداردە و دەنگی ستانداردیش بە شێوەیەکی جێگیر ٣.
  • کەمترین. هەر داواکارییەکی پێوانەکراو کە کار بکات، بە کەم nhất ٠.٠٥ کرێدیت تێدەچێت: نیوەی سات لە هاوسەنگی ستاندارددا، ٥ سات لە Proدا. پارچەکانی کرێدیت دەگوازرێنەوە، نەک هەر جارێک ڕاگردرێن بۆ سەرەوە.
  • بوەستە، پاشان جێگیر ببە. پێش ئەوەی داواکارییەکە کار بکات، زۆرترین بڕی تێچوو کە ڕەنگە هەبێت لە هاوسەنگییەکەتەوە ڕادەگیرێت، ئەوەش بەپێی ئەوەی ناردووتە و زۆرترین توکن کە ڕەنگە بنوسێت. ئەو دەقەی لە دەرەوەی ASCII ڕەقە، لە ڕێگەی بایتی UTF-8ی لە پێوە دەپێورێت، و ژمارە و نیشانەکانی ASCII هەر یەککەیان وەک یەک توکن هەژمار دەکرێن، بۆیە دەق لە هەر نووسینێکی ترەوە، کۆد و ژمارەکان بە تەواوی ڕادەگیرێن. ڕاگرتنەکە بە تەواوی کریدیتە، بە لایەنی کەم یەک کریدیت، بۆیە هەر داواکارییەک پێویستی بە لایەنی کەم ١٠ سات لە هاوسەنگی ستاندارد یان ١٠٠ سات لە Pro هەیە بۆ دەستپێکردن. تەنها تێچووی ڕاستەقینە لێ دەگیرێت؛ ئەوەی تری لە کاتی تەواوبوونی داواکارییەکەدا دەگەڕێنێتەوە. داواکارییە درێژەکان ڕاگرتنی کریدیتەکە بۆ ماوەی کارکردنیان ڕادەگرن؛ ئەگەر کریدیتە ڕاگرتاوەکان بە هەر شێوەیەک بەردەست نەبن، ئەوا پەڕینەوەی زانیارییەکان (stream) بە ... ڕادەوەستێت 402 insufficient_balance هەڵەی ڕووداو، و ئەوەی دروستکراوە کراوەتەوە بە دینار. ئەگەر تێچووی ڕاستەقینە زیاتر بوو لەوەی هاوسەنگی بتوانێت بیپێشێت، هەموو هاوسەنگەکە دەگیرێت، ئەوەی ماوەوە وەک قەرز دەمێنێتەوە (owed_sats لە ناو nymbot ...ئەنکۆ، و باڵانسێکی نەرێ). ئەوەی کە لە قەرز دەکات، لە یەکەم کرێدیتی داهاتووەوە کە دەگاتە ئەو باڵانسە دەدەرێت. تا ئەو کاتەی دەدرێت، هیچ شتێک لەو باڵانسەدا بەکارنایێت: نە لە ڕێگەی API، نە لە ڕێگەی وەڵامدانەوە لەناو ئەپەکەدا، نە لە ڕێگەی گواستنەوە یان دیاری.
  • کەمێکی لێکراوە نییە. ئەگەر هاوسەنگییەکە نەتوانێت ڕاگرتنی (hold) دابین بکات، داواکارییەکە ڕەتدەکرێتەوە بە... 402 پێش ئەوەی هەر شتێک کار بکات. هەڵەکە دەڵێت کام باڵانس کەمە، داواکاری چەند سات (sats) پێویستی هەیە و چەند دانەی ئازادە. کەمتر max_tokens واتە هەڵگرتنێکی بچووکتر.
  • شکستەکان. داواکارییەک کە شکستی هەیە هیچ تێچووی نییە، مەگەر دابینکەرەکە بۆ ئەو کارەی پێش شکستهەکە کردبووی پارەی لێ نەخشی، یان گەڕانێک لە وێب یان... nymbot/auto ئەگەر پشکنینی کارەکە ئەنجام درابێت؛ ئەوا ئەوەوە پارەیەک دەدەی، بە لایەنی کەم ٠.٠٥ کرێدیت. ئەو ستریمەی کە پچڕاندووتە، تێچووی ئەو تۆکەنانەی لێ دەگیرێت کە دابینکەر ڕاپۆرد دەکات: Nymbot بۆ ماوەی تا ٢٥ چرکە دوای ئەوەی تۆ چۆکیتەوە، خوێندنەوەی ستریمی دابینکەرەکە بەردەوام دەکات بۆ ئەوەی ئەو ژمارەیە بەدەستبهێت. ئەگەر نەگەیشت، تێچووەکە لە ئەوەوە خەمڵێنراوە کە تۆ ناردووتە و ئەوەی نووسراوە، و بۆ مۆدێلێک کە بیرکردنەوە (reasoning) دەکاتەوە، ئەوە هەموو ڕێژەی دەرچووی بەردەست دەگرێتەوە. داواکارییەک کە پەیوەندییەکەی پچڕێت، هێشتا تەواو دەبێت و تێچووەکەی لێ دەگیرێت.
  • گەڕان لە وێب بە هەر گەڕانێک ٠.٠٠٨ دۆلار تێدەچێت، کە دەگۆڕدرێت بۆ sats، هەر کاتێک گەڕانێک ئەنجام دەدرێت، چ مۆدێلەکە وەڵام بداتەوە یان سەرکەوتوو نەبێت. ئەو لاپەڕانەی دەخوێنێتەوە նیشتمە وەک وەک داخڵکردن (input) بۆ مۆدێلەکە دەخرێنێتە ڕوو، بۆیە توکنەکانی ئەوان زیاد دەبن.

هەموو وەڵامێک دەڵێت کە چەند تێچووی هەبووە. وەڵامەکانی 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ئەم داواکارییە بە چەند ساتێک (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باڵانسەکە ناتوانێت داواکارییەکە دابین بکات. Code 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). ببینە گەونings.
415 invalid_request_errorجەستەکە وەک نەنێردرێت وەک application/json (یان، بۆ خالەکانی بارکردنی فایل، multipart/form-data): unsupported_media_type.
422دەنگ و زمانێک کە لە دەنگگۆڕ (text to speech) یەک نەگونجێن (voice_language_mismatch, unsupported_language).
429 rate_limit_errorداواکاری زۆر لەسەر ئەم کلیلی، لەم ناونیشانە، یان بەو ناسنامانەی کە لە پشکنیندا شکستی هێناوە (rate_limit_exceeded)، یان دابینکەر سنووردارکردنی ڕێژەی بەکارهێنانی کردووە (upstream_rate_limited). چاوەڕوان بە چرکەکان لە Retry-After.
500 api_errorلە بەشی Nymbotەوە کێشەیەک ڕوویدا (internal_error).
502 api_errorدابینکەر وەڵامی نەگەڕاندەوە (upstream_error)، یان نەبووە ڕەنگە پسوولەیەکی Lightning دروست نەکرێت (invoice_unavailable).
503 api_errorدابینکەر زۆر خەریکە (overloaded)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).
  • داواکارییەکی ستریمینگ (streaming) کە پێش گەیشتنی یەکەم باýtەکە شکەسێت، هەڵەیەکی JSON ئاسایی لەگەڵ ئەو ستاتوسەی سەرەوە وەردەگرێت، نەک ڕەوانەی ڕەنگدانەوەی ڕووداو (event stream). شکەستانی دوای ئەوەی ستریمەکە دەست پێکردووە، وەک کۆتا ڕووداوی ستریمەکە دەنێردرێت، بەو فۆرماتەی تایبەت بە خودی ئەو کۆتاییە (endpoint).

نامەکانی هەڵە هەرگیز وردەکاری ناوخۆیی خزمەتگوزارییەکی تر لە خۆیاندا نا contienen. هەڵەی خودی دابینکەرەکە دوای دەگۆڕدرێت پێش ئەوەی بگاتە دەست تۆ.

گەیشتنە سنوورەکان

سەروکەوتوو (کەچی)بەها
داواکاری هەر کلیلێک١٢٠ لە خولەکێکدا. لەویش زیاتر، 429 لەگەڵ Retry-After.
داواکارییەکان بەبێ کلیل١٢٠ لە خولەکێکدا بۆ هەر ناونیشانێک، بۆ مۆدێل، دەنگ و لیستکردنی شێوازی پارەدان، پشکنینی تۆکنی گەڕاندنەوەی پارە، و کۆتاییە پارەدانکراوەکان کە بێ کلیل یان پارە بانگ دەکرێن. لەوە زیاتری، 429 لەگەڵ Retry-After.
ناچێڵێت لە ڕێگەی ناسینەوەوە٣٠ بۆ هەر خاڵێک لە خاڵی بۆ کاتێک بۆ کلیلەکان، واژۆکان، زانیارییەکانی پارەدان و تۆکەنەکانی گەڕاندنەوەی پارە کە پشتڕاست ناکرێنەوە. لەوەی زیاتر، هەر داواکارییەک لەو خاڵەی کە زانیاری دەگەیەنێت دەستی پێ دەکات 429 لەگەڵ Retry-After تا کاتێک خولەکە تەواو دەبێت. ناسنامەکان پێش خوێندنەوەی ناوەڕۆکەکە دەپشکنرێن.
کلیلە نوێیەکان٦٠ بۆ هەر nym لە کاتێکدا و ١٢٠ بۆ هەر ناونیشانێک لە کاتێکدا.
وەسڵەکانی پرکردنەوەی بارگاکردنەوە٦٠ بۆ هەر nym لە کاتێکدا و ١٢٠ بۆ هەر ناونیشانێک لە کاتێکدا.
بەستنەوەکانی پارەدانەوەی NWC١٠ لە کاتژمێرێکدا بۆ هەر nym و ٣٠ لە کاتژمێرێکدا بۆ هەر ناونیشانێک. دەبێت وێڵەی جزدانەکە (wallet relay) بەکاربهێنێت wss:// لە پۆرتە ستانداردەکەدا.
گەڕاندنەوەی تۆکنەکانڕۆژانە ٦٠ داواکاری بۆ هەر تۆکەنێک.
ناونیشانەکانناونیشانی IPv6 وەک تەواوی /64 لە هەر سنووردێکی هەر ناونیشانێک هەژمار دەکرێت، و ناونیشانی IPv6-mapped IPv4 وەک ناونیشانی IPv4ەکەی هەژمار دەکرێت.
ناوەرۆکی داواکاری JSON٤ مێگابایت؛ ٦٤ کیلۆبایت بۆ داواکارییە واژۆکراوەکان بە ناوی تۆ.
ناوەرۆکی داواکاری گەردیلەیی (بارکردنەکان)32 MB. وێنەیەکی بۆ دەستکاریکردن دەتوانێت تا 20 MB بێت، فایلێکی دەنگی تا 25 MB بێت. زۆرترین 64 بەش، هەر یەکێکیان بە زۆرترین 8 KB لە سەردێڕی بەشەکان، و سنوورێکی لە 1 بۆ 70 کاراکتەری؛ ئەگەر نا 400 invalid_multipart.
وێنەکان لە یەک داواکاریی چاتدا٢٠. هەر یەکێکیان بریتییە لە https:// یان http:// لینکی بۆ میوانداریکەرێکی گشتی، یان ئەگەر data:image/… ناونیشانی وێب.
وێنە لە هەر داواکارییەکی دروستکردندا١ تا ٤ (n)
تۆکەنەکانی دەرەنجامکۆتاییpێت لەسەر بەرزترین ئاستی خودی مۆدێلەکە. گەورەتر max_tokens کەم دەکرێتەوە بۆی، نەک ڕەت دەکرێتەوە.
بەخۆراککردنی دەنگ٨٠٠ کاراکتەر بۆ دەنگی ستاندارد، ٢,٠٠٠ بۆ Aura 2.
دەسپێکردنەوەی دەنگ بۆ نووسین٣٠ خولەک دەنگ، ٢٥ مێگابایت. تۆمارێکی درێژتر ڕەت دەکرێتەوە بە... 413 و پارەی لێ ناگیرێت، تەنانەت کاتێک درێژییەکەی تەنها دوای ئەوە دەزانرێت کە Whisper بیستیدا.
ئەمبێدینگ (Embeddings)١٠٠ داخڵکردن بۆ هەر داواکارییەک.
کارەکانی ڤیدیۆدوای پێشکەشکردنیان بۆ ماوەی ٢٤ کاتژمێر دەپارێزرێت؛ ڕێندەرێک دوای یەک کاتژمێر دەدەستبەجێ دەکرێت. لە یەک کاتدا بەFors بزوێن (nym) ل坏 ١٠ ڕێندەر.
مێژووی پرسیارەکانبۆ ماوەی ٩٠ ڕۆژ دەبێت لە هەڵگیراوە.
کلیلە چالاکەکان بە هەر nymێکەوە٢٥. تەنها نوێترین ٥٠ کلیلە هەڵوەشاوە دەپارێزرێن.

بەستەی وێنەیەک دەبێت ئاماژە بکات بۆ مێخستنێکی گشتی: ئەگەر ناونیشانێک لە تۆڕێکی تایبەت یان ناوخۆییەوە بێت، یان لە سایتەکانی خۆی لە Nymbot بێت، ڕەت دەکرێتەوە. سنووردانی خێرایی دابینکەر کە لە ئەپەکەدا جێبەجێ دەکرێت لێرەشدا جێبەجێ دەکرێت، بۆیە کۆڕێکی داواکاری بۆ یەک دابینکەر دەکرێت خاو بکرێتەوە لەبری ئەوەی شکست بخوێتەوە.

APIەکە چی دەبینێت

API وەک ئەپەکان تایبەت نییە، و شایەنی ئەوەیە بە وردی باس بکرێت چۆن.

  • بە شێوەی کۆتایی بۆ کۆتایی (end-to-end) نەپارێزراوە. لە ئەپەکاندا، نامەیەک لەسەر ئامێرەکەت بە تۆمژەڵ کراوە، تەنها ئەو کلیلانەی Nymbot هەیەتی دە열ەکەنەوە و وەک ئامرازێک دەگوازرێتەوە بایەخدان بە دیاری (پاکەتکردن)داواکارییەکی API بە ڕێگەی HTTPS ئاساییە: لە کاتی گەیشتن بە Nymbot بە شێوەیەکی کۆدکراو (encrypted)ە، و سێرڤەری Nymbot بە ڕوونی دەخوێنێتەوە بۆ ئەوەی مامەڵەی لەگەڵ بکات.
  • ڕێنماییەکان و وەڵامەکان پاشکەوت ناکرێن. ئەوان دەگوازرێنەوە بۆ مۆدێلەکە و وەڵامەکەش دەگەڕێتەوە. ئەوەی دەمێنێتەوە پسوڵەکەیە: بۆ هەر داواکارییەک کات، مۆدێل، جۆر، ژمارەی تۆکەن، تێچوو، هاوسەنگی، کلیل و ئەوەی سەرکەوتووە یان نا، بۆ ماوەی ٩٠ ڕۆژ، کە ئەوەیە مێژووی پرسیارەکان نیشانت دەدات. تۆمارێکی بەکارهێنانی هەمان داواکاری (کات، جۆر، مۆدێل، ژمارەی تۆکەن، تێچوو، ماوە و ئەوەی گەڕانی وێبی بەکارهێناوە یان سەرکەوتووە) لەگەڵ تۆمارەکانی خۆی یەکەی ئەپڵیکەیشنەکە بۆ ماوەی ٩٠ ڕۆژ دەپارێزرێت.
  • هەموو شتێکی دیکە کە بۆ nym پارێزراوە کەمە و لێرەدا لیست کراوە. کلیلەکانی API وەک هاش پاشەکەوت دەکرێن، هەرگیز نەک کلیلەکە، لەگەڵ ناوی، ئاماژەیەکی کورت، سنووری خەرجی، ماوەی نوێبوونەوە، بەسەرچوون و کاتی دروستکردن و دوایین جار بەکارهێنانیان؛ تەنها نوێترین ٥٠ کلیلە هەڵوەشاوە دەپارێزرێن. An زیادکردنی ئۆتۆماتیکی بارکردن بەستنەوەی جزدانەکە بە شێوەیەکی شێفرەساتکراو پاشەکەوت دەکرێت، لەگەڵ سنووری، بڕ، و ئەنجامی دوایین پڕکردنەوەی بار. کارەکانی ڤیدیۆ بۆ ٢٤ کاتژمێر دەپارێزرێن. داواکارییە پارەکراوەکان بە هەر بانگکردنێک تەنها هاشێکی پارەدان (Lightning payment hash) بۆ ماوەی ٧ ڕۆژ و تۆکنی گەڕاندنەوەی شێفرەساتکراو بۆ ماوەی ٣٠ ڕۆژ دەهێڵنەوە، کە بە هیچ ناوێکی ناسراوەوە (no nym) بەستراوەتەوە. ئەو خەرجییانەی هاوشانییەکەیان نا覆盖 کردوە، وەک قەرز دەپارێزرێن تا ئەو کاتەی پڕکردنەوەیەک ئەمانە ڕادەگرێت.
  • سڕینەوەی ئەپەکە دەبێتە هۆی لادانی. A سڕینەوەی ئامێرەکە هەموو کلیلەکانی API هەڵدەوەشێنێتەوە و دەسڕێتەوە، و مێژووی پرسیارەکان، تۆمارەکانی بەکارهێنان، پەیوەندی بە پارەدانەوە (wallet) و ئەرکەکانی ڤیدیۆ دەسڕێتەوە. باڵانسەکە و هەر کرێیەکی ڕەقنایا دراو نەبێت لەسەر nym دەمێنێتەوە.
  • دابینکەری مۆدێلەکە داواکارییەکەت دەبینێتوەک ئەوەی لە ئەپەکەوە دێت. مۆدێلەکانی کاتالوگ لە لای دروستکەرەکانیان کار دەکەن؛ ڕێڕەوە ستانداردەکان و ئembeddingەکان لە Cloudflare کار دەکەن.
  • میدیای دروستکراو گشتییە. وێنە و ڤیدیۆکان کە وەک لینک دێن، لە میستەرە گشتییەکانی فایلی Blossom بار دەکرێن، کە تێیدا ناونیشانی فایلەکە هاشی (hash) خۆیەتی. هەر کەسێک لینکەکە هەبێت دەتوانێت بیکاتەوە، و Nymbot ناتوانێت دووبارە لێی بسڕێتەوە. داوای... b64_json و وێنەیەکی دروستکراو لە وەڵامەکەدا دەگەڕێتەوە و هەرگیز بار ناکرێت.
  • ئایا ئەو وێنانەی تۆ دەیانبەخشیت دروستکەرن؟ وێنەیەک کە بۆی بەرز دەکەیتەوە دەستکاری بکە، یان وەک ... بنێرە data: URL لەناو درووستکەرەکەدا image_url, سەرەتا بەرە بەرە بە مۆڵتی گشتیی Blossom ئەپلۆد دەکرێت بۆ ئەوەی گێڕەرەوەکە بتوانێت بیهێنێت، و هەمان شت بۆ ئەوەش ڕەوا دەبێت. وێنەیەک کە لەلایەن https:// لینکەکە وەک هەمان لینکەکە دەگوازرێتەوە. وێنەکان لە داواکاریی چاتدا دەچن بۆ دابینکەری مۆدێلەکە، نەک بۆ Blossom.
  • کلیلێک بە nymەکەتەوە بەستراوەتەوە. هەموو ئەوەی کلیلەکە خەرج دەکات لە هاوسەنگی nymەکەتەوە دەڕوات، بۆیە بەکارهێنانی API نییە ناوازیئەگەر دەتەوێت API بەکاربهێنیت بۆ ئەوەی لە ناو 명ی ڕۆژانەتدا جیا بێتەوە، کلیلەکان لە 명ێکی جیاوەکەوە دروست بکە کە هاوسەنگی (balance) تایبەتی خۆی هەبێت.

ئەگەر پێویستت بە پاراستنی ئەپەکانە، ئەپەکان بەکاربهێنە. API بۆ ئەو کاتەیە کە پێویستت بە مۆدێلەکانە لە ناو ئامرازەکانی خۆتدا.

هەموو کۆتاییگەیەک

خاڵی کۆتاییئەوەی دەیکاتدەستپێکردن/بڕوانان
GET /api/v1/modelsلیستی مۆدێلەکان، لەگەڵ نرخەکانهیچ
POST /api/v1/chat/completionsبینینی چات (Chat Completions)کلیل
POST /api/v1/responsesAPIی وەڵامەکانکلیل
POST /api/v1/messagesنامەکانی Anthropicکلیل
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ئەمبێدینگ (Embeddings)کلیل یان بەرق
GET /api/v1/credits/balance (یان POST)هەردوو هاوسەنگییەکەکلیل
GET /api/v1/topup/payment-methodsڕێگاکانی پارەدانهیچ
POST /api/v1/topup/create/btc-lightningوەسڵێکی Lightningکلیل
GET /api/v1/topup/status/{invoice_id}پشکنین دەکات و کریدیت دەکاتکلیل
GET /api/v1/queries/historyتێچووی هەر داواکارییەک چەندەکلیل یان ناو (nym)
GET /api/v1/accountکورتەی ئەکاونتNym
/api/v1/keysکلیل در دەستگیر دەکات، دەگۆڕێت و هەڵدەداتەوەNym
/api/v1/nwc-auto-topupپڕکردنەوەی خۆکارینەNym
GET /api/v1/l402/refunds, POST /api/v1/l402/refunds/redeemپشکنین بۆ تۆکنی گەڕاندنەوەی پارە دەکات یان بەکاری دەهێنێتەوەکارتی گەڕاندنەوەی پارە؛ nym بۆ گەڕاندنەوە

“Nym” واتە داواکارییەک کە لەلایەن کلیلی Nostrەکەتەوە واژۆ کراوە، کە لەوەوە باس کراوە واژەکردنی داواکارییەکانی هەژماربۆ ئەو ئامرازانەی کە پێشتر ئەم فۆرماتانەیان تێدەگەن، سەیر بکە ئامرازەکان و SDKەکان, و بۆ ئاژەنەکانی کۆدکردن وەک Claude Code, Codex and Cline, سەیر بکە ئامرازەکانی کۆدکردن.