# SocialSyncs Documentation

## Docs

- [Create an Automation](https://docs.socialsyncs.co/automations/create-automation.md): Build an Instagram automation step by step with the four-step builder
- [Automations Overview](https://docs.socialsyncs.co/automations/overview.md): Automatically reply to comments, story replies, and DMs on Instagram
- [Triggers & Actions](https://docs.socialsyncs.co/automations/triggers-and-actions.md): Every trigger, targeting option, and DM action in the automation builder
- [Analytics](https://docs.socialsyncs.co/cli/analytics.md): View platform and post-level analytics from the command line
- [Authentication](https://docs.socialsyncs.co/cli/authentication.md): Set up OAuth2 or API key authentication for the SocialSyncs CLI
- [Integrations](https://docs.socialsyncs.co/cli/integrations.md): Discover connected accounts, settings schemas, and dynamic tools
- [Introduction](https://docs.socialsyncs.co/cli/introduction.md): Automate social media posting from the command line with the SocialSyncs CLI
- [Managing Posts](https://docs.socialsyncs.co/cli/managing-posts.md): Create, list, and delete social media posts from the command line
- [Media Upload](https://docs.socialsyncs.co/cli/media-upload.md): Upload images, videos, and other media files for use in posts
- [Platform Examples](https://docs.socialsyncs.co/cli/platform-examples.md): Ready-to-use examples for posting to specific platforms
- [Chrome Extension](https://docs.socialsyncs.co/configuration/chrome-extension.md): Set up the SocialSyncs browser extension for cookie-based integrations
- [How to add a new provider](https://docs.socialsyncs.co/configuration/create-provider.md): How to add a new provider to SocialSyncs
- [Docker Compose Configuration](https://docs.socialsyncs.co/configuration/docker.md): How to configure your docker-compose file for SocialSyncs
- [Email Notifications](https://docs.socialsyncs.co/configuration/emails.md): How to send notifications to users
- [OIDC Configuration](https://docs.socialsyncs.co/configuration/oauth.md): How to configure OIDC for SocialSyncs
- [Image & Video Editing (Polotno)](https://docs.socialsyncs.co/configuration/polotno.md): Enable in-app image and video editing in SocialSyncs via the Polotno SDK
- [R2 Configuration](https://docs.socialsyncs.co/configuration/r2.md): How to use Cloudflare R2 for file storage
- [Configuration Reference](https://docs.socialsyncs.co/configuration/reference.md): Environment variables reference for SocialSyncs
- [Custom Storage (Cloudflare R2)](https://docs.socialsyncs.co/configuration/storage.md): Store your uploads in your own Cloudflare R2 bucket
- [Uploads & Storage](https://docs.socialsyncs.co/configuration/uploads.md): Local filesystem vs Cloudflare R2 for media uploads
- [Developer Guide](https://docs.socialsyncs.co/developer-guide.md): How to get started developing with SocialSyncs
- [How it works](https://docs.socialsyncs.co/howitworks.md): Learn the architecture of the project
- [Dev Container](https://docs.socialsyncs.co/installation/devcontainer.md): Install SocialSyncs using Dev Container
- [Development Environment](https://docs.socialsyncs.co/installation/development.md): Set up SocialSyncs for local development
- [Docker](https://docs.socialsyncs.co/installation/docker.md): Install SocialSyncs using Docker standalone
- [Docker Compose](https://docs.socialsyncs.co/installation/docker-compose.md): Install SocialSyncs using Docker Compose
- [Helm](https://docs.socialsyncs.co/installation/kubernetes-helm.md): Install SocialSyncs using Kubernetes and Helm
- [Migration to Temporal](https://docs.socialsyncs.co/installation/migration.md): A guide to migrating to the new Temporal infrastructure
- [System Requirements](https://docs.socialsyncs.co/installation/system-requirements.md): Hardware, services, ports, and network requirements for self-hosting SocialSyncs
- [Introduction](https://docs.socialsyncs.co/introduction.md): Welcome to SocialSyncs documentation
- [Examples](https://docs.socialsyncs.co/mcp/examples.md): Common workflows when using SocialSyncs through MCP
- [Introduction](https://docs.socialsyncs.co/mcp/introduction.md): Connect AI agents to SocialSyncs using the Model Context Protocol (MCP)
- [Client Setup](https://docs.socialsyncs.co/mcp/setup.md): Configure your AI client to connect to the SocialSyncs MCP server
- [Tools Reference](https://docs.socialsyncs.co/mcp/tools.md): Complete reference for all SocialSyncs MCP tools
- [Instagram](https://docs.socialsyncs.co/providers/instagram.md): How to add Instagram to your system
- [LinkedIn](https://docs.socialsyncs.co/providers/linkedin.md): How to add LinkedIn to your system
- [Providers Overview](https://docs.socialsyncs.co/providers/overview.md): Configure social media providers for SocialSyncs
- [YouTube](https://docs.socialsyncs.co/providers/youtube.md): How to Add YouTube to Your System
- [Platform Analytics](https://docs.socialsyncs.co/public-api/analytics/platform.md): Get analytics data for a specific integration/channel. Returns metrics like followers, impressions, engagement, etc. depending on the platform.
- [Post Analytics](https://docs.socialsyncs.co/public-api/analytics/post.md): Get analytics data for a specific published post. Returns metrics like likes, comments, shares, impressions, etc. depending on the platform.
- [Create Automation](https://docs.socialsyncs.co/public-api/automations/create.md): Create a new automation workflow
- [Delete Automation](https://docs.socialsyncs.co/public-api/automations/delete.md): Soft-delete an automation workflow
- [Get Automation](https://docs.socialsyncs.co/public-api/automations/get.md): Get a single automation workflow by ID
- [List Automations](https://docs.socialsyncs.co/public-api/automations/list.md): Get all automation workflows for your organization
- [Get Automation Logs](https://docs.socialsyncs.co/public-api/automations/logs.md): Retrieve paginated execution logs for an automation
- [Toggle Active](https://docs.socialsyncs.co/public-api/automations/toggle-active.md): Enable or disable an automation without changing its configuration
- [Update Automation](https://docs.socialsyncs.co/public-api/automations/update.md): Replace an automation workflow with new configuration
- [Connect Channel (OAuth)](https://docs.socialsyncs.co/public-api/integrations/connect.md): Generate an OAuth authorization URL for a given integration. Use this to connect a new social media channel. Only OAuth-based integrations are supported (integrations that require an external URL, such as Mastodon, are not available via this endpoint).
- [Delete Channel](https://docs.socialsyncs.co/public-api/integrations/delete.md): Delete a connected channel by its integration ID. Any scheduled posts associated with this channel will also be deleted.
- [Find Available Slot](https://docs.socialsyncs.co/public-api/integrations/find-slot.md): Get the next available time slot for posting to a specific channel.
- [List Groups (Customers)](https://docs.socialsyncs.co/public-api/integrations/groups.md): Returns all customers (groups) for your organization. Use a group ID to filter the integrations list.
- [Check Connection](https://docs.socialsyncs.co/public-api/integrations/is-connected.md): Verify if your API key is valid and connected.
- [List Integrations](https://docs.socialsyncs.co/public-api/integrations/list.md): Returns all connected social media channels for your organization.
- [Get Settings & Tools](https://docs.socialsyncs.co/public-api/integrations/settings.md): Returns the posting rules, maximum content length, settings schema, and available provider tools for a connected channel. Use this to discover which tools can be executed with the trigger endpoint.
- [Trigger a Tool](https://docs.socialsyncs.co/public-api/integrations/trigger.md): Executes a provider-specific tool on a connected channel, for example searching Instagram audio for Reels, listing Discord channels, or fetching Reddit flairs. Discover available tools with the integration settings endpoint.
- [API Overview](https://docs.socialsyncs.co/public-api/introduction.md): Getting started with the SocialSyncs Public API
- [List Notifications](https://docs.socialsyncs.co/public-api/notifications/list.md): Get paginated notifications for your organization, sorted by most recent first. Returns 100 notifications per page.
- [OAuth2 Authentication](https://docs.socialsyncs.co/public-api/oauth.md): Let users authorize your app to access SocialSyncs on their behalf
- [Change Post Status](https://docs.socialsyncs.co/public-api/posts/change-status.md): Moves a post between `draft` and `schedule` state.
- [Create Post](https://docs.socialsyncs.co/public-api/posts/create.md): Create or schedule a new post. Each social media platform has its own settings schema.
- [Delete Post](https://docs.socialsyncs.co/public-api/posts/delete.md): Delete a post by its ID. The API will look up the post and delete all posts in the same group.
- [Delete Post by Group](https://docs.socialsyncs.co/public-api/posts/delete-by-group.md): Delete all posts in a group by the group identifier.
- [List Posts](https://docs.socialsyncs.co/public-api/posts/list.md): Get posts within a date range.
- [Get Missing Content](https://docs.socialsyncs.co/public-api/posts/missing-content.md): When a post has been published but the platform did not return a usable post ID (the `releaseId` is set to `"missing"`), this endpoint fetches recent content from the provider so you can match and connect the correct one to the post.
- [Update Release ID](https://docs.socialsyncs.co/public-api/posts/update-release-id.md): Updates the `releaseId` of a post that currently has its release ID set to `"missing"`. This connects the post to its actual published content on the platform, enabling analytics and statistics tracking.
- [Instagram Standalone Settings](https://docs.socialsyncs.co/public-api/providers/instagram-standalone.md): API settings for posting to standalone Instagram accounts
- [LinkedIn Settings](https://docs.socialsyncs.co/public-api/providers/linkedin.md): API settings for posting to LinkedIn
- [YouTube Settings](https://docs.socialsyncs.co/public-api/providers/youtube.md): API settings for posting to YouTube
- [Upload File](https://docs.socialsyncs.co/public-api/uploads/upload-file.md): Upload a media file using multipart form data.
- [Upload from URL](https://docs.socialsyncs.co/public-api/uploads/upload-from-url.md): Upload a file from an existing URL.
- [Video Function](https://docs.socialsyncs.co/public-api/video/function.md): Execute video-related functions like loading available voices.
- [Generate Video](https://docs.socialsyncs.co/public-api/video/generate.md): Create AI-generated videos for your posts.
- [Quickstart](https://docs.socialsyncs.co/quickstart.md): Get started with SocialSyncs installation
- [Caddy](https://docs.socialsyncs.co/reverse-proxies/caddy.md): Configure Caddy as a reverse proxy for SocialSyncs
- [Nginx](https://docs.socialsyncs.co/reverse-proxies/nginx.md): Configure Nginx as a reverse proxy for SocialSyncs
- [Traefik + Docker Compose](https://docs.socialsyncs.co/reverse-proxies/traefik.md): Configure Traefik as a reverse proxy for SocialSyncs
- [WebSockets, HMR, and Dev Tunnels](https://docs.socialsyncs.co/reverse-proxies/websockets-and-dev.md): Running SocialSyncs behind ngrok or a reverse proxy with WebSocket support
- [Support](https://docs.socialsyncs.co/support.md): Get help with SocialSyncs
- [Activation & Login](https://docs.socialsyncs.co/troubleshooting/activation-and-login.md): Expired activation links, "jwt malformed", and login API responses
- [Billing (Cloud)](https://docs.socialsyncs.co/troubleshooting/billing.md): Stripe.js blocked, billing page in incognito, discount errors
- [Channel Limits (Cloud)](https://docs.socialsyncs.co/troubleshooting/channel-limits.md): "You have reached the maximum number of channels"
- [Known Issues](https://docs.socialsyncs.co/troubleshooting/known-issues.md): Live tracker of bugs we are aware of, with workarounds where possible
- [OAuth & Channel Connect Errors](https://docs.socialsyncs.co/troubleshooting/oauth-connect.md): Invalid state, invalid_grant, and fetch failed during the connect flow
- [Troubleshooting](https://docs.socialsyncs.co/troubleshooting/overview.md): Common SocialSyncs problems and how to resolve them
- [Self-Host Gotchas](https://docs.socialsyncs.co/troubleshooting/self-host.md): Common problems specific to running SocialSyncs yourself
- [Uploads & Media](https://docs.socialsyncs.co/troubleshooting/uploads.md): Payload limits, upload-from-url, video, and cancel-in-flight behaviour

## OpenAPI Specs

- [openapi](https://docs.socialsyncs.co/public-api/openapi.json)

## Optional

- [GitHub](https://github.com/gitroomhq/postiz-app)