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

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

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

Τα παραδείγματα περιγράφουν την υλοποιημένη σύμβαση του δημόσιου API v1. Πριν από τη δοκιμή, επιβεβαιώστε ότι η πρόσβαση στο δημόσιο API είναι ενεργοποιημένη για την εγκατάσταση και διατίθεται στον λογαριασμό σας. Ένα τεκμηριωμένο τελικό σημείο ή μια σελίδα μοντέλου δεν αποδεικνύουν από μόνα τους ότι ένα αίτημα μπορεί να εκτελεστεί σε κάθε περιβάλλον.

1. Δημιουργία κλειδιού API

Ανοίξτε τις ρυθμίσεις κλειδιών API, δημιουργήστε ένα κλειδί, αντιγράψτε ολόκληρο το μυστικό μία φορά και αποθηκεύστε το στο περιβάλλον του διακομιστή σας.

Προτεινόμενα αρχικά πεδία πρόσβασης:

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

2. Επιβεβαίωση βασικού URL

Χρησιμοποιήστε το βασικό 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": "Μια καθαρή συντακτική εικόνα προϊόντος σε απαλό φόντο στούντιο"
  }'

Η απόκριση επιστρέφει ένα δημόσιο αναγνωριστικό εργασίας. Αποθηκεύστε το ώστε να μπορείτε να ελέγξετε αργότερα την κατάσταση.

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

Αν η πρόσβαση στα webhooks είναι ενεργοποιημένη για την εγκατάσταση και τον λογαριασμό, και ο διακομιστής σας μπορεί να λάβει υπογεγραμμένες επιστροφές HTTPS, δημιουργήστε ένα τελικό σημείο webhook:

curl https://rivya.ai/api/v1/webhooks \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Webhook παραγωγής",
    "url": "https://example.com/rivya/webhook",
    "event_types": ["generation.succeeded", "generation.failed"]
  }'

Αποθηκεύστε το signing_secret, το οποίο εμφανίζεται μία φορά στην απόκριση, και επαληθεύετε κάθε παράδοση πριν εμπιστευτείτε το ωφέλιμο φορτίο.

8. Προαιρετικά: Στείλτε έναν γύρο συνομιλίας

Για μοντέλα συνομιλίας, καλέστε το 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 από το API αρχείων.

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

Οι ενσωματώσεις 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: "Μια καθαρή συντακτική εικόνα προϊόντος σε απαλό φόντο στούντιο"
});

Διαβάστε το SDK TypeScript του Rivya πριν το υιοθετήσετε. Στην ιδιωτική δοκιμαστική έκδοση, το SDK υποστηρίζει τμηματική μετάδοση συνομιλίας στην πλευρά του διακομιστή.

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