API overview
UGC Matrix
ugc-matrix
Build a repeatable creator-content program with clear roles, formats, incentives, publishing, and safety checks.
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. |
| use_cases | long_text | Optional | Core use casesEnter one use case per line, or separate items with commas. |
| target_market | short_text | Optional | Target marketDecides the entry order. |
| main_platform | select | Optional | Main platformWhere the matrix lives first.Options: Short video (TikTok-style), Instagram, YouTube, Threads, Red-note style |
| budget_note | short_text | Optional | Budget & goalsBudget + creator-count target. |
| ip_account_status | long_text | Optional | IP account statusExisting IP/brand account? The flywheel start point. |
| winning_format | long_text | Optional | Winning formatA proven format, or empty = include a validation program. |
| brand_guardrails | long_text | Optional | GuardrailsContent no-go zones and tone. |
| competitor_notes | long_text | Optional | Competitors to tear downEnables the teardown module. |
| 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": "ugc-matrix",
"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).