list_prompts
Lists all prompts associated with your account, including their current status, schedule configuration, and the timestamp of their last run.string
Optional domain ID to filter prompts to a specific tracked domain.
get_prompt
Returns full details for a single prompt, including its text, brand configuration, schedule, and active status.string
required
The ID of the prompt to retrieve.
list_runs
Lists execution runs for a given prompt, sorted most recent first. Each run represents one round of querying across all configured LLM providers.string
required
The ID of the prompt whose runs you want to list.
number
default:"20"
Maximum number of runs to return. Accepted range: 1–100.
number
default:"0"
Number of runs to skip for pagination.
get_run
Returns full details for a single prompt run, including raw LLM responses from each provider and brand mention analyses.string
required
The ID of the run to retrieve.
string
Unique identifier for this run.
object[]
Array of responses from each LLM provider, including the raw text and provider name.
object[]
Parsed brand mention analysis for each LLM result, including mention type, position, and sentiment.
string
ISO 8601 timestamp when the run finished.
create_prompt
Creates a new prompt and associates it with a domain. You can optionally configure a cron schedule for recurring runs and specify a locale for geographic targeting.string
required
The ID of the domain this prompt belongs to.
string
required
A short, human-readable label for the prompt (e.g. “Best CRM for startups”).
string
required
The full question text that will be sent to LLMs (e.g. “What is the best CRM software for early-stage startups?”).
string
required
The brand name to detect in LLM responses (e.g. “Acme CRM”).
string
Optional brand domain used to detect citations (e.g.
acmecrm.com).string
Optional cron expression for recurring runs (e.g.
0 9 * * 1 for every Monday at 9am UTC).string
Optional locale code for geographic targeting (e.g.
en-GB).update_prompt
Updates one or more fields on an existing prompt. All fields exceptpromptId are optional — only the fields you provide will be changed.
string
required
The ID of the prompt to update.
string
New display name for the prompt.
string
Updated question text sent to LLMs.
string
Updated brand name to detect in responses.
string
Updated brand domain for citation detection.
string
Updated cron schedule. Pass an empty string (
"") to remove the existing schedule.boolean
Set to
false to pause the prompt without deleting it.delete_prompt
Soft-deletes a prompt. The prompt is removed from active scheduling and no longer appears in listings, but all historical runs and analytics data are preserved.string
required
The ID of the prompt to delete.
trigger_prompt_run
Manually triggers an immediate run for a prompt outside of its scheduled cadence. The run executes asynchronously across all configured LLM providers. Uselist_runs or get_run to check the result once it completes.
string
required
The ID of the prompt to run immediately.
string
The ID of the newly created run. Use this with
get_run to retrieve results once the run completes.