Rivya API

Stavte na multimodální modelové vrstvě Rivya

Rivya API dává produktovým týmům veřejný, účtový způsob, jak volat modely Rivya z vlastních aplikací. Začněte asynchronními obrazovými, video a audio úlohami, přidejte Chat API turns s volitelným SSE streamingem, když model podporuje chat, a udržte fakturaci ve stejné kreditní peněžence Rivya.
Číst API dokumentaciVytvořit API key

Tvar quickstartu

Modelová vrstva

Dynamický katalog

Fakturace

Sdílené kredity

První verze

Úlohy + Chat

Přístup

API keys

MetodaPOST
Endpoint/api/v1/generations

Skutečný požadavek vyžaduje Rivya API key a dostupné kredity účtu. Veřejné příklady používají zástupné secrets a nevolají modely anonymně.

Požadavek
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"
  }'
Odpověď
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Co přichází jako první

Veřejná API vrstva, která zůstává sladěná s produktem Rivya

API je navržené jako produktová plocha Rivya. Používá Rivya model IDs, Rivya kredity, veřejné stavy úloh a dokumentaci, která zůstává propojená s katalogem modelů.

API pro generování obrázků

Odesílejte obrazové úlohy s promptem a podporovanými parametry modelu a potom pollujte veřejné výsledky.

API pro generování videa

Spouštějte asynchronní video úlohy se stejnými kontrolami úloh a kreditů, jaké používá Studio.

API pro generování audia

Používejte audio modely dostupné přes API v rámci stejného účtu, zůstatku a hranice historie.

Sdílená kreditní peněženka

API volání i používání Studia čerpají ze stejného zůstatku Rivya, včetně rezervovaných kreditů a zpracování selhání.

Startovací cesta

Od účtu k prvnímu API požadavku

01

Vytvořte klíč

Přihlaste se, otevřete API Keys v Nastavení, vytvořte scoped key a okamžitě uložte celý secret.

02

Vyberte model

Přečtěte si API referenci modelů nebo zavolejte /api/v1/models a zkontrolujte model IDs, parametry, chatové schopnosti a připravenost vstupu před odesláním.

03

Odešlete, pollujte nebo odebírejte

Pošlete idempotentní generační požadavek, pollujte veřejný endpoint úloh, použijte podepsané webhooky pro generační callbacky nebo pošlete Chat API turn s volitelným SSE streamingem.

Hranice verze

Jasný rozsah, žádné skryté sliby

Landing page může zmínit budoucí plochy, ale aktuální produktová copy nesmí naznačovat, že nedokončená API už jsou živá.

Chat API

Dostupné

Dostupné pro non-streaming i SSE streaming turns se sessions vytvořenými přes API, účtovými kredity a volitelnými obrazovými přílohami přes Files API.

Files API

Dostupné

Dostupné pro nahrávání referenčních obrázků, videí a audia. Použijte ho před generováním, když stránka modelu vyžaduje params.referenceMediaItems.

Uživatelské webhooky

Dostupné

Dostupné pro produkční integrace, které chtějí podepsané callbacky pro úspěšné nebo selhané generační úlohy.

Online ladicí nástroj

Nejdřív si prohlédněte požadavek, potom ho spusťte vlastním API key

Debugger začíná pro každého návštěvníka v mock režimu. Selektor generování uvádí nechatové modely, které lze testovat bez nahrávání souborů, zatímco panel Files umožňuje přihlášeným uživatelům testovat /api/v1/files s dočasným API key. Příklady chatu jsou v API dokumentaci.

Stav účtu

Kontroluje se účet

Prefix aktivního klíče

Nejprve vytvořte klíč

Aktuální kredity

Přihlaste se pro kontrolu

Mock náhledŽivé Public APIŽádný aktivní API key

Mock režim nikdy nevolá model a nikdy nespotřebovává kredity.

Vložte klíč jen pro tento požadavek. Debugger ho po obnovení stránky neukládá.

Test nahrání přes Files API

Nahrajte referenční média přes POST /api/v1/files a potom zkopírujte vrácenou URL a duration token do params.referenceMediaItems pro model, který podporuje referenční vstupy.

Mock nikdy nenahráváŽivý režim používá /api/v1/files

Vybraný model určuje povolené MIME typy, velikost a pravidla délky. Živá nahrání vyžadují váš dočasný API key a mohou volat skutečnou upload službu.

Vytvořit API keyČíst API dokumentaci
Náhled požadavku
{
  "model": "z-image",
  "prompt": "Redakční produktová fotografie v čistém studiovém prostředí",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Odpověď
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Odpověď 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 generování
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Stav úlohy

Odhad základních kreditů

1

Stav

queued

API dokumentace

Čtěte o autentizaci, tělech požadavků, odpovědích, idempotenci, parametrech modelů a chybových kódech.

Otevřít dokumentaci

Správa API keys

Vytvářejte, jednou kopírujte, revokujte a rotujte API keys z chráněné oblasti Nastavení.

Spravovat klíče

Online ladění

Nejprve použijte mock příklady; skutečné ladění vyžaduje přihlášení, API key a kredity účtu.

Zobrazit náhled toku