---
title: "Experience Events"
method: POST
path: "/v1/experience/events"
tags: ["experience"]
---

# Experience Events

`POST /v1/experience/events`

## Request

- Base URL: `https://api.lyricpatch.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.lyricpatch.com/v1/experience/events`
- Auth: HTTP bearer

## Headers

- `x-dev-user-id` string, nullable
- `x-dev-email` string, nullable

## Request body

- EventsInput
  - `session_id` string, uuid, required
  - `consent` boolean, required
  - `device` 'desktop' | 'mobile' | 'tablet' | 'unknown'
  - `events` EventInput[], required
    - `id` string, uuid, required
    - `name` 'page_view' | 'screen_view' | 'upload_started' | 'upload_completed' | 'upload_failed' | 'selection_loaded' | 'generation_requested' | 'generation_ready' | 'generation_failed' | 'preview_played' | 'preview_listened' | 'preview_failed' | 'take_accepted' | 'take_undone' | 'retry_requested' | 'export_requested' | 'export_ready' | 'download_clicked' | 'feedback_submitted' | 'help_requested' | 'checkout_pack_selected' | 'checkout_started' | 'checkout_returned' | 'checkout_failed' | 'transcription_requested' | 'transcription_ready' | 'transcription_failed' | 'generation_request_failed' | 'export_failed', required
    - `project_id` string, uuid, nullable
    - `generation_id` string, uuid, nullable
    - `duration_ms` integer, nullable
    - `error_category` 'network' | 'timeout' | 'playback' | 'invalid_input' | 'insufficient_credits' | 'verification_or_access' | 'not_found' | 'conflict' | 'rate_limited' | 'unavailable' | 'request_failed' | 'unsupported_language', nullable
    - `reason` 'wrong_words' | 'voice_changed' | 'timing' | 'audio_quality' | 'too_slow' | 'confusing' | 'payment_problem' | 'price' | 'just_trying' | 'other', nullable
    - `surface` 'dashboard' | 'editor' | 'preview' | 'download' | 'pricing' | 'agent_workspace' | 'account' | 'help' | 'other', nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/lyricpatch/apis/lyricpatch-api.md) · [All operations](https://skmtc.dev/lyricpatch/apis/lyricpatch-api/llms.txt) · [OpenAPI document](https://skmtc.dev/lyricpatch/apis/lyricpatch-api/revisions/307fbddfa9b0?raw)