API overview
User Interviews
user-interview
Plan who to interview, what to ask, and how to turn conversations into product decisions.
Pricing & runtime
- Current price
- 25 Credits per run
- Timeout
- up to 1200s
- 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. |
| stage | short_text | Optional | StagePre-launch / beta / live. |
| icp_hypothesis | long_text | Optional | ICP hypothesisWho you think the customer is. |
| interview_goal | select | Optional | GoalWeights the program.Options: PMF validation, Churn analysis, Beta program, Feature priority |
| user_pool | long_text | Optional | User poolPaying / active / churned / competitor-user counts, or a usage-top list. |
| weekly_capacity | short_text | Optional | Weekly capacityInterviews you can run per week. |
| transcripts | long_text | Optional | Past transcriptsOptional paste — enables card synthesis and pattern aggregation. |
| 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": "user-interview",
"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).