Używaj bety Rivya TypeScript SDK do wywoływania Public API v1 dla modeli, generowania, plików, kredytów, webhooków i Chat, w tym streamingu SSE.

Rivya udostępnia betę TypeScript SDK dla serwerowych integracji Public API.

SDK jest cienkim klientem nad Rivya Public API v1. Kontraktem niższego poziomu pozostaje Kontrakt OpenAPI i schemat, a metody SDK muszą być zgodne z tym schematem.

Stan

Pakiet jest obecnie utrzymywany w tym repozytorium jako prywatna beta. Nie jest publikowany do npm, dopóki nazwa pakietu, metadane, changelog i proces wydania nie zostaną wyraźnie zatwierdzone.

SDK obsługuje:

listowanie modeli
tworzenie i pobieranie asynchronicznych generowań
upload i pobieranie przez Files API
pobieranie salda kredytów
zarządzanie endpointami webhooków, testowe dostawy, listowanie zdarzeń, listowanie dostaw i rotację sekretu
weryfikację podpisów webhooków
niestreamingowe i streamingowe Chat completions oraz sesje czatu utworzone przez API

Streaming Chat jest dostępny w tej prywatnej becie przez serwerowe parsowanie SSE. Trzymaj sekretne klucze API na swoim serwerze.

Instalacja w Tym Repozytorium

Gdy SDK jest w becie, używaj lokalnego źródła pakietu:

pnpm --dir packages/rivya-sdk typecheck

Kod aplikacji powinien trzymać sekretny klucz API po stronie serwera:

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

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

Nie umieszczaj sekretnych kluczy API w bundle'ach przeglądarkowych, localStorage, zdarzeniach analitycznych, zrzutach ekranu ani współdzielonych zgłoszeniach.

Listuj Modele

models.list jest publiczne i nie wymaga klucza API:

const models = await rivya.models.list();

for (const model of models.data) {
  console.log(model.id, model.api_status, model.supported_api_inputs);
}

Utwórz Generowanie

Użyj generations.create do asynchronicznego generowania obrazu, wideo albo audio:

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

console.log(generation.id, generation.status);

Następnie odpytuj przez generations.retrieve:

const current = await rivya.generations.retrieve(generation.id);
console.log(current.status, current.result?.primary_url);

Używaj Idempotency-Key dla produkcyjnych żądań zapisu. SDK udostępnia to jako idempotencyKey.

Upload Plików

Użyj files.upload dla obrazów, wideo albo audio referencyjnego:

import { readFile } from "node:fs/promises";

const file = new Blob([await readFile("./reference.png")], {
  type: "image/png"
});

const uploaded = await rivya.files.upload({
  file,
  filename: "reference.png",
  kind: "image",
  model: "nano-banana-2",
  client_request_id: "asset-123"
});

console.log(uploaded.id, uploaded.url);

Użyj files.retrieve, aby ponownie odczytać metadane uploadu:

const sameFile = await rivya.files.retrieve(uploaded.id);
console.log(sameFile.mime_type, sameFile.duration_token);

Gdy używasz pliku w generowaniu, przekaż zwrócone pola publiczne przez params.referenceMediaItems:

await rivya.generations.create({
  model: "nano-banana-2",
  prompt: "Restyle this product photo for a clean editorial catalog page",
  params: {
    referenceMediaItems: [
      {
        url: uploaded.url,
        kind: uploaded.kind,
        name: uploaded.file_name,
        mimeType: uploaded.mime_type,
        durationSeconds: uploaded.duration_seconds ?? undefined,
        durationToken: uploaded.duration_token ?? undefined
      }
    ]
  }
});

Sprawdź Kredyty

const credits = await rivya.credits.retrieve();
console.log(credits.current_credits);

Zarządzaj Webhookami

Utwórz endpoint webhooka:

