Δημιουργήστε ένα API key, επιλέξτε μοντέλο, υποβάλετε μια ασύγχρονη εργασία δημιουργίας και στείλτε έναν γύρο Chat API με προαιρετικό SSE streaming.

Αυτός ο οδηγός γρήγορης εκκίνησης δείχνει τη συντομότερη ασφαλή διαδρομή από τη ρύθμιση λογαριασμού έως μία εργασία δημιουργίας μέσω Rivya API, μαζί με τον πρώτο γύρο Chat API.

Χρησιμοποιήστε placeholder keys στα έγγραφα και στα παραδείγματα. Μην επικολλάτε ποτέ πραγματικό API key σε δημόσιο κώδικα, στιγμιότυπα οθόνης, tickets ή κοινόχρηστα έγγραφα.

1. Δημιουργία API Key

Ανοίξτε τις ρυθμίσεις API Keys, δημιουργήστε ένα key, αντιγράψτε το πλήρες secret μία φορά και αποθηκεύστε το στο server-side environment σας.

Προτεινόμενα πρώτα scopes:

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

2. Επιβεβαίωση Base URL

Χρησιμοποιήστε το production API base URL:

https://rivya.ai

Τα localhost URLs προορίζονται μόνο για τοπική ανάπτυξη. Τα δημόσια παραδείγματα δεν πρέπει να χρησιμοποιούν τοπικά secrets.

3. Λίστα μοντέλων

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

Χρησιμοποιήστε το πεδίο id από την απόκριση ως τιμή model όταν δημιουργείτε μια εργασία generation.

4. Υποβολή generation

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

Η απόκριση επιστρέφει ένα δημόσιο task ID. Αποθηκεύστε το ώστε να μπορείτε να κάνετε poll για την κατάσταση αργότερα.

5. Poll κατάστασης

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

Οι τιμές κατάστασης είναι:

queued
processing
succeeded
failed

6. Έλεγχος credits

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

Χρησιμοποιήστε το για να επιβεβαιώσετε το τρέχον υπόλοιπο λογαριασμού πριν ή μετά τη δοκιμή.

7. Προαιρετικά: Προσθήκη webhooks

Αν ο server σας μπορεί να λάβει υπογεγραμμένα HTTPS callbacks, δημιουργήστε ένα 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"]
  }'

Αποθηκεύστε το one-time signing_secret από την απόκριση και επαληθεύετε κάθε delivery πριν εμπιστευτείτε το payload.

8. Προαιρετικά: Αποστολή Chat turn

Για chat models, καλέστε το 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 για να συνεχίσετε το session που δημιουργήθηκε μέσω API. Τα συνημμένα εικόνας πρέπει να αναφέρουν τιμές file_id από το Files API.

Προαιρετικά: Χρήση του TypeScript SDK Beta

Οι server-side TypeScript integrations μπορούν να χρησιμοποιήσουν το τοπικό 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 περιλαμβάνει server-side Chat streaming support στο private beta.

Γρήγορη εκκίνηση του Rivya API