Βάση γνώσεων / Οι προγραμματιστές

Πυροσβεστική Επισκόπηση

Τα μοντέλα, οι γεννήτριες και οι ισορροπίες που χρησιμοποιείτε στην εφαρμογή, από τον δικό σας κώδικα.Το API μιλάει για τις μορφές OpenAI και Anthropic, έτσι τα περισσότερα εργαλεία και τα SDKs λειτουργούν αλλάζοντας μια διεύθυνση URL βάσης και ένα κλειδί.

Αυτή η σελίδα έχει μεταφραστεί μηχανικά για ευκολία. Το αγγλικό πρωτότυπο είναι η έκδοση που ισχύει.

Τι είναι η φωτιά

Το HTTP API είναι nymbot.ai που απαντά στα ίδια αιτήματα που στέλνει ήδη ένας πελάτης OpenAI ή Anthropic.

• Συμπληρώματα chatΗ ΑΠΑΝΤΗΣΗ ΦΩΤΙΑ και ΑΝΘΡΩΠΙΚΟ ΜΗΝΥΜΑ, με ροή, εργαλεία, εικόνες, συλλογισμό και αναζήτηση στο διαδίκτυο, για κάθε μοντέλο στο ΚΑΤΑΛΟΓΟΣ και για τη δική του αυτόματη δρομολόγηση του Nymbot.
• ΕΙΚΟΝΕΣ, Βίντεο, ομιλία, Μεταγραφές και Εμπιστοσύνη.
• Σας ισορροπία, Φωτεινές κορυφές, Αυτοματισμός από το πορτοφόλι σας και α Ιστορία Πόσο κοστίζει κάθε αίτηση

Πληρώνεται από τα ίδια δύο ισορροπία Δεν υπάρχει συνδρομή και δεν υπάρχει δωρεάν επιχορήγηση στο API: κάθε αίτηση πληρώνεται από τις πιστώσεις που αγοράσατε.

Αυτό που δεν κάνει το API είναι να προσθέσει τίποτα από το δικό του Nymbot. τα μηνύματά σας πηγαίνουν στο μοντέλο καθώς τα στέλνετε: καμία προειδοποίηση του συστήματος Nymbot, καμία μνήμη, καμία ημερομηνία ή υποδείξεις γλώσσας.

Βάση URL

Κάθε τέλος ζει κάτω από /api/v1/Ένας άγνωστος δρόμος επιστρέφει 404 και μια γνωστή οδός που ονομάζεται με τη λάθος μέθοδο επιστρέφει 405Και οι δύο ως JSON.

Το API απαντά σε αιτήματα διασταύρωσης προέλευσης από οποιοδήποτε site, έτσι ώστε μια σελίδα του προγράμματος περιήγησης να μπορεί να το καλέσει.Οτιδήποτε στέλνετε σε ένα πρόγραμμα περιήγησης μπορεί να διαβαστεί από όποιον το ανοίγει, ωστόσο, γι 'αυτό κάντε μόνο με ένα κλειδί που έχει ένα μικρό ΚΕΠΤα τερματικά σημεία που έχουν υπογραφεί με το nym σας (κλειδιά, περίληψη λογαριασμού, NWC auto-top-up και επιστροφή χρημάτων) αποτελούν την εξαίρεση: σε ένα πρόγραμμα περιήγησης απαντούν μόνο στους ιστότοπους του Nymbot. Υπογραφή αιτήσεων λογαριασμού.

Στείλτε κάθε σώμα JSON με Content-Type: application/jsonΟποιοσδήποτε άλλος τύπος απορρίπτεται 415, έτσι μια απλή μορφή HTML ή ένα text/plain αίτημα από άλλη τοποθεσία δεν μπορεί να φτάσει στο API. με cURL, περάστε -H "Content-Type: application/json" Μαζί με -d.

Κλειδιά φωτιάς

Τα κλειδιά δημιουργούνται στην εφαρμογή. ανοιχτό Φωτιά στη γραμμή πλευράς της εφαρμογής web, ή στο μενού σε Android και iOS, και πατήστε Δημιουργία κλειδιούΔώστε του ένα όνομα και, αν θέλετε, ένα καπάκι και ημερομηνία λήξης.

Το κλειδί εμφανίζεται μία φορά Αντιγράψτε το κάπου ασφαλή πριν κλείσετε το φύλλο: Το Nymbot διατηρεί μόνο ένα δακτυλικό αποτύπωμα από αυτό, οπότε δεν μπορεί να σας το δείξει ξανά.

