Skip to main content
Prompts are the AI search queries that Topify.ai tracks. Each prompt is sent daily to all AI providers, and responses are analyzed for brand visibility.

List prompts (manage view)

GET /api/v2/prompts/projects/:project_id/prompts/manage

Get all prompts grouped by topic, split into active and suggested.
Query parameters:
ParamTypeDescription
user_idstring (UUID)Your user ID
Response: Topic-grouped prompt list with per-prompt metrics (visibility, sentiment, position, volume).

Create prompt

POST /api/v2/prompts

Add a new active prompt to the project.
Request body:
FieldTypeRequiredDescription
project_idstring (UUID)YesTarget project
prompt_textstringYesThe AI search query (10—2,000 characters)
countrystringNoTarget country for localized responses
topic_idstring (UUID)NoTopic to assign the prompt to

Update prompt

PATCH /api/v2/prompts/:prompt_id

Update a prompt’s text, topic assignment, or active status.

Delete prompt

DELETE /api/v2/prompts/:prompt_id

Remove a prompt from the project.

Batch operations

POST /api/v2/prompts/batch

Perform bulk operations on multiple prompts (e.g., batch delete).

Generate suggestions

POST /api/v2/prompts/suggested

Generate AI-powered prompt suggestions for a project.
Suggestions are based on your brand context, industry, and existing prompt coverage. Generated prompts appear in the “Suggested” tab for you to review.

Import from research

POST /api/v2/prompts/import-from-research

Import prompts from keyword research data into the project.

Prompt analytics

For per-prompt drill-down analytics (metrics, domains, URLs, AI responses), see the prompt detail endpoints:
EndpointDescription
GET /api/v2/prompt/:id/analyticsAggregated metrics for a prompt (visibility, sentiment, position, volume)
GET /api/v2/prompt/:id/domainsDomains cited in responses to this prompt
GET /api/v2/prompt/:id/urlsURLs cited in responses
GET /api/v2/prompt/:id/chatsRaw AI responses for this prompt
GET /api/v2/prompt/:id/domains/:domain/citationsCitation detail for a specific domain
GET /api/v2/prompt/:id/domains/:domain/chatsAI responses that cited a specific domain
All analytics endpoints support duration_days and provider query parameters for filtering.