API キーを作成し、モデルを選び、非同期生成ジョブを送信し、任意の SSE ストリーミングつきで Chat API ターンを送信します。

このクイックスタートでは、アカウント設定から 1 件の Rivya API 生成ジョブまでの最短で安全な手順と、最初の Chat API ターンを示します。

ドキュメントと例ではプレースホルダーキーを使ってください。実際の API キーを公開コード、スクリーンショット、チケット、共有ドキュメントに貼り付けないでください。

1. API キーを作成する

API Keys settings を開き、キーを作成し、完全なシークレットを一度だけコピーして、サーバー側の環境に保存します。

最初のスコープとして推奨されるもの:

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

2. Base URL を確認する

本番 API base URL を使います。

https://rivya.ai

localhost URL はローカル開発専用です。公開例ではローカル secret を使わないでください。

3. モデルを一覧する

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

生成を作成するときは、応答の id フィールドを model 値として使います。

4. 生成を送信する

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

応答は公開タスク ID を返します。後でステータスをポーリングできるよう保存してください。

5. ステータスをポーリングする

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

ステータス値は次のとおりです。

queued
processing
succeeded
failed

6. クレジットを確認する

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

テスト前後に現在のアカウント残高を確認するために使えます。

7. 任意: Webhooks を追加する

サーバーが署名付き HTTPS コールバックを受け取れる場合は、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"]
  }'

応答に一度だけ表示される signing_secret を保存し、payload を信頼する前にすべての delivery を検証してください。

8. 任意: Chat ターンを送信する

チャットモデルでは、POST /api/v1/generations ではなく Chat API を呼び出します。

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

返された session_id を使って、API 作成セッションを続行します。画像添付は Files API の file_id 値を参照する必要があります。

任意: TypeScript SDK Beta を使う

サーバー側 TypeScript 統合では、ローカル SDK beta を使えます。

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

採用する前に Rivya TypeScript SDK を読んでください。SDK には private beta のサーバー側 Chat streaming 対応が含まれます。

Rivya API クイックスタート