Skip to main content

​
Base URL

EnvironmentURL
Localhttp://localhost:8090/v1
Productionhttps://api.lavendly.ai/v1
All paths in this reference are relative to that base.

​
Conventions

  • JSON only. Both directions, UTF-8.
  • Errors use a single standardized envelope: { error: { code, message, ...extra } }. See Errors.
  • Idempotency is opt-in via the Idempotency-Key header on POSTs that cost money or create entities. Same key within 5 min → same response.
  • Versioning is in the path (/v1). Breaking changes get a new prefix; additive changes (new endpoint, new optional field) ship in /v1.

​
The 23 operations

The server exposes a self-describing catalog at GET /v1/_schema, fetch it once, discover every operation, body shape, and idempotency flag.
list_workflows, get_workflow, create_workflow, update_workflow, delete_workflow
get_workflow_audio, set_clip_native_audio, attach_track, update_track, detach_track
create_render, get_render, list_renders, list_all_renders
get_ledger, reserve_credits, commit_reserve, refund_reserve
get_monthly_usage, get_top_spenders, get_status, get_schema, update_render (canvas-only)