Brug Rivya TypeScript SDK beta til at kalde Public API v1 for modeller, generationer, filer, credits, webhooks og Chat inklusive SSE-streaming.

Rivya tilbyder en TypeScript SDK beta til server-side Public API-integrationer.

SDK'en er en tynd klient oven på Rivya Public API v1. Den lavere kontrakt forbliver OpenAPI- og schema-kontrakt, og SDK-metoder skal blive ved med at være på linje med det schema.

Status

Pakken vedligeholdes aktuelt inde i dette repository som en private beta. Den publiceres ikke til npm, før pakkenavn, metadata, changelog og releaseproces er eksplicit godkendt.

SDK'en understøtter:

modelliste
oprettelse og hentning af asynkrone generationer
Files API-upload og -hentning
hentning af credit-saldo
styring af webhook-endpoints, test deliveries, eventlister, delivery-lister og secret-rotation
verificering af webhook-signaturer
ikke-streaming og streaming Chat completions plus API-oprettede chat-sessioner

Chat streaming er tilgængelig i denne private beta gennem server-side SSE-parsing. Hold secret API keys på din server.

Installer i dette repo

Brug den lokale pakkekilde, mens SDK'en er i beta:

pnpm --dir packages/rivya-sdk typecheck

Applikationskode bør holde den hemmelige API-nøgle på serveren:

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

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

Læg ikke hemmelige API-nøgler i browser bundles, localStorage, analytics-events, screenshots eller delte tickets.

List modeller

models.list er offentlig og kræver ikke en API-nøgle:

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

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

Opret en generation

Brug generations.create til asynkron billed-, video- eller audiogenerering:

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

Poll derefter med generations.retrieve:

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

Brug Idempotency-Key til production write requests. SDK'en eksponerer dette som idempotencyKey.

Upload filer

Brug files.upload til referencebilleder, videoer eller audio:

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

Brug files.retrieve til at læse uploadede metadata igen:

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

Når en fil bruges i en generation, skal de returnerede offentlige felter sendes gennem 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
      }
    ]
  }
});

Tjek credits

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

Administrer webhooks

Opret et 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 returneres kun efter create- eller rotate-kald. Gem den på din server.

Andre webhook-hjælpere:

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

Verificer delivery-signaturer, før du stoler på webhook-payloads:

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-helperen bruger den samme HMAC-SHA256-kontrakt, som er dokumenteret i API Webhooks.

Chat

Brug chat.completions.create til én ikke-streaming 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æt med det returnerede 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-oprettede sessioner:

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

Brug chat.completions.stream til at forbruge 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 er kun til visning. Det committed resultat er tilgængeligt efter message.completed og kan læses senere med chat.sessions.retrieve.

Fejl

SDK'en kaster RivyaAPIError for ikke-2xx Public API-svar:

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 inkluderer HTTP-status, offentlig fejlkode, message, request id når tilgængeligt og et sikkert subset af response headers.

Validering

Kør SDK-kontrollerne, før en ændring behandles som færdig:

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

pnpm sdk:check inkluderer en statisk kontraktkontrol og en no-network runtime-kontrol for fejlparsing, sikre fejlheaders, idempotency-headers, Bearer auth, offentlig modelliste, Chat streaming SSE-parsing, Chat streaming error events og webhook-signaturverificering.

Rivya TypeScript SDK