Dokumentace Rivya AI

Rychlý start Rivya API

Vytvořte API klíč, zvolte model, odešlete asynchronní úlohu generování a pošlete jeden tah Chat API s volitelným SSE streamováním.

Naposledy zkontrolováno 2026/05/10

Tento rychlý start ukazuje nejkratší bezpečnou cestu od nastavení účtu k jedné úloze generování přes Rivya API a také první tah Chat API.

V dokumentaci a příkladech používejte zástupné klíče. Nikdy nevkládejte skutečný API klíč do veřejného kódu, screenshotů, tiketů ani sdílených dokumentů.

1. Vytvořte API klíč

Otevřete nastavení API klíčů, vytvořte klíč, jednou zkopírujte celé tajemství a uložte ho do serverového prostředí.

Doporučená první oprávnění:

  • models:read
  • generations:create
  • generations:read
  • files:create
  • files:read
  • credits:read
  • webhooks:manage
  • chat:create
  • chat:read

2. Potvrďte základní URL

Použijte produkční základní URL API:

https://rivya.ai

Localhost URL jsou pouze pro lokální vývoj. Veřejné příklady by neměly používat lokální tajemství.

3. Vypište modely

curl https://rivya.ai/api/v1/models

Pole id z odpovědi použijte jako hodnotu model při vytváření generování.

4. Odešlete generování

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-001" \
  -d '{
    "model": "z-image",
    "prompt": "A clean editorial product image on a soft studio background"
  }'

Odpověď vrátí veřejné ID úlohy. Uložte si ho, abyste mohli později dotazovat stav.

5. Dotazujte stav

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

Hodnoty stavu jsou:

  • queued
  • processing
  • succeeded
  • failed

6. Zkontrolujte kredity

curl https://rivya.ai/api/v1/credits \
  -H "Authorization: Bearer rvya_sk_..."

Použijte to pro potvrzení aktuálního zůstatku účtu před testováním nebo po něm.

7. Volitelné: přidejte webhooky

Pokud váš server umí přijímat podepsaná HTTPS zpětná volání, vytvořte koncový bod webhooku:

curl https://rivya.ai/api/v1/webhooks \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production webhook",
    "url": "https://example.com/rivya/webhook",
    "event_types": ["generation.succeeded", "generation.failed"]
  }'

Uložte si jednorázový signing_secret z odpovědi a ověřte každé doručení, než budete důvěřovat obsahu zprávy.

8. Volitelné: pošlete tah Chat API

U chatových modelů volejte Chat API místo POST /api/v1/generations:

curl https://rivya.ai/api/v1/chat/completions \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-chat-001" \
  -d '{
    "model": "gpt-5-2-chat",
    "message": "Write a concise launch plan for a new product image campaign"
  }'

Vrácené session_id použijte k pokračování v relaci vytvořené přes API. Obrazové přílohy musí odkazovat na hodnoty file_id z Files API.

Volitelné: použijte beta TypeScript SDK

Serverové TypeScript integrace mohou použít lokální beta SDK:

import { RivyaClient } from "@rivya/sdk";

const rivya = new RivyaClient({
  apiKey: process.env.RIVYA_API_KEY
});

const generation = await rivya.generations.create({
  model: "z-image",
  prompt: "A clean editorial product image on a soft studio background"
});

Před přijetím do integrace si přečtěte Rivya TypeScript SDK. SDK obsahuje v privátní betě serverovou podporu streamování Chat.

Další stránky

Obsah