API overview
Customer Research
customer-research
Turn your own research assets and live community signal into ranked customer insights and a primary-research plan.
Pricing & runtime
- Current price
- 25 Credits per run
- Timeout
- up to 1500s
- 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. |
| research_goal | select | Optional | Research goalWeights the program.Options: Problem discovery, Voice of customer, Win-loss, ICP refinement |
| research_questions | long_text | Optional | Research questionsWhat you need to learn, phrased as the questions you want answered. |
| target_audience | short_text | Optional | Target audienceWho the customer is. |
| existing_assets | long_text | Optional | Own materialsYour own transcripts, survey exports, or review exports. |
| online_mining | select | Optional | Community miningEnabled mines public community signal for you.Options: Enabled, Disabled |
| 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": "customer-research",
"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).