Använd Rivya TypeScript SDK beta för att anropa Public API v1 för modeller, generationer, filer, credits, webhooks och Chat inklusive SSE-streaming.

Rivya tillhandahåller en TypeScript SDK beta för serverbaserade Public API-integrationer.

SDK:n är en tunn klient ovanpå Rivyas publika API v1. Det lägre kontraktet är fortfarande OpenAPI och schemakontrakt, och SDK-metoderna måste hålla sig i linje med det schemat.

Status

Paketet underhålls just nu i detta repo som en privat beta. Det publiceras inte till npm förrän paketnamn, metadata, changelog och releaseprocess är uttryckligen godkända.

SDK:n stöder:

modellista
skapa och hämta asynkrona generationer
Files API-uppladdning och hämtning
hämtning av creditsaldo
hantering av webhook-endpoints, testleveranser, eventlista, leveranslista och secret-rotation
verifiering av webhooksignaturer
icke-streamande och streamande Chat completions, plus API-skapade chattsessioner

Chat-streaming är tillgänglig i denna privata beta via serverbaserad SSE-parsning. Håll hemliga API-nycklar på din server.

Installera i detta repo

Använd den lokala paketkällan medan SDK:n är i beta:

pnpm --dir packages/rivya-sdk typecheck

Applikationskod ska hålla den hemliga API-nyckeln på servern:

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

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

Placera inte hemliga API-nycklar i webbläsarbundles, localStorage, analys-events, skärmbilder eller delade ärenden.

Lista modeller

models.list är offentlig och kräver ingen API-nyckel:

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

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

Skapa en generation

Använd generations.create för asynkron bild-, video- eller ljudgenerering:

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

Polla sedan med generations.retrieve:

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

Använd Idempotency-Key för skrivbegäranden i produktion. SDK:n exponerar detta som idempotencyKey.

Ladda upp filer

Använd files.upload för referensbilder, videor eller ljud:

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

Använd files.retrieve för att läsa uppladdad metadata igen:

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

När du använder en fil i en generation skickar du de returnerade offentliga fälten via 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
      }
    ]
  }
});

Kontrollera credits

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

Hantera webhooks

Skapa en webhook-endpoint:

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 returneras bara efter create- eller rotate-anrop. Spara den på din server.

Andra webhook-hjälpare:

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

Verifiera leveranssignaturer innan du litar på webhookpayloads:

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

SDK-hjälparen använder samma HMAC-SHA256-kontrakt som dokumenteras i API-webhooks.

Chat

Använd chat.completions.create för en icke-streamande Chat API-turn:

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

Fortsätt med det returnerade 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."
});

Läs API-skapade sessioner:

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

Använd chat.completions.stream för att konsumera Server-Sent Events som en 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 är endast för visning. Det committade resultatet är tillgängligt efter message.completed och kan läsas senare med chat.sessions.retrieve.

Fel

SDK:n kastar RivyaAPIError för icke-2xx-svar från Public API:

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 innehåller HTTP-status, offentlig felkod, meddelande, request id när det finns och en säker delmängd av response headers.

Validering

Kör SDK-kontrollerna innan du betraktar en ändring som klar:

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

pnpm sdk:check inkluderar en statisk kontraktskontroll och en nätverksfri runtime-kontroll för felparsning, säkra felheaders, idempotensheaders, Bearer auth, offentlig modellista, Chat-streaming SSE-parsning, Chat-streaming error events och webhooksignaturverifiering.

Rivya TypeScript SDK