# Velora Documentation

## Docs

- [Authentication](https://docs.velora.crickdevs.com/velora-api/authentication.md): How to authenticate requests to the Velora API using x-api-key and how keys are managed.
- [Endpoint reference](https://docs.velora.crickdevs.com/velora-api/endpoints.md): Velora public API endpoint catalog sourced from the app API documentation model.
- [Examples](https://docs.velora.crickdevs.com/velora-api/examples.md): Practical cURL examples for common Velora API operations.
- [Velora API](https://docs.velora.crickdevs.com/velora-api/index.md): Public Velora API overview, authentication model, and endpoint domains.
- [Authorization flow](https://docs.velora.crickdevs.com/velora-local-api/authorization-flow.md): Registration, consent, request status polling, token usage, and permission rules for the Velora local API.
- [Errors and security](https://docs.velora.crickdevs.com/velora-local-api/errors-and-security.md): Error codes, localhost restrictions, token behavior, and operational safeguards for the Velora local API.
- [Velora local API](https://docs.velora.crickdevs.com/velora-local-api/index.md): Localhost-only API for the Velora desktop app, including registration, token auth, playback reads, and playback controls.
- [Read endpoints](https://docs.velora.crickdevs.com/velora-local-api/read-endpoints.md): Auth requirements and response shapes for Velora local API read operations.
- [WebSocket](https://docs.velora.crickdevs.com/velora-local-api/websocket.md): Real-time event stream for the Velora local API.
- [Write endpoints](https://docs.velora.crickdevs.com/velora-local-api/write-endpoints.md): Playback control endpoints in the Velora local API that require write permission.

## OpenAPI Specs

- [openapi](https://docs.velora.crickdevs.com/api-reference/openapi.json)