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 a workspace and Konveri API Key from your authenticated dashboard, then submit the same data shape used in the sandbox. New workspaces include 10 live API recap credits during their 14-day evaluation period. 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 or pseudonymous customer-defined identifier. Do not send names, email addresses, or other direct identifiers.
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
The 10 evaluation recap credits are for validating an integration. The sandbox is no-card and free.
Beyond those credits, API recaps require an active plan and count per billing month: Developer 10,000, Startup 50,000, Growth 150,000, or Scale 400,000. 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.KONVERI_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify(payload),
});
const recap = await response.json();
// { recap_id: "rcp_…", hosted_url: "https://…/r/rcp_…" }Minimize each payload
Send only the activity statistics needed for the recap and an anonymous or pseudonymous ID. Do not include direct identifiers, medical records, diagnosis information, or other unnecessary health data.
Sandbox recaps and associated events are scheduled for permanent removal after 30 days. API recap records, hosted artifacts, and associated events are scheduled for permanent removal after 90 days. Workspace owners can delete their workspace's API recap data and access from settings. Read the privacy overview.
Operational privacy note
Konveri is designed to process anonymous or pseudonymous customer-defined IDs and limited activity statistics; end-user names and email addresses are not needed for recap generation. For privacy, DPA, or subprocessor questions, contact support@konveri.com.