Tekintsd át a Rivya API v1 sémaforrásait, kompatibilitási szabályait, nyilvános mezőit és csak olvasható OpenAPI JSON szerződését.

A Rivya API v1 csak olvasható séma szerződést tesz közzé itt:

https://rivya.ai/api/v1/openapi.json

Ez az útvonal nyilvános szerződéskimenet. Nem olvas felhasználói munkamenet-adatokat, nem küld be modellfeladatokat, és nem tesz közzé privát fiókadatokat.

Szerződésforrások

A szerződés ezekből származik:

nyilvános API request sémák
nyilvános hibakódok
a nyilvános API modellreferencia rétege
ugyanaz a modellkatalógus, amelyet a /api/v1/models használ

A modelllista dinamikus. Ne építs olyan integrációt, amely kézzel írt modell-darabszámtól függ.

Verziószabályzat

A jelenlegi API-verzió v1.

Visszafelé kompatibilis változások lehetnek:

modell hozzáadása a /api/v1/models listához
opcionális válaszmező hozzáadása
opcionális request paraméter hozzáadása egy modellhez
új nyilvános hibakód hozzáadása

Törő változásokhoz új verzió vagy dokumentált migrációs út szükséges.

Nyilvános mezőhatár

A nyilvános séma mezői nyilvános neveket használnak:

id
status
model
session_id
message
usage
reserved_credits
final_credits
created_at
updated_at
result
error

Ne támaszkodj belső task-tárolási mezőkre. Ezek nem részei a nyilvános szerződésnek.

Request séma

A POST /api/v1/generations ezt fogadja:

model: kötelező nyilvános modellazonosító
prompt: opcionális string, sok modellnél kötelező
params: opcionális objektum modell-specifikus paraméterekkel
client_request_id: opcionális string saját trace ID-hoz

Modell-specifikus params mezőkhöz használd a Modell API referenciát.

A /api/v1/files által visszaadott referenciamédia a params.referenceMediaItems mezőbe tartozik. A séma dokumentálja az url, kind, opcionális name, opcionális mimeType, opcionális durationSeconds és opcionális durationToken mezőket. A Rivya nem fogad el felső szintű files mezőt a POST /api/v1/generations kérésben.

A POST /api/v1/files multipart form adatot fogad file, kind, opcionális model és opcionális client_request_id mezőkkel. A válasz PublicApiFile. A GET /api/v1/files/{fileId} ugyanazokat a nyilvános fájlmetaadatokat adja vissza az API-fiók tulajdonában lévő fájlokhoz.

A POST /api/v1/chat/completions model, message, opcionális session_id, opcionális vezérlők, opcionális Files API file_id csatolmányok és opcionális client_request_id mezőt fogad. Egy teljes, nem streamelt asszisztensüzenetet ad vissza.

A POST /api/v1/chat/completions/stream ugyanazt a request sémát fogadja, és text/event-stream választ ad session.created, message.delta, message.completed, usage.completed, heartbeat, error és done eseményekkel. A Chat API v1 nem fogad nyers messages tömböt.

Válaszsémák

Az OpenAPI kimenet ezeket a nyilvános válaszalakokat dokumentálja:

ModelList a GET /api/v1/models híváshoz
PublicApiModel és ModelParam modellválasztáshoz és paraméterűrlapokhoz
PublicApiFile a POST /api/v1/files és GET /api/v1/files/{fileId} hívásokhoz
ReferenceMediaItem fájlalapú generálási paraméterekhez
PublicGeneration létrehozási és állapotválaszokhoz
GenerationResult és GenerationError befejezett feladatokhoz
ChatCompletionRequest, ChatCompletion, ChatSession, ChatMessage, ChatUsage, ChatCredits és Chat stream eseménysémák a Chat API-hoz
CreditBalance a GET /api/v1/credits híváshoz
WebhookEndpoint, WebhookEvent, WebhookDelivery és WebhookTestResult aláírt API webhookokhoz
PublicApiError stabil hibaválaszokhoz

A séma biztonságosan használható kliensoldali validáláshoz és belső integrációs tesztekhez. A TypeScript SDK beta ezt a sémát követi.

Példairányítás

Az ezekben a dokumentumokban szereplő curl, JavaScript és Python példák ugyanazokat a nyilvános mezőneveket használják, mint a séma:

Authorization: Bearer rvya_sk_...
Idempotency-Key
model
prompt
message
session_id
params
client_request_id

A Chat példák emellett ezeket használják:

chat:create
chat:read
file_id

A webhook példák emellett ezeket használják:

Rivya-Webhook-Signature
Rivya-Webhook-Timestamp
webhooks:manage

Amikor egy modellparaméter változik, először a modellkatalógust és a nyilvános szerializálót frissítsd. A dokumentációnak és a debuggernek ugyanazt a nyilvános réteget kell fogyasztania, nem külön táblát másolnia.

OpenAPI és séma szerződés