Skip to main content
POST
Create Prompt
Creates a new prompt under a specific topic. Optionally triggers an immediate query run across the selected AI platforms.

Parameters

string
required
Bearer token. Format: Bearer slat_<your-token>.
boolean
Set to true to start a live query run on each of the prompt’s platforms right after creating it. Default: false.
number
required
Brand ID for the prompt. topicId must belong to this brand.
number
required
ID of the topic this prompt belongs to. Must reference an active topic in your workspace that belongs to brandId.
string
required
The prompt text to track. Maximum 4000 characters. Another prompt in the workspace can’t have the same text.
string[]
required
AI platforms to query. One or more of: CHATGPT, PERPLEXITY, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, CLAUDE.
string
Cron expression defining the query schedule (e.g., 0 0 * * * for daily). Omit to create a prompt without a schedule.
string
Timezone for the cron schedule (e.g., UTC, America/New_York). Default: UTC.
boolean
Whether the prompt is active. Default: true.
string
ISO 3166-1 alpha-2 country code for location-specific results (e.g., US, GB, IN). Must be exactly two letters.

Response

Returns 200 OK with the new prompt. When run=true, the response is an object with three fields instead: prompt (the new prompt, with the fields below), runIds (IDs of the started query runs), and status (running).
number
required
Unique identifier for the prompt.
number
required
Topic ID the prompt belongs to.
string
required
The prompt text.
string[]
required
Target AI platforms.
string
Cron schedule expression. null if the prompt has no schedule.
string
required
Schedule timezone.
boolean
required
Whether the prompt is active.
string
Country code for location filtering. null if not set.
string
Next run time stored on the prompt. ISO 8601 format. null in the create response.
string
Last run time stored on the prompt. ISO 8601 format. null if not set.

Example

Response

Status codes

What’s next