Skip to main content

Documentation Index

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

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

​
MCP Tools Reference

The Citedy MCP server exposes 59 tools. Each tool maps to an Agent API endpoint. Endpoint: https://mcp.citedy.com/mcp

​
Social Adaptations

ToolDescriptionEndpoint
adapt.generateGenerate social adaptations for an article.POST /api/agent/adapt

​
Account & Status

ToolDescriptionEndpoint
agent.healthReturn infrastructure health checks for agent platform.GET /api/agent/health
agent.meReturn agent profile, balances and limits.GET /api/agent/me
agent.statusReturn actionable operational status snapshot (credits, socials, schedule, knowledge, content).GET /api/agent/status

​
Content Creation

ToolDescriptionEndpoint
article.deletePermanently delete an article and its associated storage files.DELETE /api/agent/articles/{id}
article.generateGenerate an SEO-optimized article. By default publishes immediately; set auto_publish=false to create as draft. May take 30-90 seconds.POST /api/agent/autopilot
article.getPoll a queued article job by id. Use the id returned by article.generate to get the current status or the final generated article result.GET /api/agent/articles/{id}
article.listList previously generated articles for the current workspace.GET /api/agent/articles
article.publishPublish a draft article. Use after generating with auto_publish=false to trigger the publish pipeline.POST /api/agent/articles/{id}/publish
article.unpublishUnpublish an article (revert to draft status). The article remains accessible for editing but is removed from the public blog.PATCH /api/agent/articles/{id}

​
brand

ToolDescriptionEndpoint
brand.scanRun AI brand visibility scan across major LLM providers (async, poll with brand.scan.get).POST /api/agent/tools/brand-scan
brand.scan.getGet brand scan status and final result payload by scan ID.GET /api/agent/tools/brand-scan/{id}

​
Competitor Analysis

ToolDescriptionEndpoint
competitors.discoverDiscover competitors by keyword set.POST /api/agent/competitors/discover
competitors.scoutAnalyze a competitor domain.POST /api/agent/competitors/scout

​
Intelligence & Research

ToolDescriptionEndpoint
gaps.generateGenerate SEO/GEO content gap opportunities.POST /api/agent/gaps/generate
gaps.listList saved content gaps. Optional favorite_id filter scopes results to a product/identity (hybrid filter also includes legacy NULL gaps matching favorite.domain). Optional limit (1-100, default 100).GET /api/agent/gaps

​
gsc

ToolDescriptionEndpoint
gsc.reportGet Google Search Console performance report: clicks, impressions, CTR, avg position, top queries, top pages, position movers, content opportunities, and article suggestions. Returns connect URL if GSC is not linked. Free (0 credits).GET /api/agent/gsc/report

​
Content Ingestion

ToolDescriptionEndpoint
ingest.batchCreate ingestion jobs in batch mode for multiple URLs.POST /api/agent/ingest/batch
ingest.content.getFetch extracted content payload for a completed ingestion job.GET /api/agent/ingest/{id}/content
ingest.createCreate an ingestion job from a source URL.POST /api/agent/ingest
ingest.getGet ingestion job status/result by ID.GET /api/agent/ingest/{id}

​
Lead Magnets

ToolDescriptionEndpoint
leadmagnet.archiveArchive a lead magnet by ID.PATCH /api/agent/lead-magnets/{id}
leadmagnet.generateStart lead magnet generation (checklist/swipe/framework) and return polling instructions.POST /api/agent/lead-magnets
leadmagnet.getFetch lead magnet status/result by ID.GET /api/agent/lead-magnets/{id}
leadmagnet.publishPublish a lead magnet by ID.PATCH /api/agent/lead-magnets/{id}

​
Personas

ToolDescriptionEndpoint
personas.listList available writing personas.GET /api/agent/personas

​
Product Knowledge

ToolDescriptionEndpoint
products.createUpload product knowledge document.POST /api/agent/products
products.deleteDelete product knowledge document by ID.DELETE /api/agent/products/{id}
products.listList product knowledge documents.GET /api/agent/products
products.searchSearch product knowledge documents.POST /api/agent/products/search

​
Scheduling

