SCscrunchai

Get Prompt

Changed on

Returns a single prompt by its ID, including all associated metadata such as platforms, tags, and topics. Paused and archived prompts are returned with their lifecycle status; check the field if you only want active ones.

get/{brand_id}/prompts/{prompt_id}

Request

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

Path parameters

brand_idinteger required

The unique identifier for the brand

prompt_idinteger required

The unique identifier for the prompt

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

  • 10f2a17e0cd2Revision changes
    • warning

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