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

Το Rivya API v1 είναι το σημείο εισόδου για developers που θέλουν να καλέσουν δυνατότητες μοντέλων Rivya από το δικό τους προϊόν.

Το public API υποστηρίζει ασύγχρονη δημιουργία εικόνας, βίντεο και ήχου, καθώς και γύρους Chat API με non-streaming ή SSE streaming αποκρίσεις. Χρησιμοποιεί Rivya model IDs, Rivya account credits, public task IDs για generation και server-side chat sessions για το Chat API.

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

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

• υποβάλετε image, video ή audio generation jobs από τη δική σας εφαρμογή
• στείλετε non-streaming ή streaming chat turns και να συνεχίσετε chat sessions που δημιουργήθηκαν μέσω API
• κρατήσετε τη χρέωση μέσα στο ίδιο Rivya account credit wallet
• κάνετε poll την κατάσταση task με public task ID
• χρησιμοποιήσετε idempotent retries για ασφαλέστερα production requests
• κρατήσετε τη χρήση Studio και API μέσα στο ίδιο όριο λογαριασμού

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

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

Τρέχοντα v1 endpoints:

• 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

Η τρέχουσα έκδοση περιλαμβάνει signed webhooks για asynchronous generation results, Chat API και ένα TypeScript SDK beta με server-side streaming support.

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

Τα generation, status και credit endpoints απαιτούν:

Authorization: Bearer rvya_sk_...

Δημιουργήστε και περιστρέψτε keys από τις ρυθμίσεις API Keys. Διαβάστε τον έλεγχο ταυτότητας API πριν χρησιμοποιήσετε key σε production.

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

Οι API calls χρησιμοποιούν τα ίδια Rivya account credits με το Studio.

Τα generation jobs δεσμεύουν ή καταναλώνουν credits όταν ξεκινά το task. Τα Chat turns δεσμεύουν credits πριν από την κλήση μοντέλου και διακανονίζουν τα τελικά credits από το token usage όταν αποθηκεύεται το assistant message. Αν ένα generation ή chat turn αποτύχει σύμφωνα με τους υπάρχοντες κανόνες αποτυχίας του Rivya, ισχύει ο ίδιος χειρισμός refund.

Διαβάστε τα API Credits και credits και χρεώσεις στο Rivya για το user-facing wallet model.

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

1. Δημιουργήστε API key στις Settings.
2. Καλέστε τη λίστα API models για να επιλέξετε public model ID.
3. Διαβάστε την αναφορά API μοντέλων για τις παραμέτρους του μοντέλου.
4. Αν το μοντέλο χρειάζεται reference media, ανεβάστε τα με το Files API.
5. Υποβάλετε job με τη δημιουργία generation.
6. Κάντε poll την κατάσταση generation μέχρι το task να πετύχει ή να αποτύχει, ή εγγραφείτε στα API Webhooks για υπογεγραμμένα completion events.
7. Για chat models, χρησιμοποιήστε το Chat API αντί για το generation endpoint. Τα image attachments του Chat πρέπει να αναφέρουν τιμές file_id από το Files API.

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

• Γρήγορη εκκίνηση API
• Έλεγχος ταυτότητας API
• Rivya TypeScript SDK
• Αναφορά API μοντέλων
• Chat API
• API Webhooks
• Σφάλματα και όρια API