Zkontrolujte zdroje schématu Rivya API v1, pravidla kompatibility, veřejná pole a pouze čtecí kontrakt OpenAPI JSON.

Rivya API v1 vystavuje pouze čtecí kontrakt schématu zde:

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

Tato route je výstup veřejného kontraktu. Nečte data uživatelských relací, neodesílá modelové úlohy a nezpřístupňuje soukromá data účtu.

Zdroje kontraktu

Kontrakt je odvozen z:

veřejných schémat API požadavků
veřejných chybových kódů
veřejné vrstvy reference modelů API
stejného katalogu modelů, který používá /api/v1/models

Seznam modelů je dynamický. Nevytvářejte integrace závislé na ručně napsaném počtu modelů.

Pravidla verzování

Aktuální verze API je v1.

Zpětně kompatibilní změny mohou zahrnovat:

přidání modelu do /api/v1/models
přidání volitelného pole odpovědi
přidání volitelného parametru požadavku pro model
přidání nového veřejného chybového kódu

Nekompatibilní změny vyžadují novou verzi nebo zdokumentovanou migrační cestu.

Hranice veřejných polí

Veřejná pole schématu používají veřejné názvy:

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

Nespoléhejte na interní pole úložiště úloh. Nejsou součástí veřejného kontraktu.

Schéma požadavku

POST /api/v1/generations přijímá:

model: povinné veřejné ID modelu
prompt: volitelný řetězec, který mnoho modelů vyžaduje
params: volitelný objekt s parametry specifickými pro model
client_request_id: volitelný řetězec pro vaše vlastní trace ID

Modelově specifické params najdete v referenci modelového API.

Referenční média vrácená z /api/v1/files patří do params.referenceMediaItems. Schéma dokumentuje url, kind, volitelné name, volitelné mimeType, volitelné durationSeconds a volitelné durationToken. Rivya nepřijímá top-level pole files v POST /api/v1/generations.

POST /api/v1/files přijímá multipart form data s file, kind, volitelným model a volitelným client_request_id. Odpověď je PublicApiFile. GET /api/v1/files/{fileId} vrací stejná veřejná metadata souboru pro soubory vlastněné API účtem.

POST /api/v1/chat/completions přijímá model, message, volitelné session_id, volitelné ovládací prvky, volitelné přílohy Files API file_id a volitelné client_request_id. Vrací jednu kompletní nestreamovanou zprávu asistenta.

POST /api/v1/chat/completions/stream přijímá stejné schéma požadavku a vrací text/event-stream s událostmi session.created, message.delta, message.completed, usage.completed, heartbeat, error a done. Chat API v1 nepřijímá raw pole messages.

Schémata odpovědí

Výstup OpenAPI dokumentuje tyto veřejné tvary odpovědí:

ModelList pro GET /api/v1/models
PublicApiModel a ModelParam pro výběr modelu a formuláře parametrů
PublicApiFile pro POST /api/v1/files a GET /api/v1/files/{fileId}
ReferenceMediaItem pro parametry generování podložené soubory
PublicGeneration pro odpovědi při vytvoření a čtení stavu
GenerationResult a GenerationError pro dokončené úlohy
ChatCompletionRequest, ChatCompletion, ChatSession, ChatMessage, ChatUsage, ChatCredits a schémata událostí chatového streamu pro Chat API
CreditBalance pro GET /api/v1/credits
WebhookEndpoint, WebhookEvent, WebhookDelivery a WebhookTestResult pro podepsané API webhooky
PublicApiError pro stabilní chybové odpovědi

Schéma je bezpečné používat pro validaci klienta a interní integrační testy. Beta TypeScript SDK zůstává omezená tímto schématem.

Správa příkladů

Příklady curl, JavaScript a Python v těchto dokumentech používají stejné veřejné názvy polí jako schéma:

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

Příklady pro Chat navíc používají:

chat:create
chat:read
file_id

Příklady webhooků navíc používají:

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

Když se změní parametr modelu, nejprve aktualizujte katalog modelů a veřejný serializer. Dokumentace a debugger by měly používat stejnou veřejnou vrstvu místo kopírování samostatné tabulky.

OpenAPI a kontrakt schématu