SCscrunchai

Create Prompt

Changed on

Creates a new prompt with variants for the specified platforms. Requires the configure scope.

Behavior:

  • Auto-categorizes the journey stage using an LLM if not provided
  • Creates variants for each specified platform
  • Reactivates an archived prompt if a duplicate exists
  • Dispatches collection events to begin tracking
post/{brand_id}/prompts

Request

  • Base URL
    https://api.scrunchai.com/v1
  • Auth
    HTTP bearer

Path parameters

brand_idinteger required

Request body

textstring required

The prompt text to track across AI platforms

persona_idinteger nullable

Optional persona ID to associate with this prompt for segmented analysis

stagestring nullable

The customer journey stage this prompt represents. Must be the name of one of the brand's active stages (custom stage names included); omit to auto-categorize with an LLM against the brand's stage definitions. Default sets:

  • Advice - Seeking recommendations or guidance
  • Awareness - Exploring a topic or problem space
  • Evaluation - Assessing specific options
  • Comparison - Comparing multiple options
  • Other - Doesn't fit other categories
tagsstring[]

Custom tags for categorizing and filtering prompts

key_topicsstring[]

Key topics to associate with this prompt from the brand's topic list

languagestring nullable

Lowercase ISO 639-1 code of the language the prompt text is written in (e.g. pt). If omitted, the language is detected from the text, falling back to the brand's default language.

platformsstring[]

AI platforms to track this prompt on. If empty, defaults to all supported platforms.

Supported platforms:

  • chatgpt - OpenAI ChatGPT
  • claude - Anthropic Claude
  • google_ai_overviews - Google AI Overviews (Search)
  • perplexity - Perplexity AI
  • meta - Meta AI
  • google_ai_mode - Google AI Mode
  • google_gemini - Google Gemini
  • copilot - Microsoft Copilot

Response

Successful Response

idinteger required

Unique identifier for the prompt

textstring required

The prompt text being tracked

stagestring required

The customer journey stage this prompt represents — one of the brand's stages (custom stage names included)

persona_idinteger nullable required

ID of the associated persona, if any

platformsstring[] required

AI platforms this prompt is tracked on

tagsstring[] required

Custom tags assigned to this prompt

topicsstring[] required

Auto-detected or assigned topics for this prompt

brandedboolean required

Whether this prompt explicitly mentions the brand

favoriteboolean required

Whether this prompt is marked as a favorite

status'active' | 'paused' | 'archived' required

Lifecycle status of the prompt (active, paused, or archived)

created_atstring date-time required

Timestamp when the prompt was created

Changes

  • fa6217fdd4e1Revision changes
    • warning

      added the new deepseek enum value to the / response property for the response status

    • info

      added the new deepseek enum value to the request property /

  • 10f2a17e0cd2Revision changes
    • warning

      added the new paused enum value to the response property for the response status