Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.scrunch.com/llms.txt

Use this file to discover all available pages before exploring further.

The Configuration API lets you manage Scrunch brands at scale.
It is most commonly used by:
  • Agencies onboarding dozens or hundreds of clients
  • Enterprise teams automating persona and keyword setup
  • Internal tools (brand creation, batch updates, auditing)

​
What you can configure

​
Brands

  • Name, alternative names
  • Website + alternative websites
  • Competitors
  • Personas
  • Key topics

​
Prompts

  • Text
  • Stage
  • Tags
  • Personas
  • Platforms

​
Example: Create a brand

curl -X POST "https://api.scrunchai.com/v1/brands" \
  -H "Authorization: Bearer $SCRUNCH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Spirit Airlines",
    "website": "https://spirit.com",
    "description": "Low cost air carrier."
  }'

​
Example: Add a prompt

curl -X POST "https://api.scrunchai.com/v1/1234/prompts" \
  -H "Authorization: Bearer $SCRUNCH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "What are the best budget airlines?",
    "tags": ["budget"],
    "platforms": ["chatgpt", "perplexity"]
  }'

​
Listing prompts

GET /{brand_id}/prompts returns active prompts by default. Pass the status query parameter to include archived prompts:
ValueReturns
active (default)Currently tracked prompts
archivedSoft-deleted prompts only
allBoth active and archived
# All prompts including archived ones
curl "https://api.scrunchai.com/v1/$BRAND_ID/prompts?status=all" \
  -H "Authorization: Bearer $SCRUNCH_API_KEY"
Each prompt in the response includes:
  • branded — true if the prompt mentions the brand
  • favorite — true if marked as a favorite in the dashboard
  • status — active or archived
GET /{brand_id}/prompts/{prompt_id} returns archived prompts as well, so check the status field if you only want active ones.

​
Notes

To update prompt text, delete the old prompt and create a new one. Only tags and platforms can be updated in-place.

See all configuration endpoints

Explore the API reference →