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 a technical recommendation against a specific URL: inserts an Action Engine card and records the action so its 30-day citation impact can be measured. The recommendation is the deliverable — Citable doesn’t auto-apply edits to your CMS. The user applies the fix in their own CMS, then marks it done. Technical actions are persona-agnostic, so the persona-intent matrix is skipped.

​
When to use

  • A scan shows a specific URL is losing on prompts where competitors win, AND a structural fix would help.
  • The user asks “what should I change on /page-x to get cited more?”

​
When not to use

​
Inputs

  • subtype (string, 1–40 chars, required) — category of fix. Common values:
    • 'schema_markup' — add JSON-LD (Product / FAQ / Article / Organization)
    • 'faq_block' — add an FAQ section to capture the FAQPage rich result
    • 'tldr_summary' — add a 2–3 sentence summary at the top of the page
    • 'canonical_fix' — set rel=canonical or consolidate duplicate URLs
    • 'eeat_signal' — author byline, credentials, last-updated date
    • 'comparison_block' — side-by-side comparison table vs cited competitors
  • target_url (URL, required) — the page the recommendation applies to.
  • title (string, 1–200 chars, required) — one-line summary of the change.
  • description (string[], 1–20 items, each ≤500 chars, required) — step-by-step instructions.
  • effort_minutes (number, 5–480, default 30) — estimated implementer effort.
  • priority ('low' | 'medium' | 'high' | 'critical', default 'medium').
  • target_prompt_ids (number[], optional) — tracked prompts this recommendation expects to win.

​
Response

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

​
Example

Recommend adding FAQ JSON-LD to a comparison landing page that’s losing on three buyer-stage prompts: 
{
  "subtype": "schema_markup",
  "target_url": "https://example.com/vs/competitor-x",
  "title": "Add FAQPage JSON-LD to /vs/competitor-x",
  "description": [
    "Open the page template in your CMS.",
    "Paste the JSON-LD block (provided below) into the <head>.",
    "Confirm in Google's Rich Results Test that FAQPage is detected.",
    "Republish the page."
  ],
  "effort_minutes": 25,
  "priority": "high",
  "target_prompt_ids": [1902, 1908, 1911]
}