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

Этот быстрый старт показывает самый короткий безопасный путь от настройки аккаунта до одной задачи генерации Rivya API, а также первый ход Chat API.

Используйте в документации и примерах только ключи-заполнители. Никогда не вставляйте реальный API-ключ в публичный код, скриншоты, тикеты или общие документы.

1. Создайте API-ключ

Откройте настройки API Keys, создайте ключ, один раз скопируйте полный секрет и сохраните его в серверном окружении.

Рекомендуемые первые scopes:

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

2. Подтвердите Base URL

Используйте production base URL API:

https://rivya.ai

URL 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": "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. Необязательно: добавьте вебхуки

Если ваш сервер может принимать подписанные HTTPS-колбэки, создайте 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 из ответа и проверяйте каждую доставку, прежде чем доверять полезной нагрузке.

8. Необязательно: отправьте ход чата

Для моделей чата вызывайте 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": "gpt-5-2-chat",
    "message": "Write a concise launch plan for a new product image campaign"
  }'

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

Необязательно: используйте TypeScript SDK beta

Серверные интеграции на TypeScript могут использовать локальную beta 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: "A clean editorial product image on a soft studio background"
});

Перед внедрением прочитайте Rivya TypeScript SDK. SDK включает серверную поддержку стриминга Chat в закрытой beta-версии.

Быстрый старт Rivya API