# Documentation

## Docs

- [Orvyn Public API](/): One stable API for live avatar sessions — create a session, connect the stream, end it. REST control plane, WebSocket media, generated OpenAPI reference.
- [Quickstart](/quickstart): Get from zero to a live avatar session in five minutes — create the session, connect the stream, end it.
- [API versioning](/versioning): The /v1/ convention — what the prefix means, what stability it promises, and how future versions will work.

## Guides

- [Authentication](/guides/authentication): API keys for the control plane, short-lived WebSocket tokens for the media stream — what to use where, and how to handle both safely.
- [Session lifecycle](/guides/session-lifecycle): What happens when you create a session — states, ownership, ending semantics, and how to recover from conflicts.
- [WebSocket & fMP4 media](/guides/websocket-fmp4): The media WebSocket — connection, token auth, fMP4 streaming to MSE, message catalog, and the conversational turn lifecycle.
- [Errors, limits & security](/guides/errors-limits-security): The error envelope, retry guidance, rate limits, and the security rules every integration must follow.

## Concepts

- [Provider concepts](/concepts/provider-concepts): How provider configuration works — what you own, what the platform owns, and why credentials never touch the frontend.

## Reference

- [AVTR Public API v1](/reference)

### API Keys

- [Create an API key](/reference/api-keys/post-v1-api-keys)
- [Revoke an API key](/reference/api-keys/delete-v1-api-keys-key-id)

### Sessions

- [Create AND start a session](/reference/sessions/post-v1-sessions)
- [End session (canonical V0)](/reference/sessions/post-v1-sessions-session-id-end)
- [Get session status](/reference/sessions/get-v1-sessions-session-id)
- [Mint a fresh short-lived client token (canonical V0)](/reference/sessions/post-v1-sessions-session-id-client-token)