ToolDescriptionEndpoint
schedule.gapsList schedule gaps for upcoming days.GET /api/agent/schedule/gaps
schedule.listList upcoming article/post/social schedule timeline.GET /api/agent/schedule

​
Trend Scouting

ToolDescriptionEndpoint
scout.redditRun Reddit scout analysis. Returns processing status — poll scout.reddit.result for results.POST /api/agent/scout/reddit
scout.reddit.resultGet Reddit scout run status and results by run ID.GET /api/agent/scout/reddit/{runId}
scout.xRun X/Twitter scout analysis. Returns processing status — poll scout.x.result for results.POST /api/agent/scout/x
scout.x.resultGet X scout run status and results by run ID.GET /api/agent/scout/x/{runId}

​
seo

ToolDescriptionEndpoint
seo.headings.checkAnalyze heading hierarchy (H1-H6) for a page.POST /api/agent/tools/headings
seo.internal_links.planPlan internal linking opportunities from source URL and target URLs/sitemap.POST /api/agent/tools/internal-links
seo.links.analyzeAnalyze internal/external links and link attributes.POST /api/agent/tools/links
seo.meta_tags.checkAnalyze meta tags for a target page URL.POST /api/agent/tools/meta-tags
seo.og_image.generateGenerate an Open Graph image artifact and return hosted URL for brand assets.POST /api/agent/tools/og-image
seo.og.previewExtract Open Graph and Twitter card preview metadata.POST /api/agent/tools/og-preview
seo.robots.checkCheck robots.txt availability and parsed directives.POST /api/agent/tools/robots
seo.schema.validateValidate JSON-LD schema markup for a page.POST /api/agent/tools/schema-validate
seo.sitemap.checkCheck sitemap availability and robots sitemap hints.POST /api/agent/tools/sitemap

​
Autopilot Sessions

ToolDescriptionEndpoint
session.createCreate and start an autopilot session.POST /api/agent/session

​
Settings

ToolDescriptionEndpoint
settings.getGet current agent settings.GET /api/agent/settings
settings.updateUpdate the editable subset of current agent settings used by Quick Publish defaults.PUT /api/agent/settings

​
Video (Shorts)

ToolDescriptionEndpoint
shorts.avatarGenerate an AI avatar image for shorts and return hosted avatar URL.POST /api/agent/shorts/avatar
shorts.generateGenerate shorts video and return poll instructions until final video URL is ready.POST /api/agent/shorts
shorts.getGet shorts generation status/result by ID.GET /api/agent/shorts/{id}
shorts.mergeMerge 2-4 short clips, apply subtitle phrases, and return final video URL.POST /api/agent/shorts/merge
shorts.publishPublish a generated short video directly to supported short-video platforms including YouTube Shorts, Instagram Reels, and TikTok. Does not require an article — derives title/description/hashtags from speech_text via LLM. Publication is free on all platforms (per product decision 2026-04-15). Returns per-platform results and timings.POST /api/agent/shorts/publish
shorts.scriptGenerate short-form video script text (hook/educational/cta styles).POST /api/agent/shorts/script

​
Publishing

ToolDescriptionEndpoint
social.publishPublish, schedule, cancel, or direct-publish (as-is, no AI adaptation) social content.POST /api/agent/publish

​
Webhooks

ToolDescriptionEndpoint
webhooks.deleteDelete a webhook endpoint by ID.DELETE /api/agent/webhooks/{id}
webhooks.deliveriesList webhook delivery attempts.GET /api/agent/webhooks/deliveries
webhooks.listList webhook endpoints for current agent.GET /api/agent/webhooks
webhooks.registerRegister webhook endpoint for agent events.POST /api/agent/webhooks

​
Async Operations

These tools may return "status": "processing" and polling instructions:
  • article.generate -> poll with article.get using id
  • brand.scan -> poll with brand.scan.get using id
  • ingest.batch -> poll with ingest.get using id
  • ingest.create -> poll with ingest.get using id
  • leadmagnet.generate -> poll with leadmagnet.get using id
  • scout.reddit -> poll with scout.reddit.result using runId
  • scout.x -> poll with scout.x.result using runId
  • shorts.generate -> poll with shorts.get using id