Luo API-avain, valitse malli, lähetä asynkroninen generointityö ja lähetä Chat API -vuoro valinnaisella SSE-streamauksella.

Tämä pika-aloitus näyttää lyhimmän turvallisen polun tilin asetuksista yhteen Rivya API -generointityöhön sekä ensimmäiseen Chat API -vuoroon.

Käytä dokumentaatiossa ja esimerkeissä placeholder-avaimia. Älä koskaan liitä oikeaa API-avainta julkiseen koodiin, kuvakaappauksiin, tukipyyntöihin tai jaettuihin dokumentteihin.

1. Luo API-avain

Avaa API-avainten asetukset, luo avain, kopioi koko salaisuus kerran ja tallenna se palvelinpuolen ympäristöön.

Suositellut ensimmäiset scope-oikeudet:

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

2. Vahvista base URL

Käytä tuotannon API-base-URL-osoitetta:

https://rivya.ai

Localhost-URL-osoitteet ovat vain paikallista kehitystä varten. Julkisissa esimerkeissä ei pidä käyttää paikallisia salaisuuksia.

3. Listaa mallit

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

Käytä vastauksen id-kenttää model-arvona, kun luot generoinnin.

4. Lähetä generointi

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

Vastaus palauttaa julkisen tehtävätunnuksen. Tallenna se, jotta voit pollata tilaa myöhemmin.

5. Pollaa tila

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

Tila-arvot ovat:

queued
processing
succeeded
failed

6. Tarkista krediitit

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

Käytä tätä nykyisen tilisaldon vahvistamiseen ennen testausta tai sen jälkeen.

7. Valinnainen: lisää webhookit

Jos palvelimesi voi vastaanottaa allekirjoitettuja HTTPS-callbackeja, luo webhook-endpoint:

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

Tallenna vastauksesta kertakäyttöinen signing_secret ja varmista jokainen toimitus ennen payloadin luottamista.

8. Valinnainen: lähetä chat-vuoro

Chat-malleissa kutsu Chat API:a endpointin POST /api/v1/generations sijaan:

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

Käytä palautettua session_id-arvoa API:n luoman istunnon jatkamiseen. Kuvaliitteiden täytyy viitata Files API:n file_id-arvoihin.

Valinnainen: käytä TypeScript SDK -betaa

Palvelinpuolen TypeScript-integraatiot voivat käyttää paikallista SDK-betaa:

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"
});

Lue Rivya TypeScript SDK ennen käyttöönottoa. SDK sisältää palvelinpuolen Chat-streamaustuen yksityisessä betassa.

Rivya API -pika-aloitus