Przegląd Rivya API

Rivya API v1 to kontrakt deweloperski do wywoływania obsługiwanych możliwości modeli Rivya z własnego produktu, gdy Public API jest włączone we wdrożeniu i dostępne dla konta.

Wdrożony kontrakt obejmuje asynchroniczne generowanie obrazów, wideo i audio oraz Chat API z odpowiedziami zwykłymi lub SSE. Używa identyfikatorów modeli Rivya, kredytów konta, publicznych ID zadań i serwerowych sesji czatu. Udokumentowana trasa nie obiecuje dostępu dla każdego środowiska, konta czy modelu; przed integracją sprawdź bieżący dostęp i gotowość modelu.

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ć tury czatu bez strumienia lub ze strumieniem i kontynuować sesje utworzone przez API

• utrzymać rozliczenia w tym samym portfelu kredytów konta Rivya

• odpytywać status zadania po jego publicznym identyfikatorze

• 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

Wdrożone punkty końcowe v1 obejmują:

• 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żący kontrakt obejmuje podpisane webhooki wyników asynchronicznego generowania, Chat API i wersję beta TypeScript SDK ze strumieniowaniem serwerowym. Webhooki wymagają włączenia tej funkcji i Public API we wdrożeniu.

Uwierzytelnianie

Punkty końcowe generowania, statusu i punktów wymagają:

Authorization: Bearer rvya_sk_...

Twórz i zmieniaj klucze w ustawieniach kluczy API. Przed użyciem klucza w środowisku produkcyjnym 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 Ustawieniach.

2. Wywołaj listę modeli API, aby wybrać publiczny identyfikator 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 zakończy się sukcesem lub błędem. Jeśli webhooki są włączone dla wdrożenia i konta, możesz zamiast tego subskrybować podpisane zdarzenia przez Webhooki API.

7. Dla modeli czatu używaj Chat API zamiast punktu końcowego generowania. Załączniki obrazów 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