API Changelog

This page records public Rivya API changes that affect developers.

2026-05-11

Initial API documentation set for Rivya API v1:

• API overview
• quickstart
• authentication
• OpenAPI and schema contract
• API model list
• dynamic model API reference
• generation submission
• generation status polling
• credit balance
• errors and limits
• Files API for reference uploads
• API webhooks for signed generation completion events
• non-streaming and streaming Chat API with API-created sessions

The current API version covers asynchronous image, video, and audio generation through API keys and account credits. It also includes Files API uploads for model reference media, signed webhooks for terminal generation events, and Chat API turns with non-streaming or SSE streaming responses.

Current Endpoint Surface

• GET /api/v1/models
• POST /api/v1/generations
• POST /api/v1/files
• POST /api/v1/chat/completions
• GET /api/v1/chat/sessions
• GET /api/v1/chat/sessions/{sessionId}
• GET /api/v1/generations/{taskId}
• GET /api/v1/credits
• GET /api/v1/webhooks
• POST /api/v1/webhooks
• GET /api/v1/webhooks/{endpointId}
• PATCH /api/v1/webhooks/{endpointId}
• DELETE /api/v1/webhooks/{endpointId}
• POST /api/v1/webhooks/{endpointId}/rotate-secret
• GET /api/v1/webhook-events
• GET /api/v1/webhooks/{endpointId}/deliveries
• POST /api/v1/webhooks/{endpointId}/test
• GET /api/v1/openapi.json

Not Open Yet

These surfaces are not part of the current callable API:

• Chat webhook events
• official SDKs

Compatibility Notes

The model list can change as Rivya adds, removes, or gates models. Use /api/v1/models or Model API Reference instead of relying on a fixed count.

Related Pages

• Rivya API Overview
• OpenAPI and Schema Contract
• Model API Reference
• API Errors and Limits