Przegląd Rivya API

Rivya API v1 to punkt wejścia dla developerów, którzy chcą wywoływać możliwości modeli Rivya z własnego produktu.

Publiczne API obsługuje asynchroniczne generowanie obrazów, wideo i audio oraz tury Chat API z odpowiedziami niestreamingowymi albo streamingiem SSE. Używa ID modeli Rivya, kredytów konta Rivya, publicznych ID zadań dla generowania oraz serwerowych sesji czatu dla Chat API.

Do Czego Służy API

Używaj API, gdy chcesz:

• wysyłać zadania generowania obrazu, wideo albo audio z własnej aplikacji
• wysyłać niestreamingowe albo streamingowe tury czatu i kontynuować sesje czatu utworzone przez API
• utrzymać rozliczenia w tym samym portfelu kredytów konta Rivya
• odpytywać status zadania po publicznym ID zadania
• używać idempotentnych ponowień dla bezpieczniejszych żądań produkcyjnych
• utrzymać użycie Studio i API w tej samej granicy konta

API jest warstwą produktu Rivya. Publiczne odpowiedzi używają wyłącznie nazw Rivya i pól publicznych.

Zakres Bieżącej Wersji

Bieżące endpointy 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

Bieżąca wersja obejmuje podpisane webhooki dla wyników asynchronicznego generowania, Chat API oraz betę TypeScript SDK z obsługą streamingu po stronie serwera.

Uwierzytelnianie

Endpointy generowania, statusu i kredytów wymagają:

Authorization: Bearer rvya_sk_...

Twórz i rotuj klucze w ustawieniach API Keys. Przed użyciem klucza w produkcji przeczytaj uwierzytelnianie API.

Model Rozliczeń

Wywołania API używają tych samych kredytów konta Rivya co Studio.

Zadania generowania rezerwują albo zużywają kredyty przy starcie zadania. Tury Chat rezerwują kredyty przed wywołaniem modelu i rozliczają końcowe kredyty z użycia tokenów po zapisaniu wiadomości asystenta. Jeśli generowanie albo tura czatu nie powiedzie się zgodnie z istniejącymi regułami awarii Rivya, stosowana jest ta sama obsługa zwrotów.

Przeczytaj kredyty API oraz kredyty i rozliczenia w Rivya, aby poznać model portfela widoczny dla użytkownika.

Pierwsza Ścieżka Integracji

1. Utwórz klucz API w Settings.
2. Wywołaj listę modeli API, aby wybrać publiczny ID modelu.
3. Przeczytaj Referencję modeli API, aby poznać parametry modelu.
4. Jeśli model potrzebuje mediów referencyjnych, prześlij je przez Files API.
5. Wyślij zadanie przez utwórz generowanie.
6. Odpytuj status generowania, aż zadanie się powiedzie albo nie powiedzie, albo zasubskrybuj API Webhooks, aby otrzymywać podpisane zdarzenia zakończenia.
7. Dla modeli czatu używaj Chat API zamiast endpointu generowania. Załączniki obrazów Chat muszą odwoływać się do wartości file_id z Files API.

Powiązane Strony

• Szybki start API
• Uwierzytelnianie API
• Rivya TypeScript SDK
• Referencja modeli API
• Chat API
• API Webhooks
• Błędy i limity API