Ένα κλειδί μοιάζει sk-nymbot- ακολουθούμενη από 43 γράμματα, ψηφία, πίνακες και υποσημειώσεις.Η εφαρμογή παραθέτει κάθε κλειδί με το όνομά της και μια σύντομη ένδειξη όπως: sk-nymbot-Qm7x…c2Lw.

• Ένα κλειδί ανήκει στο nym σας. Ξοδεύει το υπόλοιπο σας και μόνο ο νύμφης σας μπορεί να το κάνει, να το αλλάξει ή να το ανακαλέσει.Όποιος κρατάει το κλειδί μπορεί να το ξοδέψει, οπότε το αντιμετωπίζετε σαν έναν κωδικό πρόσβασης.
• Τα κεφάλαια είναι στο στοίχημα. Ένα κλειδί μπορεί να έχει ένα ανώτατο όριο δαπανών και το ανώτατο όριο μπορεί να επαναφέρεται κάθε μέρα, κάθε εβδομάδα (Δευτέρα) ή κάθε μήνα (πρώτη), στις 00:00 UTC. Μετράει και τα δύο υπόλοιπα, μια τυπική πίστωση ως 10 sats και μια Pro πίστωση ως 100, οπότε σημαίνει το ίδιο όποιο υπόλοιπο δαπανά ένα αίτημα. 403 key_limit_reached, ακόμη και αν η απάντηση είχε έρθει κάτω από το καπάκι. το σφάλμα λέει πόσο έχει απομείνει και πότε το καπάκι επαναφέρεται. max_tokens Ένα αίτημα χρεώνεται ό, τι πραγματικά κοστίζει και αυτό μετράει ενάντια στο καπάκι, οπότε αν ο πάροχος αναφέρει περισσότερα tokens από ό, τι είχαν τεθεί στην άκρη, το τελευταίο αίτημα που ταιριάζει μπορεί να πάρει το κλειδί λίγο πέρα από το καπάκι του. το επόμενο τότε απορρίπτεται.
• Ένα δαπανηρό καπάκι σταματά μόνο τις δαπάνες. Ένα κλειδί στο καπάκι του μπορεί ακόμα να ελέγξει το υπόλοιπο, να διαβάσει το ιστορικό του, να απαριθμήσει τα μοντέλα, να μετρήσει τα tokens, να ανεβάσει και να ελέγξει ένα βίντεο που έχει ήδη ξεκινήσει.
• Η λήξη είναι προαιρετική. Μετά την ημερομηνία που ορίσατε, το κλειδί σταματά να λειτουργεί.
• Η ανάκληση είναι άμεση και οριστική. Ένα ανακληθέν κλειδί αποτυγχάνει το επόμενο αίτημά του. παραμένει στη λίστα, σημειωμένο ανακληθέν, οπότε το ιστορικό δαπανών του εξακολουθεί να έχει νόημα.
• Μπορείτε να έχετε έως και 25 ενεργά κλειδιά, καθένα με το δικό του όνομα.Η αλλαγή της περιόδου επαναφοράς ενός κλειδιού ξεκινά μια νέα περίοδο από το μηδέν.

Το ίδιο φύλλο δείχνει την δαπάνη κάθε κλειδιού για αυτή την περίοδο και συνολικά, όταν χρησιμοποιήθηκε τελευταία φορά, τόσο τα υπόλοιπα όσο και τα πρόσφατα αιτήματα API. Διαχείριση κλειδιών.

Πιστοποίηση αίτησης

Στείλτε το κλειδί σε οποιαδήποτε από αυτές τις επικεφαλίδες. είναι ισοδύναμες, οπότε χρησιμοποιήστε ό, τι στέλνει ο πελάτης σας από προεπιλογή:

Έλλειψη, άγνωστη, ανακληθείσα ή λήξει επιστροφές κλειδιών 401Με τον κώδικα missing_api_key, invalid_api_key, revoked_api_key ή expired_api_keyΗ καταχώριση των μοντέλων, των μοντέλων ήχου και των φωνών και των μεθόδων πληρωμής δεν χρειάζεται κλειδί.

Φωτογραφίες, βίντεο, ομιλία, μεταγραφές και ενσωματώσεις μπορούν επίσης να πληρωθούν για ένα αίτημα τη φορά πάνω από το Lightning χωρίς κλειδί καθόλου: στείλτε το αίτημα χωρίς ένα και να πληρώσετε το τιμολόγιο στο 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 είναι η δική του δρομολόγηση του Nymbot, πληρωμένη από το τυπικό υπόλοιπο. anthropic/claude-sonnet-5, για να χρησιμοποιήσετε αυτό το μοντέλο από την Pro ισορροπία. Κατάλογος μοντέλων Δώστε κάθε ταυτότητα.

