songs2vid/docs/README.md

13 lines
612 B
Markdown
Raw Normal View History

# Songs2VID OSS documentation
This folder ships with the OSS repo so API reference stays available without the docs site.
| Doc | Contents |
|-----|----------|
| [API overview](./api/overview.md) | Auth, rate limits, recommended flows, discovery (`layoutTemplates`, `compositionFamilies`) |
| [API endpoints](./api/endpoints.md) | curl examples for upload, jobs, layouts (incl. lower-corner templates), playlists, errors |
Live docs (same product truth for self-host): [docs.songs2vid.com](https://docs.songs2vid.com)
Setup and env: see the root [README](../README.md) and [`.env.example`](../.env.example).