Community & Ambassadors

community-ambassador

Decide whether a community program is ready and design its setup, ambassadors, activities, health checks, and governance.

Pricing & runtime

Current price: 25 Credits per run
Timeout: up to 2400s
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.

Key	Type	Required	Label & description
product_description	short_text	Required	ProductWhat the product is.
product_stage	short_text	Optional	StageCold start / early growth / scaling / leader.
community_goal	select	Optional	Community goalWhat the community is for.Options: Acquisition, Retention, UGC supply, Support load, Regional reach
current_community_status	long_text	Optional	Current communityPlatform, members, weekly actives.
target_audience	short_text	Optional	AudienceDevelopers / B2B / consumer / open-source.
resources	short_text	Optional	ResourcesStaffing share and monthly budget.
region_focus	short_text	Optional	RegionTarget countries and languages.
existing_ambassadors	long_text	Optional	Existing ambassadorsCount, activity, churn signals.
interaction_language	select	Optional	Report 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": "community-ambassador",
  "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).