Πόσο κοστίζει μια αίτηση

Το API χρεώνει ακριβώς όπως κάνει η εφαρμογή.

• Τι ισορροπία nymbot/auto Ξοδέψτε το πρότυπο ισορροπία (10 sats a credit). Κάθε άλλο μοντέλο συνομιλίας ξοδεύει το Για Η τυπική γεννήτρια εικόνας και η τυπική φωνή ξοδεύουν τυπικές πιστώσεις. κάθε άλλη γεννήτρια ξοδεύει Pro. Οι ενσωματωμένες δαπάνες ξοδεύουν τυπικές πιστώσεις. Η μεταγραφή ξοδεύει τυπικές πιστώσεις όταν το τυπικό υπόλοιπο μπορεί να το καλύψει, και οι πιστώσεις Pro διαφορετικά. Ο κατάλογος μοντέλων λέει ποιο υπόλοιπο ξοδεύει κάθε μοντέλο.
• Πόσο πολύ Ένα αίτημα συνομιλίας μετράται στα tokens που το μοντέλο πραγματικά διαβάζει και γράφει, στις δημοσιευμένες τιμές του παρόχου. Αυτή η τιμή έχει 5% πρόσθετη αμοιβή και στη συνέχεια πολλαπλασιάζεται με 1,5, έτσι πληρώνετε 1.575 φορές την τιμή λίστας του παρόχου. Μετατρέπεται σε sats στην ζωντανή τιμή Bitcoin και χρεώνεται σε χιλιάδες του ενός πιστωτικού ποσού. Pro εικόνες, βίντεο και ομιλία τιμολογούνται ανά γενιά, ανά δευτερόλεπτο ή ανά χαρακτήρα, και μεταγραφή ανά δευτερόλεπτο ήχου, με την ίδια αμοιβή και περιθώριο. Η τυποποιημένη εικόνα είναι μια επίπεδη 5 τυποποιημένες πιστώσεις και η τυποποιημένη φωνή είναι μια επίπεδη 3.
• Το ελάχιστο . Κάθε μετρημένο αίτημα που εκτελεί κοστίζει τουλάχιστον 0,05 πιστωτική μονάδα: μισή θέση στο τυπικό υπόλοιπο, 5 δόσεις στο Pro.
• Κρατήστε το, στη συνέχεια καθορίστε. Πριν ένα αίτημα εκτελεστεί, το μεγαλύτερο κόστος που μπορεί να κοστίσει διατηρείται από το υπόλοιπο σας, με βάση αυτό που έχετε στείλει και τα περισσότερα tokens που μπορεί να γράψει. Το κείμενο έξω από το απλό ASCII μεγεθύνεται από τα bytes του UTF-8, και οι αριθμοί ASCII και η βαθμολογία μετρούν ως ένα token το καθένα, έτσι το κείμενο σε οποιοδήποτε σενάριο, κώδικα και αριθμούς διατηρούνται πλήρως. Η διατήρηση είναι σε ολόκληρες πιστώσεις, τουλάχιστον ένα, έτσι ώστε οποιοδήποτε αίτημα χρειάζεται τουλάχιστον 10 δόσεις δωρεάν στο πρότυπο ισοζύγιο ή 100 δόσεις στο Pro για να ξεκινήσει. Μόνο το πραγματικό κόστος χρεώνεται. το υπόλοιπο απελευθερώνεται όταν τελειώσει. Ένα 402 insufficient_balance Εάν το πραγματικό κόστος είναι μεγαλύτερο από το ισοζύγιο που μπορεί να πληρώσει, το σύνολο του ισοζυγίου λαμβάνεται, το υπόλοιπο χρεώνεται (owed_sats Στην nymbot Αυτό που οφείλεται καταβάλλεται πρώτα από τις επόμενες πιστώσεις που φτάνουν σε αυτό το υπόλοιπο. Μέχρι να καταβληθεί, τίποτα σε αυτό το υπόλοιπο δεν μπορεί να δαπανηθεί: όχι από το API, απαντά στην εφαρμογή, μια μεταφορά ή ένα δώρο.
• Δεν υπάρχει αρκετή πίστωση. Εάν το υπόλοιπο δεν μπορεί να καλύψει την κατοχή, το αίτημα απορρίπτεται με 402 Το σφάλμα λέει ποιο υπόλοιπο είναι σύντομο, πόσες δόσεις χρειάζεται το αίτημα και πόσες είναι δωρεάν. max_tokens σημαίνει μικρότερη συγκράτηση.
• Οι αποτυχίες. Ένα αίτημα που αποτυγχάνει δεν κοστίζει τίποτα, εκτός αν ο πάροχος τιμολόγησε για την εργασία που έκανε πριν αποτύχει, ή μια αναζήτηση στο διαδίκτυο ή το nymbot/auto Ο έλεγχος εργασιών είχε ήδη εκτελεστεί. τότε αυτό είναι αυτό που πληρώνετε, τουλάχιστον 0.05 πίστωση. Ένα ρεύμα που κόβετε χρεώνεται για τα tokens που αναφέρει ο πάροχος: Το Nymbot συνεχίζει να διαβάζει το ρεύμα του παρόχου για έως και 25 δευτερόλεπτα μετά την αναχώρησή σας για να πάρει αυτόν τον αριθμό. Εάν δεν φτάσει, το τέλος υπολογίζεται από αυτό που έχετε στείλει και τι γράφτηκε και για ένα μοντέλο για τους λόγους αυτούς περιλαμβάνει το σύνολο της άδειας εξόδου του hold.
• WEB Αναζήτηση κοστίζει $0.008 μια αναζήτηση, μετατρέπεται σε sats, κάθε φορά που μια αναζήτηση εκτελείται, είτε το μοντέλο τότε απαντά ή αποτυγχάνει.

Κάθε απάντηση λέει πόσο κοστίζει. οι απαντήσεις JSON φέρουν ένα nymbot αντικείμενο με το υπόλοιπο από το οποίο καταβλήθηκε, το τέλος σε πιστώσεις και δόσεις, και τι απομένει:

Το αντικείμενο του κόστους

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

Οι πληρωμένες απαντήσεις φέρουν επίσης αυτές τις επικεφαλίδες, που είναι όπου μπορείτε να αναζητήσετε το κόστος μιας απάντησης που δεν είναι JSON, όπως ομιλία:

Οι τιμές ανά εκατομμύριο tokens, ήδη συμπεριλαμβανομένης της αμοιβής και του περιθωρίου, είναι στο Κατάλογος μοντέλων σε δολάρια και σε δολάρια και σε Το τιμολόγιοΕάν η τιμή του Bitcoin δεν μπορεί να διαβαστεί, τα πληρωμένα αιτήματα επιστρέφουν 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
  }
}

