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
feedback:writeSend 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 charsRequired when authentication does not provide an account email. Trimmed and stored privately; never added to Discord notifications. Authenticated account email takes precedence.
messagestringrequired1–2000 charsFeedback text. The service trims whitespace before storage and Discord forwarding.
typestringdefault "general"One of
bugfeaturegeneralimprovementsourcestring2–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.
successtruerequiredmessagestringrequiredidstringrequiredInserted 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"
}'const response = await fetch(`https://lyricwinter.com/api/v1/feedback`, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.LYRICWINTER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"message": "string"
}),
});
const { data, error, request_id } = await response.json();import os
import requests
response = requests.request(
"POST",
f"https://lyricwinter.com/api/v1/feedback",
headers={
"Authorization": f"Bearer {os.environ['LYRICWINTER_API_KEY']}",
},
json={
"message": "string"
},
)
payload = response.json(){
"data": {
"success": true,
"message": "string",
"id": "8f14e45f-ceea-4e7a-9c2d-3b1a5f2e7c10"
},
"request_id": "req_01J9Z3K8QF4"
}