levrops-contracts 1.3.4 → 1.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -217,6 +217,22 @@ All endpoints are under `/api/v1/editorial/`:
|
|
|
217
217
|
- `examples/editorial/instagram-channel.json` - Example channel
|
|
218
218
|
- `examples/editorial/fashion-topic.json` - Example topic
|
|
219
219
|
|
|
220
|
+
## Audio Generation (Platform) Contracts
|
|
221
|
+
|
|
222
|
+
Platform-level capability for **audio generation**: short generated audio from contextual inputs (chords, text, concepts). Reusable by any LevrOps surface (constellation, education, meditation, game cues, coaching, etc.). Product surface constructs a request → LevrOps executes generation → provider produces audio.
|
|
223
|
+
|
|
224
|
+
**Schema Files:**
|
|
225
|
+
- `schemas/audio_generation_enums.json` - AudioGenerationStatus, Mood, HarmonicMode, Density, EnergyCurve (guidance)
|
|
226
|
+
- `schemas/audio_generation_request.json` - Request (sourceType, experienceType, sourceRef, inputs, preset, mood, durationMs, options, metadata, optional **guidance**)
|
|
227
|
+
- `schemas/audio_generation.json` - AudioGenerationResult (generationId, status, audioUrl, durationMs, etc.)
|
|
228
|
+
- `schemas/audio_generation_regenerate_request.json` - Regenerate by generationId with optional overrides
|
|
229
|
+
- `schemas/audio_generation_error.json` - Structured error (invalid_request, source_not_eligible, provider_unavailable, generation_failed, asset_missing)
|
|
230
|
+
- `schemas/events/audio_generation.*.json` - Events: requested, completed, failed, replayed, regenerated
|
|
231
|
+
|
|
232
|
+
**Events (AsyncAPI):** `audio_generation.requested`, `audio_generation.completed`, `audio_generation.failed`, `audio_generation.replayed`, `audio_generation.regenerated`
|
|
233
|
+
|
|
234
|
+
**Guidance:** Optional `guidance` object on the request provides lightweight hints (harmonicMode, tempoHintBpm, density, energyCurve, instrumentFocus, negativeDirectives) for music-aware or scene-aware use cases without polluting the top-level schema. Fully optional; providers may partially honor. See `docs/audio-generation-contracts.md` for request/result shapes, guidance field reference, examples, and migration notes.
|
|
235
|
+
|
|
220
236
|
## Versioning
|
|
221
237
|
|
|
222
238
|
- Use semantic versioning for the repo (`VERSION`) and the TypeScript SDK.
|