# Documentation

Connect social accounts and publish posts with the dashboard, API, CLI, or MCP tools.

Source: https://opensocial.run/docs
Markdown: https://opensocial.run/docs/index.md



Open Social connects social accounts to one publishing API. Use the dashboard
to manage accounts, posts, API keys, webhooks, and usage. Use the API, CLI, or MCP
tools to create, validate, schedule, and publish posts.

## Using an AI agent? [#using-an-ai-agent]

Help me integrate Open Social with my application or AI agent.

Read these documents first:
- Documentation index: https://opensocial.run/llms.txt
- Getting started: https://opensocial.run/docs/getting-started.md
- API reference: https://opensocial.run/docs/api.md
- Platform requirements: https://opensocial.run/docs/video-platforms.md
- All public documentation: https://opensocial.run/llms-full.txt

For a self-hosted service, replace the origin in these URLs with the service address.

Use the REST API at the service address with the /v1 path, the repository CLI, or the Open Social MCP tools. Ask which client and service address to use if they are not known. Follow the connection instructions in the getting started guide. Keep API keys in environment variables. Do not put keys in source code or logs.

List connected accounts and read platform capabilities before you create a post. Use returned account and media IDs. Do not guess IDs, limits, or platform options. For TikTok, read current publishing options and ask the creator to select privacy and confirm consent for each video.

Validate content for all target accounts. Correct errors before publication. Create a draft unless I request publication or a schedule. Use an RFC 3339 timestamp with an explicit time zone for a schedule. Confirm the time zone if it is not known.

A publish request starts an asynchronous operation. Check each publication status before you report success. Report failures and partial success. Do not repeat a publish request without checking the current post status.


## Start here [#start-here]

1. Follow [Getting started](https://opensocial.run/docs/getting-started) to connect an account and create your first post.
2. Read the [API reference](https://opensocial.run/docs/api) for requests, errors, scopes, media, and webhooks.
3. Read the [platform guide](https://opensocial.run/docs/video-platforms) for Instagram, TikTok, and YouTube publishing requirements.

## For agents [#for-agents]

Read the available accounts and platform capabilities before you create content.
Validate the post for each target account. Publish or schedule it when the user
requests that action. Check each publication status before you report success.

The [agent workflow](https://opensocial.run/docs/getting-started#use-an-agent) lists the MCP tools for
these steps. The API and CLI use the same accounts and posts as the dashboard.