API overview
Brand Context
brand-context
Research a company domain and draft a reusable Brand Context document: positioning, audience, competitors, voice, and a Search & AI Visibility Profile.
Pricing & runtime
- Current price
- 5 Credits per run
- Timeout
- up to 1500s
- Brand Context
- Not supported by this App
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 |
|---|---|---|---|
| domain | short_text | Required | DomainBare hostname only, for example example.com. |
| report_language | select | Required | Report languageControls the language of the generated report.Options: English, Chinese |
| target_markets | long_text | Optional | Target marketsEnter one market per line, or separate items with commas. |
| languages | long_text | Optional | Site languagesEnter one language per line, or separate items with commas. |
| known_competitors | long_text | Optional | Known competitorsEnter one competitor domain per line, or separate items with commas. |
| off_limits | long_text | Optional | Off limitsTopics, claims, or competitors the report must avoid. |
| extra_notes | long_text | Optional | Extra notesAnything else the researcher should know about this brand. |
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": "brand-context",
"input": {
"domain": "example text",
"report_language": "option-id"
}
}'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).