Skip to content

API reference

Feedback API

Send product feedback with screenshots and other images so our team can see what you mean.

BetaUpdated

Base URL
https://lyricwinter.com/api/v1
Authentication
Authorization: Bearer lw_…
Contract
openapi.json

Send feedback and images

POST/feedback

Scope feedback:write

Send feedback text as JSON, or use multipart/form-data to attach up to five PNG, JPEG, or WebP images by repeating the images field. Each image can be up to 5 MiB, with 15 MiB total and 32 megapixels per image. Screenshots can include circles or other annotations. Images are stored privately with your feedback. Sign in to use your account email, or supply replyEmail so our team can reply.

Request body application/json

  • replyEmailstringemailmax 254 chars

    Required when authentication does not provide an account email. Trimmed and stored privately; never added to Discord notifications. Authenticated account email takes precedence.

  • messagestringrequired1–2000 chars

    Feedback text. The service trims whitespace before storage and Discord forwarding.

  • typestringdefault "general"

    One ofbugfeaturegeneralimprovement

  • sourcestring2–64 charspattern ^[a-z][a-z0-9_]*$default "global"

    Stable identifier for the originating product surface and client.

Response 201

Feedback was stored. Discord forwarding is best-effort and not reflected in this response. Fields below are inside data.

  • successtruerequired
  • messagestringrequired
  • idstringrequired

    Inserted feedback row id.

Errors 400, 401, 429, 500, 503 use the standard error envelope.

curl -X POST "https://lyricwinter.com/api/v1/feedback" \
  -H "Authorization: Bearer $LYRICWINTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "string"
}'
Response 201 (example)
{
  "data": {
    "success": true,
    "message": "string",
    "id": "8f14e45f-ceea-4e7a-9c2d-3b1a5f2e7c10"
  },
  "request_id": "req_01J9Z3K8QF4"
}