Dokumentacja Rivya AI
Strony API modeli

Integracja API Grok Imagine

Używaj Grok Imagine przez Rivya Public API v1 z identyfikatorem modelu grok-imagine, obsługiwanymi wejściami, parametrami, regułami Files API, kredytami i przykładami odpowiedzi.

Dostępne przez APITekst lub URL gotowe; tryby referencyjne używają Files APIObraz
Identyfikator modelu API

grok-imagine

Wejścia

text, file

Files API

Wymagane dla trybów referencyjnych

Kredyty bazowe

4

Możliwość

Obraz

Rozliczenia

FIXED

Limit promptu

5000 znaków

Kontrakt żądania

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

KluczTypWymaganeDomyślnieOpis
modelstringTakgrok-imagineUżyj grok-imagine jako identyfikatora modelu API.
promptstringTak-Maksymalnie 5000 znaków dla tego modelu.
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
aspect_ratioselectNie1:1-1:1, 2:3, 3:2, 16:9, 9:16Proporcje obrazu
enable_proselectNiefalse-false, trueTo przelacznik jakosci Grok Imagine tylko dla text-to-image. Standard jest tanszy, a Quality idzie w strone wiekszej liczby szczegolow; obecna sciezka edycji obrazu go nie uzywa.

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 referencyjny: Przeslij maksymalnie 1 plik obrazu dla projektow obrazowych.

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": "grok-imagine",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1",
    "enable_pro": "false"
  }
}

Żądanie z plikiem referencyjnym

{
  "model": "grok-imagine",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1",
    "enable_pro": "false",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Odpowiedź tworzenia

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

{
  "id": "task_grok_imagine_example",
  "status": "queued",
  "model": "grok-imagine",
  "reserved_credits": 4,
  "final_credits": 0,
  "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.