Get Prompts
List, create, update, and delete prompts for a brand. Prompts are the questions asked to AI models.
List Prompts
Returns all prompts for a brand. Use active_only=true to filter to only active prompts.
/get-brands.Query Parameters
brand_idstringrequiredBrand UUID from /get-brands
active_onlybooleanOnly return active prompts
Default: false
tag_idsstringComma-separated tag UUIDs to filter prompts by tag
limitintegerResults per page (1-500)
Default: 100
offsetintegerPagination offset
Default: 0
Create Prompt
Create a new prompt for tracking. New prompts are included in the next research run.
Body Parameters
brand_idstringrequiredBrand UUID
textstringrequiredPrompt text (max 500 characters)
activebooleanEnable tracking immediately
Default: true
focus_areastringTopic category (see enum below)
intentstringUser intent type (see enum below)
audiencestringTarget audience (see enum below)
Update Prompt
Update an existing prompt. Include prompt_id in the request body.
Delete Prompt
Delete a prompt. Historical data for this prompt will be retained.
Response Fields
Prompt Object
idstringUnique prompt identifier (UUID)
brand_idstringParent brand UUID
textstringThe prompt text sent to AI models
activebooleanWhether this prompt is being tracked
focus_areastringnullableTopic category
intentstringnullableUser intent type
audiencestringnullableTarget audience
specificityintegernullableHow specific (1-5)
quality_scoreintegernullableEffectiveness score (0-100)
sourcestring"generated", "manual", or "api"
created_atstringISO 8601 creation timestamp
updated_atstringISO 8601 last update timestamp
tagsarraynullableTags assigned to this prompt [{id, name, colour}]
Enum Values
focus_area
generalbudgetenterprisefeaturesuxintegrationscomparisonsindustrygeographictrendsintent
recommendationcomparisonalternativediscoverybest_foraudience
enterprisesmbconsumerdevelopergeneral