Plans
API overview

Onboarding Optimization

onboarding-optimization

Redesign post-signup onboarding around time-to-value: define the aha moment, cut friction, and sequence one-goal sessions.

Pricing & runtime

Current price
25 Credits per run
Timeout
up to 900s
Brand Context
Optional — pass a brand_context_id

Prices are calibrated against real run costs and may change — the credit_cost returned when creating a run is authoritative.

Input parameters

Pass these under the input object of POST /api/v1/runs.

KeyTypeRequiredLabel & description
product_descriptionshort_textRequiredProductWhat the product is.
current_funnellong_textOptionalCurrent funnelSteps from signup to value, with drop points.
activation_evidencelong_textOptionalRetention evidenceWhat retained users do that churned users don't.
audience_contextshort_textOptionalAudienceWho signs up.
constraintsshort_textOptionalConstraintsScope and tone limits.
interaction_languageselectOptionalReport languageControls the language of the generated report.Options: English, Chinese

Request example

Covers every required field. Optional fields follow the same pattern.

curl -X POST https://api.TODO-APP-DOMAIN/api/v1/runs \
  -H "Authorization: Bearer $SUPAMARKETERS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "app_slug": "onboarding-optimization",
  "input": {
    "product_description": "example text"
  }
}'

What you get back

A 201 response returns run_no, credit_cost, stream_url and result_url (relative paths). Stream progress from stream_url and fetch the terminal result — summary and output — from result_url. Results stay available for the App's retention window (30 days by default).