Skip to main content
GET
Get a prompt

Authorizations

Authorization
string
header
required

An API key created in Settings → Account → API Keys.

Path Parameters

siteId
string
required
promptId
string
required

Response

promptId
string<uuid>
required

The prompt id carried by prompt-results, narratives, and claims.

text
string
required
Example:

"What should I look for when choosing car insurance?"

category
string | null
required
Example:

"general"

enabled
boolean
required

True for an active question; false for a retained, retired question.

tags
string[]
required
Example:
products
object[]
required
personas
object[]
required
journeyStages
object[]
required
primaryJourneyStage
object | null
required
regions
string[]
required

Saved per-question region selection. An empty list inherits scan defaults, then Global when defaults are also empty. This is not a list of effective execution regions.