Rivya API

Buduj na wielomodalnej warstwie modeli Rivya

Rivya API daje zespołom produktowym publiczny, oparty na koncie sposób wywoływania modeli Rivya z własnych aplikacji. Zacznij od asynchronicznych zadań obrazu, wideo i audio, dodaj tury Chat API z opcjonalnym strumieniowaniem SSE, gdy model obsługuje czat, i utrzymaj rozliczenia w tym samym portfelu kredytów Rivya.

Przeczytaj dokumentację API Utwórz klucz API

Kształt szybkiego startu

Warstwa modeli

Dynamiczny katalog

Rozliczenia

Wspólne kredyty

Pierwsza wersja

Zadania + Chat

Dostęp

Klucze API

MetodaPOST

Endpoint/api/v1/generations

Rzeczywiste żądanie wymaga klucza Rivya API i dostępnych kredytów na koncie. Publiczne przykłady używają sekretów zastępczych i nie wywołują modeli anonimowo.

Żądanie

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'

Odpowiedź

{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "result": null,
  "error": null
}

Debugger online

Podejrzyj żądanie, a potem uruchom je własnym kluczem API

Debugger zaczyna w trybie mock dla każdego odwiedzającego. Selektor generowania pokazuje modele niebędące modelami czatu, które można testować bez przesyłania plików, a panel Files pozwala zalogowanym użytkownikom testować /api/v1/files z tymczasowym kluczem API. Przykłady czatu są w dokumentacji API.

Stan konta

Sprawdzanie konta

Prefiks aktywnego klucza

Najpierw utwórz klucz

Aktualne kredyty

Zaloguj się, aby sprawdzić

Podgląd mockRzeczywiste Public APIBrak aktywnego klucza API

Tryb mock nigdy nie wywołuje modelu i nigdy nie zużywa kredytów.

Model

Klucz idempotencji

Identyfikator żądania klienta

Prompt

Klucz API

Wklej klucz tylko dla tego żądania. Debugger nie przechowuje go po odświeżeniu.

Test przesyłania Files API

Prześlij materiały referencyjne przez POST /api/v1/files, a potem skopiuj zwrócony URL i token czasu trwania do params.referenceMediaItems dla modelu obsługującego wejścia referencyjne.

Mock nigdy nie przesyła plikówTryb live używa /api/v1/files

Model referencyjny

Rodzaj pliku

Plik referencyjny

Wybrany model określa dozwolone typy MIME, rozmiar i reguły czasu trwania. Rzeczywiste przesyłanie wymaga tymczasowego klucza API i może wywołać rzeczywistą usługę przesyłania.

Utwórz klucz API Przeczytaj dokumentację API

Podgląd żądania

{
  "model": "z-image",
  "prompt": "Edytorskie zdjęcie produktu w czystym planie studyjnym",
  "params": {
    "aspect_ratio": "1:1"
  }
}

Odpowiedź

{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}

Odpowiedź Files API

{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}

Parametry generowania

{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png",
        "sizeBytes": 245760
      }
    ]
  }
}

Stan zadania

Szacowane kredyty bazowe

Status

queued

Ścieżka startowa

Od konta do pierwszego żądania API

Utwórz klucz

Zaloguj się, otwórz API Keys w Ustawieniach, utwórz klucz z zakresem uprawnień i od razu zapisz pełny sekret.

Wybierz model

Przeczytaj referencję modeli API albo wywołaj /api/v1/models, aby sprawdzić identyfikatory modeli, parametry, możliwości czatu i gotowość danych wejściowych przed wysłaniem żądania.

Wyślij, odpytuj albo subskrybuj

Wyślij idempotentne żądanie generowania, odpytuj publiczny endpoint zadania, użyj podpisanych webhooków do callbacków generowania albo wyślij turę Chat API z opcjonalnym strumieniowaniem SSE.

Co trafia do pierwszej wersji

Publiczna warstwa API spójna z produktem Rivya

API jest częścią produktu Rivya. Używa identyfikatorów modeli Rivya, kredytów Rivya, publicznych stanów zadań oraz dokumentacji połączonej z katalogiem modeli.

API generowania obrazów

Przesyłaj zadania obrazów z promptem i obsługiwanymi parametrami modelu, a potem odpytuj publiczne wyniki.

API generowania wideo

Uruchamiaj asynchroniczne zadania wideo z tymi samymi kontrolami zadań i kredytów, których używa Studio.

API generowania audio

Korzystaj z modeli audio dostępnych przez API w granicach tego samego konta, salda i historii.

Wspólny portfel kredytów

Wywołania API i użycie w Studio korzystają z tego samego salda Rivya, z rezerwacją kredytów i obsługą niepowodzeń.

Granica wersji

Jasny zakres bez ukrytych obietnic

Ta strona oddziela dostępne funkcje API od przyszłych dodatków, aby można było planować integrację na podstawie tego, co działa już dziś.

Chat API

Dostępne

Dostępne dla tur bez strumieniowania i ze strumieniowaniem SSE, z sesjami tworzonymi przez API, kredytami konta i opcjonalnymi załącznikami obrazów z Files API.

Files API

Dostępne

Dostępne do przesyłania obrazów, wideo i audio jako materiałów referencyjnych. Użyj go przed generowaniem, gdy strona modelu wymaga params.referenceMediaItems.

Webhooki użytkownika

Dostępne

Dostępne dla integracji produkcyjnych, które chcą podpisanych callbacków dla udanych lub nieudanych zadań generowania.

Dokumentacja API

Przeczytaj o uwierzytelnianiu, treściach żądań, odpowiedziach, idempotencji, parametrach modeli i kodach błędów.

Otwórz dokumentację

Zarządzanie kluczami API

Utwórz klucz API i skopiuj go tylko raz. Aby go zastąpić, utwórz nowy klucz i unieważnij stary w chronionej sekcji Ustawienia.

Zarządzaj kluczami

Debugowanie online

Najpierw użyj przykładów mock; rzeczywiste debugowanie wymaga logowania, klucza API i kredytów na koncie.

Podejrzyj przepływ

Buduj na wielomodalnej warstwie modeli Rivya

curl https://rivya.ai/api/v1/generations \ -H "Authorization: Bearer rvya_sk_..." \ -H "Content-Type: application/json" \ -H "Idempotency-Key: demo-job-001" \ -d '{ "model": "z-image", "prompt": "Editorial product photo on a clean studio set" }'

Podejrzyj żądanie, a potem uruchom je własnym kluczem API

{ "id": "file_mock_001", "object": "file", "kind": "image", "file_name": "reference.png", "mime_type": "image/png", "size_bytes": 245760, "url": "https://media.example/reference.png", "duration_seconds": null, "duration_token": null, "created_at": "2026-05-11T00:00:00.000Z", "expires_at": null }

{ "params": { "referenceMediaItems": [ { "url": "https://media.example/reference.png", "kind": "image", "name": "reference.png", "mimeType": "image/png", "sizeBytes": 245760 } ] } }