Используйте beta Rivya TypeScript SDK для вызова Public API v1: моделей, генераций, файлов, кредитов, вебхуков и Chat, включая SSE-стриминг.

Rivya предоставляет beta TypeScript SDK для серверных интеграций Public API.

SDK - тонкий клиент поверх Rivya Public API v1. Низкоуровневым контрактом остается OpenAPI и контракт схемы, а методы SDK должны оставаться согласованными с этой схемой.

Статус

Сейчас package поддерживается внутри этого репозитория как private beta. Он не публикуется в npm, пока имя пакета, metadata, changelog и процесс релиза не будут явно одобрены.

SDK поддерживает:

получение списка моделей
создание и получение асинхронных генераций
загрузку и получение через Files API
получение баланса кредитов
управление endpoint вебхуков, тестовые доставки, список событий, список доставок и ротацию секрета
проверку подписи вебхука
завершения Chat без стриминга и со стримингом, а также сессии чата, созданные через API

Chat streaming доступен в этой закрытой beta-версии через серверный SSE parsing. Держите секретные API-ключи на своем сервере.

Установка в этом репозитории

Пока SDK находится в beta, используйте локальный исходник пакета:

pnpm --dir packages/rivya-sdk typecheck

Код приложения должен хранить секретный API-ключ на сервере:

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

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

Не помещайте секретные API-ключи в браузерные bundles, localStorage, аналитические события, скриншоты или общие тикеты.

Список моделей

models.list публичен и не требует API-ключа:

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

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

Создание генерации

Используйте generations.create для асинхронной генерации изображений, видео или аудио:

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

Затем опрашивайте через generations.retrieve:

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

Используйте Idempotency-Key для боевых запросов на запись. SDK открывает это как idempotencyKey.

Загрузка файлов

Используйте files.upload для справочных изображений, видео или аудио:

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

Используйте files.retrieve, чтобы снова прочитать метаданные загрузки:

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

Когда используете файл в генерации, передайте возвращенные публичные поля через 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
      }
    ]
  }
});

Проверка кредитов

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

Управление вебхуками

Создайте 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 возвращается только после вызовов создания или ротации. Храните его на своем сервере.

Другие помощники вебхуков:

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

Проверяйте подписи доставок, прежде чем доверять полезной нагрузке вебхука:

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 использует тот же контракт HMAC-SHA256, который описан в API-вебхуках.

Chat

Используйте chat.completions.create для одного хода 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);

Продолжайте с возвращенным 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."
});

Читайте сессии, созданные через API:

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

Используйте chat.completions.stream, чтобы читать Server-Sent Events как асинхронный итератор:

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 предназначен только для отображения. Зафиксированный результат доступен после message.completed, а позже его можно прочитать через chat.sessions.retrieve.

Ошибки

SDK выбрасывает RivyaAPIError для ответов Public API не из диапазона 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 включает HTTP-статус, публичный код ошибки, сообщение, request id при наличии и безопасное подмножество заголовков ответа.

Валидация

Запустите проверки SDK, прежде чем считать изменение завершенным:

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

pnpm sdk:check включает статическую проверку контракта и runtime-проверку без сети для разбора ошибок, безопасных error headers, idempotency headers, Bearer auth, публичного списка моделей, Chat streaming SSE parsing, событий ошибок Chat streaming и проверки подписи webhook.

Rivya TypeScript SDK