Dokumentacja Rivya AI
Strony API modeli

Integracja API Topaz Image Upscaler

Używaj Topaz Image Upscaler przez Rivya Public API v1 z identyfikatorem modelu topaz-image-upscale, obsługiwanymi wejściami, parametrami, regułami Files API, kredytami i przykładami odpowiedzi.

Dostępne przez APIGotowośćObraz
Identyfikator modelu API

topaz-image-upscale

Wejścia

file

Files API

Wymagane dla trybów referencyjnych

Kredyty bazowe

per_image · 2K=10 · 4K=20 · 8K=40 · ⌈total⌉

Możliwość

Obraz

Rozliczenia

FIXED

Limit promptu

Brak udokumentowanego limitu promptu

Kontrakt żądania

Wyślij identyfikator modelu na najwyższym poziomie. Kontrolki specyficzne dla modelu należą do params.

KluczTypWymaganeDomyślnieOpis
modelstringTaktopaz-image-upscaleUżyj topaz-image-upscale jako identyfikatora modelu API.
promptstringNie-Tekst promptu dla modeli obsługujących wejście tekstowe.
paramsobjectNie-Obiekt parametrów specyficznych dla modelu. Dozwolone klucze znajdziesz w wierszach poniżej.
client_request_idstringNie-Opcjonalny identyfikator po stronie klienta do śledzenia żądań w Twoim systemie.

Parametry modelu

KluczTypWymaganeDomyślnieZakresOpcjeOpis
upscale_factorselectNie2-1, 2, 4Współczynnik powiększenia

Zasady przesyłania

Najpierw prześlij pliki referencyjne, a potem umieść zwrócony URL i token czasu trwania w params.referenceMediaItems.

Reguła referencji

Obraz źródłowy: Dokładnie 1 obraz JPEG, PNG lub WebP do 10 MB; dłuższy bok wyniku ≤ 8192 px.

Maks. plików

1

Akceptowane rodzaje plików

image

Token czasu trwania

Referencje wideo i audio powinny zawierać durationToken z /api/v1/files, gdy wymagana jest weryfikacja czasu trwania.

kindMaks. rozmiarTypy MIME
image10 MBimage/jpeg, image/png, image/webp

Żądanie minimalne

{
  "model": "topaz-image-upscale",
  "params": {
    "upscale_factor": "2"
  }
}

Żądanie z plikiem referencyjnym

{
  "model": "topaz-image-upscale",
  "params": {
    "upscale_factor": "2",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png",
        "width": 1024,
        "height": 1024,
        "sizeBytes": 1048576,
        "imageDimensionsToken": "image_dimensions_token_from_original_files_api_upload_response"
      }
    ]
  }
}

Odpowiedź tworzenia

Endpoint tworzenia zwraca publiczny identyfikator zadania. Odpytuj endpoint statusu, aż zadanie zakończy się powodzeniem albo błędem.

{
  "id": "task_topaz_image_upscale_example",
  "status": "queued",
  "model": "topaz-image-upscale",
  "reserved_credits": 40,
  "final_credits": 0,
  "settlement_status": "RESERVED",
  "created_at": "2026-05-11T00:00:00.000Z",
  "updated_at": "2026-05-11T00:00:00.000Z",
  "result": null,
  "error": null
}

Typowe błędy

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Niektóre tryby wymagają przesłania materiałów referencyjnych przez Files API.