Gå gjennom Rivya API v1-schema-kilder, kompatibilitetsregler, offentlige felt og den skrivebeskyttede OpenAPI JSON-kontrakten.

Rivya API v1 eksponerer en skrivebeskyttet schema-kontrakt på:

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

Denne ruten er et offentlig kontraktsoutput. Den leser ikke brukerøktdata, sender ikke inn modelljobber og eksponerer ikke private kontodata.

Kontraktskilder

Kontrakten er avledet fra:

offentlige API request schemas
offentlige feilkoder
det offentlige API-laget for modellreferanse
samme modellkatalog som brukes av /api/v1/models

Modellisten er dynamisk. Ikke bygg integrasjoner som avhenger av et manuelt skrevet modellantall.

Versjonspolicy

Den nåværende API-versjonen er v1.

Bakoverkompatible endringer kan inkludere:

å legge til en modell i /api/v1/models
å legge til et valgfritt responsfelt
å legge til en valgfri request-parameter for en modell
å legge til en ny offentlig feilkode

Breaking changes krever en ny versjon eller en dokumentert migreringsvei.

Grense for offentlige felt

Offentlige schema-felt bruker offentlige navn:

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

Ikke avheng av interne felt for oppgavelagring. De er ikke del av den offentlige kontrakten.

Request schema

POST /api/v1/generations godtar:

model: påkrevd offentlig modell-ID
prompt: valgfri streng, påkrevd av mange modeller
params: valgfritt objekt med modellspesifikke parametere
client_request_id: valgfri streng for din egen trace ID

Bruk modell-API-referanse for modellspesifikke params.

Referansemedier returnert av /api/v1/files hører hjemme i params.referenceMediaItems. Schemaet dokumenterer url, kind, valgfri name, valgfri mimeType, valgfri durationSeconds og valgfri durationToken. Rivya godtar ikke et toppnivåfelt kalt files i POST /api/v1/generations.

POST /api/v1/files godtar multipart form data med file, kind, valgfri model og valgfri client_request_id. Responsen er PublicApiFile. GET /api/v1/files/{fileId} returnerer samme offentlige filmetadata for filer som eies av API-kontoen.

POST /api/v1/chat/completions godtar model, message, valgfri session_id, valgfrie kontroller, valgfrie Files API-vedlegg med file_id og valgfri client_request_id. Det returnerer én komplett ikke-streamende assistentmelding.

POST /api/v1/chat/completions/stream godtar samme request schema og returnerer text/event-stream med hendelsene session.created, message.delta, message.completed, usage.completed, heartbeat, error og done. Chat API v1 godtar ikke en rå messages-array.

Response schemas

OpenAPI-outputet dokumenterer disse offentlige responsformene:

ModelList for GET /api/v1/models
PublicApiModel og ModelParam for modellvalg og parameterskjemaer
PublicApiFile for POST /api/v1/files og GET /api/v1/files/{fileId}
ReferenceMediaItem for filstøttede genereringsparametere
PublicGeneration for opprettelses- og statusresponser
GenerationResult og GenerationError for fullførte oppgaver
ChatCompletionRequest, ChatCompletion, ChatSession, ChatMessage, ChatUsage, ChatCredits og Chat stream event schemas for Chat API
CreditBalance for GET /api/v1/credits
WebhookEndpoint, WebhookEvent, WebhookDelivery og WebhookTestResult for signerte API-webhooks
PublicApiError for stabile feilresponser

Schemaet er trygt å bruke til klientvalidering og interne integrasjonstester. TypeScript SDK beta holder seg innenfor dette schemaet.

Eksempelstyring

curl-, JavaScript- og Python-eksemplene i disse dokumentene bruker de samme offentlige feltnavnene som schemaet:

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

Chat-eksempler bruker i tillegg:

chat:create
chat:read
file_id

Webhook-eksempler bruker i tillegg:

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

Når en modellparameter endres, oppdater modellkatalogen og den offentlige serializeren først. Dokumentasjonen og debuggeren bør bruke det samme offentlige laget i stedet for å kopiere en separat tabell.

OpenAPI- og schema-kontrakt