Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getcitable.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What it does

Emits an operational recommendation — a configuration or setup change the brand should make to improve their AI visibility footprint: enable an additional AI engine, add a journey stage, register a new channel account, calibrate a persona, raise the prompts-per-stage budget. The user reviews and accepts in the web UI; the accepted change flips the underlying brand setting. Operational actions are persona-agnostic, so the persona-intent matrix is skipped.

​
When to use

  • A scan shows a coverage gap — e.g., only ChatGPT is enabled when competitors are also winning on Perplexity.
  • The user asks “what should I set up next?”

​
When not to use

​
Inputs

  • subtype (string, 1–40 chars, required) — category of change. Common values:
    • 'enable_model' — recommend enabling an additional AI engine in scans
    • 'add_persona' — recommend adding a new audience persona
    • 'add_competitor' — recommend a competitor to track
    • 'calibrate_persona' — recommend a persona-calibration tune
    • 'expand_journey' — recommend adding a journey stage to scans
    • 'add_brand_account' — recommend a channel account to connect
  • title (string, 1–200 chars, required) — one-line summary.
  • description (string[], 1–20 items, each ≤500 chars, required) — step-by-step instructions.
  • effort_minutes (number, 1–120, default 15).
  • priority ('low' | 'medium' | 'high' | 'critical', default 'medium').
  • config_target (object, optional) — JSON describing the proposed setting change, useful for future auto-apply. Example: 
    { "setting": "scan_models", "value_add": ["perplexity"] }

​
Response

{
  "actionId": 8720,
  "taskId": 4485,
  "deepLinkUrl": "https://app.getcitable.com/actions/4485",
  "validation": { "status": "allowed" }
}

​
Example

Recommend enabling Perplexity because competitors are winning citations there: 
{
  "subtype": "enable_model",
  "title": "Enable Perplexity in scan models",
  "description": [
    "Go to Settings → Scan Config.",
    "Check the Perplexity box in 'Models scanned'.",
    "Save. The next nightly scan will include Perplexity prompts.",
    "Review the new model's results in Brand Visibility after 24h."
  ],
  "effort_minutes": 5,
  "priority": "high",
  "config_target": {
    "setting": "scan_models",
    "value_add": ["perplexity"]
  }
}