Το Rivya API είναι η διαδρομή για developers που θέλουν να χρησιμοποιήσουν δυνατότητες μοντέλων Rivya από το δικό τους προϊόν, script ή workflow.
Δεν είναι ξεχωριστό προϊόν από το Rivya Studio. Χρησιμοποιεί το ίδιο όριο λογαριασμού, το ίδιο πορτοφόλι credits και το ίδιο δημόσιο επίπεδο μοντέλων που βλέπουν οι χρήστες στο Rivya. Η διαφορά είναι πώς ξεκινά η δουλειά: αντί να κάνετε κλικ μέσα στο Studio, η εφαρμογή σας στέλνει αιτήματα με API key.
Αν χρειάζεστε λεπτομέρειες endpoint, ξεκινήστε από το Επισκόπηση Rivya API και το Γρήγορη εκκίνηση του Rivya API. Αυτό το άρθρο είναι η εξήγηση σε επίπεδο προϊόντος: σε τι χρησιμεύει το API, πού ταιριάζει και πότε δεν πρέπει να είναι η πρώτη διαδρομή.
Η σύντομη εκδοχή
Το Rivya API v1 επιτρέπει σε έναν συνδεδεμένο λογαριασμό να δημιουργεί API keys και να καλεί δυνατότητες μοντέλων Rivya έξω από το web interface.
Η τρέχουσα επιφάνεια API περιλαμβάνει:
- ανακάλυψη μοντέλων μέσω της λίστας μοντέλων API
- ασύγχρονες εργασίες δημιουργίας εικόνας, βίντεο και ήχου
- uploads μέσω Files API για μοντέλα που χρειάζονται reference media
- polling κατάστασης δημιουργίας με δημόσια task IDs
- ελέγχους credits λογαριασμού
- γύρους Chat API, συμπεριλαμβανομένου προαιρετικού SSE streaming
- υπογεγραμμένα webhooks για ολοκλήρωση δημιουργίας
- TypeScript SDK beta για ομάδες που θέλουν client wrapper
Το δημόσιο developer hub είναι το Developers. Είναι η καλύτερη είσοδος αν θέλετε καθοδηγούμενη επισκόπηση, συνδέσμους για ρυθμίσεις API key και ασφαλή ροή debugger.
Γιατί το Rivya έχει API
Το Studio είναι χρήσιμο όταν ένας άνθρωπος ακόμη επιλέγει μοντέλα, διαμορφώνει prompts, ελέγχει εξόδους και αποφασίζει τι να κάνει μετά.
Το API είναι χρήσιμο όταν αυτή η απόφαση έχει γίνει επαναλήψιμο προϊόν ή επιχειρησιακή ροή εργασίας.
Συνηθισμένα παραδείγματα:
- ένα προϊόν θέλει να δημιουργεί παραλλαγές εικόνας αφού ο χρήστης υποβάλει brief
- μια marketing ροή εργασίας χρειάζεται να δημιουργεί οπτικά drafts από δομημένες εισόδους καμπάνιας
- ένα εσωτερικό εργαλείο χρειάζεται να υποβάλλει εργασίες βίντεο ή ήχου χωρίς να ζητά από κάποιον να ανοίξει browser
- ένα σύστημα υποστήριξης ή περιεχομένου θέλει έναν γύρο μοντέλου chat μέσα στη δική του διεπαφή
- μια backend υπηρεσία θέλει signed callbacks όταν ολοκληρώνονται οι εργασίες δημιουργίας
Σε αυτές τις περιπτώσεις, το Rivya API κρατά τη δουλειά συνδεδεμένη με τον ίδιο λογαριασμό Rivya αντί να απαιτεί ξεχωριστό stack για χρέωση, επιλογή μοντέλου και κατάσταση εργασίας.
Τι δεν αντικαθιστά το API
Το API δεν αντικαθιστά κάθε λόγο να χρησιμοποιείτε το Rivya απευθείας.
Χρησιμοποιήστε Οδηγός Rivya Studio ή τις δημόσιες επιφάνειες εργασίας όταν:
- το prompt χρειάζεται ακόμη ανθρώπινη εξερεύνηση
- η επιλογή μοντέλου δεν είναι σταθερή
- ένας creator χρειάζεται να συγκρίνει οπτικά τις εξόδους
- το έργο εξαρτάται από αποθηκευμένο ιστορικό και χειροκίνητο έλεγχο
- η ομάδα δεν έχει αποφασίσει ποια μορφή εισόδου και εξόδου πρέπει να γίνει επαναλήψιμη
Χρησιμοποιήστε το API όταν η ροή εργασίας είναι αρκετά καθαρή ώστε να αυτοματοποιηθεί.
Αυτό το όριο έχει σημασία. Μια ασαφής δημιουργική ερώτηση συνήθως ανήκει πρώτα στο Studio. Μια γνωστή ροή προϊόντος με προβλέψιμες εισόδους μπορεί να μετακινηθεί στο API.
Τα κύρια δομικά στοιχεία
Σκεφτείτε το API ως έξι συνδεδεμένα κομμάτια.
| Δομικό στοιχείο | Τι χειρίζεται | Πού να διαβάσετε μετά |
|---|---|---|
| API keys | Server-to-server πρόσβαση από τον λογαριασμό σας | Πιστοποίηση API |
| Models | Δημόσια model IDs και πληροφορίες ετοιμότητας | Μοντέλα API |
| Generations | Async εργασίες εικόνας, βίντεο και ήχου | Δημιουργία generation |
| Files | Uploads εικόνας, βίντεο ή ήχου αναφοράς | Files API |
| Chat | Non-streaming ή streaming γύροι chat | Chat API |
| Webhooks | Υπογεγραμμένα completion events για εργασίες δημιουργίας | API Webhooks |
Τα API docs είναι η πηγή για το σχήμα request και response. Αυτό το άρθρο πρέπει να σας βοηθήσει να αποφασίσετε ποιο κομμάτι χρειάζεστε πρώτο.
Πώς λειτουργούν τα credits
Η χρήση API αντλεί από το ίδιο πορτοφόλι credits λογαριασμού Rivya με το Studio.
Αυτό σημαίνει ότι το API δεν είναι ανώνυμο model proxy. Ένα αίτημα ανήκει σε λογαριασμό Rivya, χρησιμοποιεί API key που δημιουργήθηκε από αυτόν τον λογαριασμό και ακολουθεί το ίδιο όριο credits σε επίπεδο προϊόντος που περιγράφεται στα API Credits.
Αυτό είναι χρήσιμο για ομάδες επειδή τα πειράματα στο Studio και η χρήση API μένουν σε ένα λειτουργικό μοντέλο. Μπορείτε να δοκιμάσετε ένα μοντέλο χειροκίνητα και μετά να μετακινήσετε το επαναλήψιμο μέρος σε μια ενσωμάτωση χωρίς να δημιουργήσετε δεύτερο επίπεδο χρέωσης.
Πώς ταιριάζουν τα αρχεία
Μερικά μοντέλα μπορούν να τρέξουν μόνο από κείμενο. Άλλα χρειάζονται εικόνα, βίντεο ή αρχείο ήχου αναφοράς.
Για API integrations, αυτές οι αναφορές πρέπει να περνούν από το Files API. Το upload δημιουργεί μια διαχειριζόμενη εγγραφή αρχείου που μπορεί να περάσει σε υποστηριζόμενες παραμέτρους μοντέλου.
Ο πρακτικός κανόνας είναι απλός:
- αν ένα μοντέλο δέχεται text-only είσοδο, ξεκινήστε από το generation endpoint
- αν ένα μοντέλο χρειάζεται reference media, ανεβάστε πρώτα το αρχείο
- αν το μοντέλο είναι chat model με image attachments, χρησιμοποιήστε Chat API και file IDs
Μην σχεδιάζετε την ενσωμάτωσή σας γύρω από browser-only upload flows ή αποθηκευμένα Studio sessions. Το API έχει το δικό του δημόσιο όριο αρχείων για κάποιον λόγο.
Πού βοηθούν τα Webhooks
Το polling είναι η πιο εύκολη πρώτη διαδρομή ενσωμάτωσης. Υποβάλετε μια εργασία δημιουργίας, αποθηκεύστε το δημόσιο task ID και κάντε poll μέχρι να πετύχει ή να αποτύχει.
Τα Webhooks γίνονται χρήσιμα όταν η ενσωμάτωση μοιάζει περισσότερο με παραγωγική ροή:
- δεν θέλετε worker να κάνει polling σε κάθε εργασία
- η εφαρμογή σας πρέπει να ενημερώσει μια εγγραφή όταν ολοκληρωθεί η δημιουργία
- θέλετε υπογεγραμμένο event που μπορεί να επαναδοκιμαστεί με ασφάλεια
- οι αποτυχημένες εργασίες χρειάζεται να μπουν σε καθαρή διαδρομή ανάκτησης
Για το signed event contract, χρησιμοποιήστε API Webhooks. Κρατήστε τον webhook receiver στενό: επαληθεύστε υπογραφές, χειριστείτε duplicate events και αποφύγετε να βάλετε secret values στα logs.
Ένα καλό πρώτο API project
Το καλύτερο πρώτο API project είναι συνήθως μικρό και συγκεκριμένο.
Για παράδειγμα:
- δημιουργήστε API key στις ρυθμίσεις
- καλέστε τη λίστα μοντέλων
- επιλέξτε ένα διαθέσιμο μοντέλο
- υποβάλετε μία εργασία δημιουργίας με idempotency key
- κάντε poll το status endpoint
- ελέγξτε credits πριν και μετά
- μόνο τότε προσθέστε Files API, Chat API ή Webhooks
Αυτή η διαδρομή σάς δίνει μια λειτουργική ενσωμάτωση χωρίς να ανακατέψετε κάθε API feature στην πρώτη δοκιμή.
Πότε το API είναι λάθος σημείο εκκίνησης
Το API πιθανότατα δεν είναι το σωστό πρώτο βήμα όταν:
- η ομάδα δεν έχει επιλέξει ακόμη οικογένεια μοντέλων
- η επιθυμητή έξοδος αλλάζει σε κάθε εκτέλεση
- το prompt εξαρτάται από ανθρώπινο γούστο και έλεγχο
- η ενσωμάτωση θα έκρυβε τη χρήση credits από τους ανθρώπους που πρέπει να την καταλάβουν
- το προϊόν χρειάζεται δημόσιο demo πριν χρειαστεί αυτοματοποίηση
Σε αυτές τις περιπτώσεις, ξεκινήστε από Image, Video, Audio, Chat ή Μοντέλα AI. Μόλις η διαδρομή γίνει επαναλήψιμη, μετακινήστε το σταθερό μέρος στο API.
Πού να πάτε μετά
- Ανοίξτε το Developers για το δημόσιο API hub και debugger.
- Διαβάστε Γρήγορη εκκίνηση του Rivya API για να κάνετε το πρώτο ασφαλές αίτημα.
- Διαβάστε Πιστοποίηση API πριν βάλετε key σε server.
- Διαβάστε Μοντέλα API πριν επιλέξετε model IDs.
- Διαβάστε Πότε να χρησιμοποιήσετε το Rivya API αντί για Studio αν το όριο προϊόντος είναι ακόμη ασαφές.
- Διαβάστε Πώς να χτίσετε μια πολυτροπική AI ροή εργασίας με το Rivya API όταν σχεδιάζετε πλήρη ενσωμάτωση εικόνας, βίντεο, ήχου ή chat.
