Створіть API-ключ, виберіть модель, надішліть асинхронну задачу генерації та відправте один хід Chat API з необов'язковим потоковим передаванням SSE.

Цей швидкий старт показує найкоротший безпечний шлях від налаштування акаунта до однієї задачі генерації Rivya API, а також першого ходу Chat API.

У документації та прикладах використовуйте ключі-заповнювачі. Ніколи не вставляйте справжній API-ключ у публічний код, скриншоти, тікети або спільні документи.

Приклади описують реалізований контракт Public API v1. До перевірки переконайтеся, що доступ до Public API ввімкнено в розгортанні й відкрито вашому акаунту. Документована кінцева точка або сторінка моделі сама по собі не доводить, що запит виконається в кожному середовищі.

1. Створіть API-ключ

Відкрийте налаштування API-ключів, створіть ключ, один раз скопіюйте повний секрет і збережіть його в серверному середовищі.

Рекомендовані перші scope:

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

2. Підтвердьте базовий URL

Використовуйте основну адресу API для робочого середовища:

https://rivya.ai

Адреси localhost призначені лише для локальної розробки. У публічних прикладах не слід використовувати локальні секрети.

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": "Чисте редакційне зображення товару на м’якому студійному тлі"
  }'

Відповідь повертає публічний ідентифікатор завдання. Збережіть його, щоб пізніше опитувати стан.

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-запити, створіть кінцеву точку вебхука:

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 з відповіді й перевіряйте кожну доставку, перш ніж довіряти корисному навантаженню.

8. Необов'язково: надішліть хід Chat

Для chat-моделей викликайте Chat API замість POST /api/v1/generations:

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": "claude-sonnet-5-chat",
    "message": "Склади стислий план запуску нової кампанії із зображеннями товару"
  }'

Використовуйте повернений session_id, щоб продовжити сесію, створену через API. Вкладення зображень мають посилатися на значення file_id з Files API.

Необов'язково: використайте TypeScript SDK Beta

Серверні інтеграції TypeScript можуть використовувати локальну бета-версію SDK:

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: "Чисте редакційне зображення товару на м’якому студійному тлі"
});

Перед впровадженням прочитайте Rivya TypeScript SDK. Серверна підтримка потокового передавання Chat перебуває в закритій бета-версії SDK.

Швидкий старт Rivya API