# ExportComments API Documentation

> Export comments, reviews, followers, and other data from 40+ social media platforms via a REST API, CLI tool, or MCP server for AI assistants.

Base URL: https://exportcomments.com
API Version: v3
Authentication: X-AUTH-TOKEN header

## Getting Started

- [Introduction](/) — Get started with the ExportComments API
- [Authentication](/authentication/) — How to authenticate with the ExportComments API
- [Errors](/errors/) — Error handling in the ExportComments API
- [Rate Limits](/rate-limits/) — API rate limiting by tier
- [Sandbox Mode](/sandbox/) — Test the API without consuming your quota
- [Pagination](/pagination/) — How pagination works in list endpoints
- [Platforms](/platforms/) — All platforms supported by ExportComments
- [API Tiers](/tiers/) — Compare Premium and Business API tiers
- [Sentiment Analysis](/sentiment-analysis/) — Analyze the emotional tone of exported comments using AI
- [AI Agents](/ai-agents/) — Integrate ExportComments with AI agents and LLMs via the MCP server and CLI

## API Tokens

- [Overview](/api-tokens/) — Manage API tokens for authentication
- [POST Generate token](/api-tokens/generate/) — Generate a new API token
- [GET List tokens](/api-tokens/list/) — List all API tokens
- [GET Retrieve token](/api-tokens/retrieve/) — Get details of a specific API token
- [DELETE Revoke token](/api-tokens/revoke/) — Permanently delete an API token

## Export Jobs

- [Overview](/jobs/) — Create and manage export jobs
- [POST Create job](/jobs/create/) — Create a new export job
- [GET Retrieve job](/jobs/retrieve/) — Get details of a specific export job
- [GET List jobs](/jobs/list/) — List all export jobs
- [PATCH Retry job](/jobs/retry/) — Retry a failed export job
- [PATCH Stop job](/jobs/stop/) — Stop a running export job

## Real-Time

- [Overview](/realtime/) — Receive real-time export updates via WebSocket
- [POST Authenticate](/realtime/authenticate/) — Obtain a WebSocket connection token
- [Channels](/realtime/channels/) — WebSocket channels and subscription model
- [Connection Guide](/realtime/connect/) — Connect to the real-time WebSocket API
- [Event Reference](/realtime/events/) — Complete reference for all real-time WebSocket events

## Webhooks

- [Overview](/webhooks/) — Receive real-time export notifications
- [POST Create webhook](/webhooks/create/) — Create a new webhook endpoint
- [GET Retrieve webhook](/webhooks/retrieve/) — Get webhook details
- [GET List webhooks](/webhooks/list/) — List all webhooks
- [PATCH Update webhook](/webhooks/update/) — Update a webhook
- [DELETE Delete webhook](/webhooks/delete/) — Delete a webhook
- [PATCH Toggle webhook](/webhooks/toggle/) — Toggle webhook enabled/disabled
- [GET Delivery summary](/webhooks/summary/) — Get webhook delivery statistics
- [GET List events](/webhooks/events/) — List webhook delivery events
- [POST Resend event](/webhooks/resend/) — Resend a webhook event
- [Security](/webhooks/security/) — Verify webhook signatures

## Workflows

- [Overview](/workflows/) — Multi-step automated export pipelines
- [POST Create workflow](/workflows/create/) — Create a multi-step workflow
- [GET Retrieve workflow](/workflows/retrieve/) — Get workflow details
- [GET List workflows](/workflows/list/) — List all workflows
- [PUT Update workflow](/workflows/update/) — Update a workflow
- [DELETE Delete workflow](/workflows/delete/) — Delete a workflow
- [POST Pause workflow](/workflows/pause/) — Pause a workflow
- [POST Resume workflow](/workflows/resume/) — Resume a paused workflow
- [POST Run now](/workflows/run-now/) — Trigger an immediate run of a workflow
- [GET Pipeline info](/workflows/pipeline-info/) — Get platform actions and pipeline templates

## Scheduled Exports

- [Overview](/schedules/) — Schedule recurring exports
- [POST Create schedule](/schedules/create/) — Create a scheduled export
- [GET Retrieve schedule](/schedules/retrieve/) — Get schedule details
- [GET List schedules](/schedules/list/) — List all scheduled exports
- [PUT Update schedule](/schedules/update/) — Update a scheduled export
- [DELETE Delete schedule](/schedules/delete/) — Delete a scheduled export
- [POST Pause schedule](/schedules/pause/) — Pause a scheduled export
- [POST Resume schedule](/schedules/resume/) — Resume a paused scheduled export
- [POST Run now](/schedules/run-now/) — Trigger an immediate run of a scheduled export

## Proxies

- [Overview](/proxies/) — Manage custom proxy pools
- [POST Create pool](/proxies/create/) — Create a new proxy pool
- [GET Retrieve pool](/proxies/retrieve/) — Get proxy pool details
- [GET List pools](/proxies/list/) — List all proxy pools
- [PATCH Update pool](/proxies/update/) — Update a proxy pool
- [DELETE Delete pool](/proxies/delete/) — Delete a proxy pool

## CLI & MCP

- [Overview](/cli/) — Command-line tool and MCP server for the ExportComments API
- [export](/cli/export/) — Create a new export job from the command line
- [status](/cli/status/) — Check the status of an export job
- [list](/cli/list/) — List all export jobs
- [download](/cli/download/) — Download a completed export
- [platforms](/cli/platforms/) — List and detect supported platforms
- [MCP Server](/cli/mcp/) — Use ExportComments with AI assistants via the Model Context Protocol (MCP)

## Other

- [VPN Locations](/vpn/) — List available VPN locations
- [API Usage](/usage/) — Get API usage statistics
- [Bulk Download](/bulk-download/) — Download multiple exports at once
- [POST Create download](/bulk-download/create/) — Create a bulk download request
- [GET Check status](/bulk-download/status/) — Check bulk download status
- [GET Download file](/bulk-download/download/) — Download the bulk ZIP file