Rivya AI-dokumentasjon
Modell-API-sider

Grok Imagine API-integrasjon

Bruk Grok Imagine via Rivya Public API v1 med modell-ID grok-imagine, støttede inndata, parametere, Files API-regler, kreditter og svareksempler.

Tilgjengelig via APITekst eller URL er klar; referansemoduser bruker Files APIBilde
API-modell-ID

grok-imagine

Inndata

text, file

Files API

Kreves for referansemoduser

Basiskreditter

4

Egenskap

Bilde

Fakturering

FIXED

Promptgrense

5000 tegn

Forespørselskontrakt

Send modell-ID-en på toppnivå. Modellspesifikke kontroller hører hjemme i params.

NøkkelTypePåkrevdStandardBeskrivelse
modelstringJagrok-imagineBruk API-modell-ID-en grok-imagine.
promptstringJa-Maksimalt 5000 tegn for denne modellen.
paramsobjectNei-Modellspesifikt parameterobjekt. Bruk radene nedenfor for tillatte nøkler.
client_request_idstringNei-Valgfri klient-ID for sporing av forespørsler i systemet ditt.

Modellparametere

NøkkelTypePåkrevdStandardOmrådeAlternativerBeskrivelse
aspect_ratioselectNei1:1-1:1, 2:3, 3:2, 16:9, 9:16Sideforhold
enable_proselectNeifalse-false, trueDette er kvalitetsbryteren for Grok Imagine, bare for tekst-til-bilde. Standard er billigere, mens Quality heller mot mer detalj; den nåværende bilderedigeringsbanen bruker den ikke.

Opplastingspolicy

Last opp referansefiler først, og plasser deretter returnert URL og varighetstoken i params.referenceMediaItems.

Referanseregel

Referansebilde: Last opp opptil 1 bildefil for bildeprosjekter.

Maks filer

1

Godtatte filtyper

image

Varighetstoken

Video- og lydreferanser bør ha durationToken fra /api/v1/files når varighetsverifisering kreves.

kindMaks størrelseMIME-typer
image10 MBimage/jpeg, image/png, image/webp

Minimal forespørsel

{
  "model": "grok-imagine",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1",
    "enable_pro": "false"
  }
}

Referansefilforespørsel

{
  "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"
      }
    ]
  }
}

Opprettelsessvar

Create-endepunktet returnerer en offentlig oppgave-ID. Poll statusendepunktet til oppgaven lykkes eller mislykkes.

{
  "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
}

Vanlige feil

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Noen moduser krever referanseopplastinger via Files API.