# Citedy

## Docs

- [Welcome to Citedy](https://www.citedy.com/docs/index.md): AI platform for SEO content automation and blog management
- [Quick Start](https://www.citedy.com/docs/quickstart.md): From zero to published in 5 minutes
- [Platform Overview](https://www.citedy.com/docs/platform/overview.md): Citedy Agent Platform — architecture, authentication, and capabilities
- [API Reference](https://www.citedy.com/docs/platform/api.md): Complete Agent API endpoint reference — methods, paths, auth, costs, and examples
- [Credit Pricing](https://www.citedy.com/docs/platform/billing.md): Pay-as-you-go credit packages and operation costs
- [Agent Settings](https://www.citedy.com/docs/platform/settings.md): Defaults the agent uses when parameters are not specified per request
- [MCP Integration](https://www.citedy.com/docs/mcp/overview.md): Connect to Citedy via Model Context Protocol
- [MCP Tools Reference](https://www.citedy.com/docs/mcp/tools.md): Complete list of 71 MCP tools available via the Citedy MCP server
- [Skills Overview](https://www.citedy.com/docs/skills/overview.md): Install focused Citedy skills via Smithery CLI
- [AI Content Writer](https://www.citedy.com/docs/skills/content-writer.md): From topic to published blog post in one conversation — generate SEO- and GEO-optimized articles with AI illustrations and voice-over in 55 languages, create social media adaptations for 9 platforms, set up automated content sessions, and manage product knowledge base. End-to-end blog autopilot. Pow…
- [Trend & Intent Scout](https://www.citedy.com/docs/skills/trend-scout.md): Find what your audience is searching for right now — scout X/Twitter and Reddit for trending topics, discover and deep-analyze competitors, and find content gaps. Combine social signals with SEO intelligence. Powered by Citedy.
- [Content Ingestion](https://www.citedy.com/docs/skills/content-ingestion.md): Turn any URL into structured content — YouTube videos (via Gemini Video API), web articles, PDFs, and audio files. Extract transcripts, summaries, and metadata for use in any LLM pipeline. Powered by Citedy.
- [Lead Magnet Generator](https://www.citedy.com/docs/skills/lead-magnets.md): Generate AI-powered lead magnets — checklists, swipe files, and frameworks that convert visitors into subscribers. PDF generation with optional AI illustrations. No competitors in any MCP/skill store. Powered by Citedy.
- [Citedy Video Shorts Producer](https://www.citedy.com/docs/skills/video-shorts.md): Stateful MCP-first producer for branded AI UGC shorts. Generates scripts, reuses brand/avatar memory, renders vertical talking-head videos, and optionally publishes to Instagram Reels and YouTube Shorts.
- [SEO Content Autopilot by Citedy](https://www.citedy.com/docs/skills/full-suite.md): Full-stack AI marketing toolkit — scout X/Twitter and Reddit for trending topics, discover and deep-analyze competitors, find content gaps, publish SEO- and GEO-optimized articles with AI illustrations and voice-over in 55 languages, create social media adaptations for X, LinkedIn, Facebook, Reddit,…
- [Skill Reference](https://www.citedy.com/docs/agents/skill-reference.md): MCP skill definition for AI agents — full command reference, workflows, and API details
- [Introduction](https://www.citedy.com/docs/api-reference/introduction.md): Interactive API documentation for the Citedy Agent Platform
- [Health check](https://www.citedy.com/docs/api-reference/health/health-check.md)
- [Approve pending registration](https://www.citedy.com/docs/api-reference/registration/approve-pending-registration.md): Flow A step 2. Requires authenticated tenant owner session (dashboard auth), not agent API key.
- [Check pending registration status](https://www.citedy.com/docs/api-reference/registration/check-pending-registration-status.md)
- [Create pending agent registration](https://www.citedy.com/docs/api-reference/registration/create-pending-agent-registration.md): Flow A: creates a pending registration and returns approval URL. No API key is returned here.
- [Get agent info, balance and limits](https://www.citedy.com/docs/api-reference/agent/get-agent-info-balance-and-limits.md)
- [Rotate current agent API key](https://www.citedy.com/docs/api-reference/agent/rotate-current-agent-api-key.md)
- [Get operational agent status](https://www.citedy.com/docs/api-reference/status/get-operational-agent-status.md): Returns actionable status snapshot for credits, social connections, schedule, knowledge base and content readiness.
- [Get agent preferences and configuration](https://www.citedy.com/docs/api-reference/settings/get-agent-preferences-and-configuration.md)
- [Set illustration style preset](https://www.citedy.com/docs/api-reference/settings/set-illustration-style-preset.md)
- [Update agent preferences (partial update)](https://www.citedy.com/docs/api-reference/settings/update-agent-preferences-partial-update.md)
- [List available personas](https://www.citedy.com/docs/api-reference/personas/list-available-personas.md)
- [Create micro-content post with social adaptations](https://www.citedy.com/docs/api-reference/autopilot/create-micro-content-post-with-social-adaptations.md)
- [Generate article](https://www.citedy.com/docs/api-reference/autopilot/generate-article.md): Generate an article from a topic or source URLs. Returns status 'publishing' when auto_publish is true (default) or 'generated' when auto_publish is false (draft mode). The final 'published' status is reflected in GET /api/agent/articles/{id} after the publish pipeline completes.
- [List articles](https://www.citedy.com/docs/api-reference/autopilot/list-articles.md)
- [Generate social adaptations](https://www.citedy.com/docs/api-reference/adaptations/generate-social-adaptations.md)
- [Create and start autopilot session](https://www.citedy.com/docs/api-reference/sessions/create-and-start-autopilot-session.md)
- [Publish, schedule, cancel, or direct-publish (as-is) social content](https://www.citedy.com/docs/api-reference/publishing/publish-schedule-cancel-or-direct-publish-as-is-social-content.md)
- [Get recommended posting time slots](https://www.citedy.com/docs/api-reference/schedule/get-recommended-posting-time-slots.md)
- [Get scheduled content timeline](https://www.citedy.com/docs/api-reference/schedule/get-scheduled-content-timeline.md)
- [Identify days with fewer posts than target](https://www.citedy.com/docs/api-reference/schedule/identify-days-with-fewer-posts-than-target.md)
- [Scan trends via xAI Grok (experimental)](https://www.citedy.com/docs/api-reference/scan/scan-trends-via-xai-grok-experimental.md): Search X/Twitter, web, and HackerNews for trending content. Credit cost: fast=2, deep=4, ultra=6.
- [Poll Reddit scout result](https://www.citedy.com/docs/api-reference/scout/poll-reddit-scout-result.md)
- [Poll X scout result](https://www.citedy.com/docs/api-reference/scout/poll-x-scout-result.md)
- [Run Reddit scout](https://www.citedy.com/docs/api-reference/scout/run-reddit-scout.md)
- [Run X/Twitter scout](https://www.citedy.com/docs/api-reference/scout/run-xtwitter-scout.md)
- [Generate content gaps](https://www.citedy.com/docs/api-reference/gaps/generate-content-gaps.md): Generate content gaps from competitor URLs. Optional `favorite_id` scopes the resulting gaps to a product/identity and uses `ai_favorites.domain` as the analysis target instead of the tenant blog domain. Cross-tenant `favorite_id` is rejected with 403 before credits are charged.
- [List content gaps](https://www.citedy.com/docs/api-reference/gaps/list-content-gaps.md): List saved content gaps. Optional `favorite_id` scopes results to a product/identity (hybrid filter keeps legacy NULL gaps visible via domain-match).
- [Analyze a competitor domain](https://www.citedy.com/docs/api-reference/competitors/analyze-a-competitor-domain.md)
- [Discover competitors by keywords](https://www.citedy.com/docs/api-reference/competitors/discover-competitors-by-keywords.md)
- [Delete product knowledge document by ID](https://www.citedy.com/docs/api-reference/products/delete-product-knowledge-document-by-id.md)
- [List product knowledge documents](https://www.citedy.com/docs/api-reference/products/list-product-knowledge-documents.md)
- [Search product knowledge documents](https://www.citedy.com/docs/api-reference/products/search-product-knowledge-documents.md)
- [Upload product knowledge document](https://www.citedy.com/docs/api-reference/products/upload-product-knowledge-document.md)
- [Batch create ingestion jobs](https://www.citedy.com/docs/api-reference/ingest/batch-create-ingestion-jobs.md): Returns 202 if at least one URL succeeded, 400 if all failed.
- [Create ingestion job](https://www.citedy.com/docs/api-reference/ingest/create-ingestion-job.md): Returns 202 for new jobs or 200 for cached results (dedup hit).
- [Download raw ingested content](https://www.citedy.com/docs/api-reference/ingest/download-raw-ingested-content.md): Streams the raw content file from R2 storage. Primary response is a binary octet-stream; some content types may return JSON.
- [List ingestion jobs](https://www.citedy.com/docs/api-reference/ingest/list-ingestion-jobs.md)
- [Poll ingestion job status](https://www.citedy.com/docs/api-reference/ingest/poll-ingestion-job-status.md)
- [Generate short-form video](https://www.citedy.com/docs/api-reference/shorts/generate-short-form-video.md): Starts short-form video generation and returns immediate processing status for polling.
- [Generate shorts avatar](https://www.citedy.com/docs/api-reference/shorts/generate-shorts-avatar.md)
- [Generate shorts script](https://www.citedy.com/docs/api-reference/shorts/generate-shorts-script.md)
- [Get shorts generation status by ID](https://www.citedy.com/docs/api-reference/shorts/get-shorts-generation-status-by-id.md)
- [Merge shorts videos and add subtitles](https://www.citedy.com/docs/api-reference/shorts/merge-shorts-videos-and-add-subtitles.md)
- [Publish short video to YouTube Shorts, Instagram Reels, and/or TikTok](https://www.citedy.com/docs/api-reference/shorts/publish-short-video-to-youtube-shorts-instagram-reels-andor-tiktok.md)
- [Generate lead magnet](https://www.citedy.com/docs/api-reference/lead-magnets/generate-lead-magnet.md)
- [Get lead magnet status/details](https://www.citedy.com/docs/api-reference/lead-magnets/get-lead-magnet-statusdetails.md)
- [Long-poll wait for lead magnet completion](https://www.citedy.com/docs/api-reference/lead-magnets/long-poll-wait-for-lead-magnet-completion.md): Hangs open up to 25s polling for generation completion. Call immediately after POST /lead-magnets. Returns full result when ready, progress on timeout, or error on failure.
- [Publish or archive lead magnet](https://www.citedy.com/docs/api-reference/lead-magnets/publish-or-archive-lead-magnet.md)
- [Delete webhook endpoint](https://www.citedy.com/docs/api-reference/webhooks/delete-webhook-endpoint.md)
- [List webhook delivery history](https://www.citedy.com/docs/api-reference/webhooks/list-webhook-delivery-history.md)
- [List webhook endpoints](https://www.citedy.com/docs/api-reference/webhooks/list-webhook-endpoints.md)
- [Register webhook endpoint](https://www.citedy.com/docs/api-reference/webhooks/register-webhook-endpoint.md)
- [Analyze heading hierarchy](https://www.citedy.com/docs/api-reference/seo-tools/analyze-heading-hierarchy.md)
- [Analyze page links](https://www.citedy.com/docs/api-reference/seo-tools/analyze-page-links.md)
- [Analyze page meta tags](https://www.citedy.com/docs/api-reference/seo-tools/analyze-page-meta-tags.md)
- [Analyze robots.txt directives](https://www.citedy.com/docs/api-reference/seo-tools/analyze-robotstxt-directives.md)
- [Check sitemap availability and robots.txt hints](https://www.citedy.com/docs/api-reference/seo-tools/check-sitemap-availability-and-robotstxt-hints.md)
- [Extract Open Graph/Twitter preview metadata](https://www.citedy.com/docs/api-reference/seo-tools/extract-open-graphtwitter-preview-metadata.md)
- [Generate branded Open Graph image](https://www.citedy.com/docs/api-reference/seo-tools/generate-branded-open-graph-image.md)
- [Get async brand scan status/result](https://www.citedy.com/docs/api-reference/seo-tools/get-async-brand-scan-statusresult.md)
- [List available agent tools](https://www.citedy.com/docs/api-reference/seo-tools/list-available-agent-tools.md)
- [Plan internal links from page + targets](https://www.citedy.com/docs/api-reference/seo-tools/plan-internal-links-from-page-+-targets.md)
- [Start async AI brand visibility scan](https://www.citedy.com/docs/api-reference/seo-tools/start-async-ai-brand-visibility-scan.md)
- [Validate page JSON-LD schema markup](https://www.citedy.com/docs/api-reference/seo-tools/validate-page-json-ld-schema-markup.md)
- [Get queued article generation status or result by ID](https://www.citedy.com/docs/api-reference/articles/get-queued-article-generation-status-or-result-by-id.md): Poll for the status of a queued article generation job. Returns processing status while the article is being generated, or the final result (success/failure) once complete.
- [Permanently delete an article](https://www.citedy.com/docs/api-reference/articles/permanently-delete-an-article.md): Permanently delete an article regardless of its current status (generated, published, failed, etc.). Performs cascading cleanup: removes the article database record and associated storage files (illustrations, voice-overs) on a best-effort basis. This operation is permanent and cannot be undone.
- [Publish a draft article](https://www.citedy.com/docs/api-reference/articles/publish-a-draft-article.md): Trigger the publish pipeline for a draft article (status=generated). The article will be available on the public blog shortly after.
- [Unpublish an article (revert to draft)](https://www.citedy.com/docs/api-reference/articles/unpublish-an-article-revert-to-draft.md): Set article status back to 'generated'. The article remains in the system but is removed from the public blog. Only articles with status 'published' can be unpublished; attempting to unpublish an article in any other status returns 400.
- [Get GSC performance report](https://www.citedy.com/docs/api-reference/gsc/get-gsc-performance-report.md): Returns Google Search Console performance report with clicks, impressions, CTR, positions, top queries, top pages, movers, opportunities, and article suggestions. Returns connect URL if GSC is not linked. Free (0 credits).
- [Export a Citedy warm-lead report](https://www.citedy.com/docs/api-reference/warm-leads/export-a-citedy-warm-lead-report.md): Downloads an export projection of the canonical JSON result. Supported formats: JSON, CSV, and Excel .xlsx.
- [Get a Citedy warm-lead run](https://www.citedy.com/docs/api-reference/warm-leads/get-a-citedy-warm-lead-run.md)
- [Start a Citedy warm-lead report](https://www.citedy.com/docs/api-reference/warm-leads/start-a-citedy-warm-lead-report.md): Creates one tenant-scoped warm-lead run for one company domain. Accepted new runs charge exactly 40 Citedy credits. Poll GET /api/agent/citedy-warm-lead/{runId} for status and result.

## OpenAPI Specs

- [openapi](https://www.citedy.com/docs/api-reference/openapi.json)