Δύο εξαιρέσεις :

• /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).
• Ένα αίτημα ροής που αποτυγχάνει πριν από το πρώτο byte του παίρνει ένα συνηθισμένο σφάλμα JSON με την κατάσταση παραπάνω, όχι ένα ρεύμα γεγονότων.

Τα μηνύματα σφάλματος δεν περιέχουν ποτέ εσωτερικές λεπτομέρειες μιας άλλης υπηρεσίας.

Τα όρια

Ένας σύνδεσμος σε μια εικόνα πρέπει να δείχνει σε έναν δημόσιο οικοδεσπότη: μια διεύθυνση σε ένα ιδιωτικό ή τοπικό δίκτυο, ή στους δικούς του ιστότοπους του Nymbot, απορρίπτεται.

Τι μπορεί να δει η φωτιά

Το API δεν είναι ιδιωτικό με τον τρόπο που είναι οι εφαρμογές και αξίζει να είμαστε ακριβείς για το πώς.

• Δεν είναι κρυπτογραφημένο από άκρο σε άκρο. Στις εφαρμογές, ένα μήνυμα σφραγίζεται στη συσκευή σας σε κλειδιά που μόνο το Nymbot κρατάει και ταξιδεύει ως Δωρεάν WrapΈνα αίτημα API είναι συνηθισμένο HTTPS: κρυπτογραφείται στο δρόμο προς το Nymbot, και ο διακομιστής του Nymbot το διαβάζει στο σαφές για να το χειριστεί.
• Τα μηνύματα και οι απαντήσεις δεν αποθηκεύονται. Αυτό που διατηρείται είναι ο λογαριασμός: για κάθε αίτηση ο χρόνος, το μοντέλο, το είδος, το token counts, το κόστος, το ισοζύγιο, το κλειδί και αν πέτυχε, για 90 ημέρες, που είναι τι Ζητήστε Ιστορία Ένα αρχείο χρήσης του ίδιου αιτήματος (χρόνος, είδος, μοντέλο, αριθμός token, κόστος, διάρκεια και αν χρησιμοποίησε την αναζήτηση στο διαδίκτυο ή πέτυχε) διατηρείται επίσης για 90 ημέρες, μαζί με την ίδια την εφαρμογή.
• Όλα τα άλλα που κρατούνται για ένα νύχι είναι μικρά και απαριθμούνται εδώ. Κλειδιά φωτιάς αποθηκεύονται ως hash, ποτέ το κλειδί, με το όνομά τους, μια σύντομη εντύπωση, καπάκι δαπανών, περίοδο επαναφοράς, λήξη και πότε έγιναν και χρησιμοποιήθηκαν τελευταία· διατηρούνται μόνο τα τελευταία 50 ανακληθέντα κλειδιά. Αυτόματο Top-Up Η σύνδεση του πορτοφολιού αποθηκεύεται κρυπτογραφημένη, με το κατώφλι, το ποσό και το αποτέλεσμα της τελευταίας αντιστάθμισης. Οι εργασίες βίντεο διατηρούνται για 24 ώρες. Οι αιτήσεις που καταβάλλονται ανά κλήση αφήνουν μόνο ένα hash πληρωμής Lightning για 7 ημέρες και ένα hashed token επιστροφής για 30 ημέρες, συνδεδεμένο με κανένα nym.
• Το σβήσιμο της εφαρμογής την διαγράφει. A Συσκευή Wipe ανακαλεί και διαγράφει κάθε κλειδί API και διαγράφει το ιστορικό ερωτήσεων, τα αρχεία χρήσης, τη σύνδεση πορτοφολιού και τις εργασίες βίντεο.
• Ο προμηθευτής του μοντέλου βλέπει το αίτημά σαςΤα μοντέλα καταλόγου εκτελούνται στους κατασκευαστές τους· οι τυπικές διαδρομές και οι ενσωματώσεις εκτελούνται στο Cloudflare.
• Τα δημιουργημένα μέσα ενημέρωσης είναι δημόσια. Οι εικόνες και τα βίντεο που παραδίδονται ως σύνδεσμοι μεταφορτώνονται σε δημόσιους οικοδεσπότες αρχείων Blossom, όπου η διεύθυνση ενός αρχείου είναι το hash του.Όποιος έχει τον σύνδεσμο μπορεί να το ανοίξει και το Nymbot δεν μπορεί να το κατεβάσει ξανά. b64_json και μια δημιουργημένη εικόνα επιστρέφει στην απάντηση και δεν ανεβαίνει ποτέ.
• Έτσι είναι οι εικόνες που δίνετε σε μια γεννήτρια. Μια φωτογραφία που ανεβάζετε σε ΕΔΔ, ή να στείλετε ως a data: URL σε μια γεννήτρια image_url, ανεβαίνει σε έναν δημόσιο Blossom οικοδεσπότη πρώτα έτσι ώστε η γεννήτρια να μπορεί να το πάρει, και το ίδιο ισχύει και γι 'αυτό. https:// Οι εικόνες σε ένα αίτημα συνομιλίας πηγαίνουν στον πάροχο του μοντέλου, όχι στο Blossom.
• Ένα κλειδί συνδέεται με το nym σας. Όλα όσα ξοδεύει ένα κλειδί προέρχονται από το υπόλοιπο του nym σας, οπότε η χρήση του API δεν είναι ΑνώνυμοςΕάν θέλετε να διατηρήσετε τη χρήση API ξεχωριστή από την καθημερινή σας νύχτα, κάντε τα κλειδιά από μια ξεχωριστή νύχτα με τη δική της ισορροπία.

Εάν χρειάζεστε την προστασία των εφαρμογών, χρησιμοποιήστε τις εφαρμογές.Το API είναι για όταν χρειάζεστε τα μοντέλα στα δικά σας εργαλεία.

Κάθε τέλος

“Nym” σημαίνει ένα αίτημα που υπογράφεται από το κλειδί Nostr σας, που περιγράφεται στο Υπογραφή αιτήσεων λογαριασμούΓια εργαλεία που μιλούν ήδη αυτές τις μορφές, δείτε Εργαλεία και SDKs, και για τους πράκτορες κωδικοποίησης όπως ο Claude Code, Codex και Cline, δείτε Εργαλεία κωδικοποίησης.