Developer docs / v1
One request. One finished story.
Send anonymous activity statistics. Konveri selects the strongest story beats and returns a hosted, mobile-first recap URL.
Quickstart
Create an API key from your authenticated workspace, then submit the same data shape used in the sandbox. Keep keys server-side.
curl -X POST https://konveri.com/api/v1/recaps \
-H "Authorization: Bearer rcp_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"user_id": "athlete_4821",
"recap_type": "monthly",
"stats": {
"workouts": 23, "distance": 143, "previous_month_distance": 102,
"longest_activity": 18, "personal_records": 2,
"percentile_distance": 91, "streak": 14
}
}'Request
user_id is your anonymous customer-defined identifier. Do not send names or email addresses.
recap_type accepts monthly, milestone, or annual.
stats requires seven non-negative numeric fields shown in the example. percentile_distance ranges from 0 to 100.
Branding
Set a logo URL or uploaded-file reference plus six-digit primary and accent hex colors in workspace settings. Konveri snapshots that workspace branding when an API recap is generated, so an existing hosted story remains stable if settings later change. Blank settings safely use Konveri defaults.
Usage
Production API recaps require an active plan and count as generated recaps per billing month: Developer 10,000, Startup 50,000, Growth 150,000, or Scale 400,000. The sandbox is no-card, free, and evaluation-only—not production capacity. Choose or review a plan in billing.
Response
A successful request returns HTTP 201 with a stable recap ID and the hosted URL for sharing.
const response = await fetch("/api/v1/recaps", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.RECAPLY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify(payload),
});
const recap = await response.json();
// { recap_id: "rcp_…", hosted_url: "https://…/r/rcp_…" }Statistics, not identity
Konveri is designed for anonymous identifiers and activity statistics. Sandbox recaps expire after 30 days; API recaps expire after 90 days. Read the privacy overview.
Operational privacy note
Konveri is designed to process anonymous customer-defined IDs and activity statistics; end-user names and email addresses are not needed for recap generation. We aim to minimize the information involved and retain recaps only for their intended product window. For practical questions, visit Konveri support.