Επισκόπηση Rivya API

Το Rivya API v1 είναι η προγραμματιστική σύμβαση για την κλήση υποστηριζόμενων δυνατοτήτων των μοντέλων Rivya από το δικό σας προϊόν, εφόσον η πρόσβαση στο δημόσιο API είναι ενεργοποιημένη για την εγκατάσταση και διατίθεται στον λογαριασμό σας.

Η υλοποιημένη σύμβαση καλύπτει ασύγχρονη δημιουργία εικόνας, βίντεο και ήχου, καθώς και γύρους του API συνομιλίας με πλήρη ή σταδιακή απόκριση μέσω SSE. Χρησιμοποιεί αναγνωριστικά μοντέλων Rivya, πιστωτικές μονάδες του λογαριασμού, δημόσια αναγνωριστικά εργασιών δημιουργίας και συνεδρίες συνομιλίας στον διακομιστή. Μια τεκμηριωμένη διαδρομή δεν αποτελεί υπόσχεση ότι κάθε περιβάλλον, λογαριασμός ή μοντέλο μπορεί να την καλέσει· επιβεβαιώστε την ενεργή πρόσβαση και την ετοιμότητα του μοντέλου πριν από την ενσωμάτωση.

Σε τι χρησιμεύει το API

Χρησιμοποιήστε το API όταν θέλετε να:

• υποβάλετε εργασίες δημιουργίας εικόνας, βίντεο ή ήχου από τη δική σας εφαρμογή

• στείλετε γύρους συνομιλίας με πλήρη ή τμηματικά μεταδιδόμενη απόκριση και να συνεχίσετε συνεδρίες που δημιουργήθηκαν μέσω API

• διατηρήσετε τη χρέωση στο ίδιο υπόλοιπο πιστωτικών μονάδων του λογαριασμού Rivya

• ελέγχετε περιοδικά την κατάσταση μιας εργασίας με το δημόσιο αναγνωριστικό της

• χρησιμοποιήσετε ασφαλείς επαναλήψεις χωρίς διπλή εκτέλεση για αιτήματα παραγωγής

• κρατήσετε τη χρήση Studio και API μέσα στο ίδιο όριο λογαριασμού

Το API αποτελεί το επίπεδο προϊόντος του Rivya. Οι δημόσιες αποκρίσεις χρησιμοποιούν μόνο ονόματα Rivya και δημόσια πεδία.

Τρέχον εύρος έκδοσης

Τα υλοποιημένα τελικά σημεία του v1 περιλαμβάνουν:

• GET /api/v1/models

• POST /api/v1/generations

• POST /api/v1/files

• GET /api/v1/files/{fileId}

• POST /api/v1/chat/completions

• GET /api/v1/chat/sessions

• GET /api/v1/chat/sessions/{sessionId}

• GET /api/v1/generations/{taskId}

• GET /api/v1/credits

• GET /api/v1/webhooks

• POST /api/v1/webhooks

• GET /api/v1/webhook-events

• GET /api/v1/openapi.json

Η τρέχουσα σύμβαση περιλαμβάνει υπογεγραμμένα webhooks για τα αποτελέσματα ασύγχρονης δημιουργίας, το API συνομιλίας και ένα SDK TypeScript σε δοκιμαστική έκδοση, με υποστήριξη σταδιακής μετάδοσης από τον διακομιστή. Οι κλήσεις webhook απαιτούν τόσο η δυνατότητα webhooks όσο και η πρόσβαση στο δημόσιο API να είναι ενεργοποιημένες για την εγκατάσταση.

Έλεγχος ταυτότητας

Τα τελικά σημεία δημιουργίας, κατάστασης και πιστωτικών μονάδων απαιτούν:

Authorization: Bearer rvya_sk_...

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

Μοντέλο χρέωσης

Οι κλήσεις API χρησιμοποιούν τις ίδιες πιστωτικές μονάδες λογαριασμού Rivya με το Studio.

Οι εργασίες δημιουργίας δεσμεύουν ή καταναλώνουν πιστωτικές μονάδες όταν ξεκινούν. Οι γύροι συνομιλίας δεσμεύουν πιστωτικές μονάδες πριν από την κλήση του μοντέλου και διακανονίζουν το τελικό ποσό βάσει της χρήσης διακριτικών όταν αποθηκεύεται το μήνυμα του βοηθού. Αν μια δημιουργία ή ένας γύρος συνομιλίας αποτύχει σύμφωνα με τους υπάρχοντες κανόνες αποτυχίας του Rivya, ισχύει ο ίδιος χειρισμός επιστροφής πιστωτικών μονάδων.

Διαβάστε τις πιστωτικές μονάδες του API και τις χρεώσεις και πιστωτικές μονάδες στο Rivya για το μοντέλο υπολοίπου που βλέπει ο χρήστης.

Πρώτη διαδρομή ενσωμάτωσης

1. Δημιουργήστε κλειδί API στις Ρυθμίσεις.

2. Καλέστε τη λίστα μοντέλων API για να επιλέξετε ένα δημόσιο αναγνωριστικό μοντέλου.

3. Διαβάστε την αναφορά API μοντέλων για τις παραμέτρους του μοντέλου.

4. Αν το μοντέλο χρειάζεται πολυμέσα αναφοράς, ανεβάστε τα με το API αρχείων.

5. Υποβάλετε την εργασία μέσω της δημιουργίας εργασίας.

6. Ελέγχετε την κατάσταση δημιουργίας μέχρι η εργασία να πετύχει ή να αποτύχει. Αν τα webhooks είναι ενεργοποιημένα για την εγκατάσταση και τον λογαριασμό, μπορείτε εναλλακτικά να εγγραφείτε μέσω του API για webhooks για υπογεγραμμένες ειδοποιήσεις ολοκλήρωσης.

7. Για μοντέλα συνομιλίας, χρησιμοποιήστε το API συνομιλίας αντί για το τελικό σημείο δημιουργίας. Τα συνημμένα εικόνας στη συνομιλία πρέπει να αναφέρουν τιμές file_id από το API αρχείων.

Σχετικές σελίδες

• Γρήγορη εκκίνηση API

• Έλεγχος ταυτότητας API

• SDK TypeScript του Rivya

• Αναφορά API μοντέλων

• API συνομιλίας

• API για webhooks

• Σφάλματα και όρια API