> ## Documentation Index
> Fetch the complete documentation index at: https://docs.postsyncer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference overview

> What the PostSyncer REST API includes-platforms, versioning, and links to endpoint docs

This page is the **hub** for the REST API: what it does, where it lives, and how responses work. **Step-by-step auth** lives in [Authentication](/essentials/authentication). **Errors and status codes** are in [Error handling](/essentials/error-handling). **Request quotas** are in [Fair usage & limits](/rate-limits).

## What you can do

PostSyncer offers a RESTful API to manage scheduling workflows: **upload or import media** (multipart file upload and URL import), then create, update, and delete **posts**; **analyze public X/Twitter posts and replies with AI**; list, reply to, update, and delete **comments**; list **workspaces**, **accounts**, and **labels**; read **analytics** (all workspaces, one workspace, one post, or one account); and queue **analytics sync** for a post. Endpoint pages live in the sidebar under **Media**, **Folders**, **Posts**, **Comments**, **Analytics**, **Workspaces**, **Accounts**, and **Labels**.

## Supported platforms

PostSyncer supports scheduling and publishing to:

<CardGroup cols={3}>
  <Card title="Twitter / X" icon="twitter" />

  <Card title="Facebook" icon="facebook" />

  <Card title="Instagram" icon="instagram" />

  <Card title="TikTok" icon="tiktok" />

  <Card title="YouTube" icon="youtube" />

  <Card title="Pinterest" icon="pinterest" />

  <Card title="Threads" icon="threads" />

  <Card title="Telegram" icon="telegram" />

  <Card title="LinkedIn" icon="linkedin" />

  <Card title="Mastodon" icon="mastodon" />

  <Card title="Bluesky" icon="bluesky" />
</CardGroup>

## Version & base URL

| Version | Status  | Base URL                        |
| ------- | ------- | ------------------------------- |
| v1      | Current | `https://postsyncer.com/api/v1` |

All endpoint paths in this docs site are relative to that base URL **except** [upload from file](/api-reference/media/upload-file), which uses **`https://upload.postsyncer.com/api/v1`** for the same versioned paths (dedicated upload infrastructure; same Bearer token).

## Authentication (summary)

Every request needs a **Bearer** token from [Settings → API integrations](https://app.postsyncer.com/dashboard?action=settings\&section=api-integrations). Scopes must match what you call (e.g. `posts` for posts and analytics).

```bash theme={null}
Authorization: Bearer YOUR_API_TOKEN
```

<Card title="Full authentication guide" icon="key" href="/essentials/authentication">
  Keys, scopes, and security practices
</Card>

## JSON responses

Responses are **JSON** with standard HTTP status codes. Success is typically `2xx`; validation and permission issues are `4xx`. See [Error handling](/essentials/error-handling) for patterns, status codes, and rate-limit (`429`) behavior.

## Next steps

<CardGroup cols={2}>
  <Card title="Quick start" icon="rocket" href="/quickstart">
    Make your first request
  </Card>

  <Card title="Media" icon="image" href="/api-reference/media/overview">
    File upload, URL import, and using ids on posts
  </Card>

  <Card title="Comments" icon="message-square" href="/api-reference/comments/overview">
    List, create, update, delete, and hide on platform
  </Card>

  <Card title="Analytics overview" icon="chart-line" href="/api-reference/analytics/overview">
    All analytics endpoints in one place
  </Card>
</CardGroup>