const endpoint = await rivya.webhooks.create({
  name: "Production webhook",
  url: "https://example.com/rivya/webhook",
  event_types: ["generation.succeeded", "generation.failed"]
});

console.log(endpoint.id, endpoint.signing_secret);

signing_secret jest zwracany tylko po wywołaniach create albo rotate. Przechowuj go na swoim serwerze.

Inne helpery webhooków:

await rivya.webhooks.list();
await rivya.webhooks.retrieve(endpoint.id);
await rivya.webhooks.update(endpoint.id, { status: "disabled" });
await rivya.webhooks.test(endpoint.id);
await rivya.webhooks.rotateSecret(endpoint.id);
await rivya.webhooks.deliveries.list(endpoint.id, { limit: 20 });
await rivya.webhookEvents.list({ limit: 20 });

Weryfikuj podpisy dostaw, zanim zaufasz payloadom webhooków:

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

const ok = await verifyRivyaWebhookSignature({
  rawBody,
  timestamp: request.headers.get("rivya-webhook-timestamp") || "",
  signatureHeader: request.headers.get("rivya-webhook-signature") || "",
  signingSecret: process.env.RIVYA_WEBHOOK_SIGNING_SECRET || ""
});

if (!ok) {
  throw new Error("Invalid Rivya webhook signature");
}

Helper SDK używa tego samego kontraktu HMAC-SHA256, który dokumentuje API Webhooks.

Chat

Użyj chat.completions.create dla jednej niestreamingowej tury Chat API:

const completion = await rivya.chat.completions.create(
  {
    model: "gpt-5-2-chat",
    message: "Write a concise launch plan for a new product image campaign",
    client_request_id: "chat-001"
  },
  {
    idempotencyKey: "chat-001"
  }
);

console.log(completion.session_id, completion.message.content);

Kontynuuj ze zwróconym session_id:

await rivya.chat.completions.create({
  model: "gpt-5-2-chat",
  session_id: completion.session_id,
  message: "Now turn that into a 5-step execution checklist."
});

Odczytuj sesje utworzone przez API:

await rivya.chat.sessions.list({ limit: 20 });
await rivya.chat.sessions.retrieve(completion.session_id);

Użyj chat.completions.stream, aby konsumować Server-Sent Events jako async iterator:

const stream = await rivya.chat.completions.stream(
  {
    model: "gpt-5-2-chat",
    message: "Write a concise launch plan for a new product image campaign",
    client_request_id: "chat-stream-001"
  },
  {
    idempotencyKey: "chat-stream-001"
  }
);

for await (const event of stream) {
  if (event.event === "message.delta") {
    process.stdout.write(event.data.delta);
  }

  if (event.event === "message.completed") {
    console.log(event.data.message.id);
  }
}

message.delta służy tylko do wyświetlania. Zatwierdzony wynik jest dostępny po message.completed i można go później odczytać przez chat.sessions.retrieve.

Błędy

SDK rzuca RivyaAPIError dla odpowiedzi Public API innych niż 2xx:

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

try {
  await rivya.generations.retrieve("task_missing");
} catch (error) {
  if (error instanceof RivyaAPIError) {
    console.log(error.status, error.code, error.requestId);
  }
}

RivyaAPIError zawiera status HTTP, publiczny kod błędu, message, request id gdy jest dostępny oraz bezpieczny podzbiór headerów odpowiedzi.

Walidacja

Uruchom kontrole SDK, zanim uznasz zmianę za ukończoną:

pnpm sdk:check
pnpm --dir packages/rivya-sdk typecheck
pnpm content:api-docs

pnpm sdk:check obejmuje statyczną kontrolę kontraktu oraz bezsieciową kontrolę runtime dla parsowania błędów, bezpiecznych headerów błędów, headerów idempotencji, autoryzacji Bearer, publicznego listowania modeli, parsowania SSE streamingu Chat, zdarzeń błędów streamingu Chat i weryfikacji podpisów webhooków.

Rivya TypeScript SDK