Upload-Post

https://docs.upload-post.com/api/reference
Admin
Upload-Post is an API that enables programmatic uploading of videos, photos, and text posts to...
Tokens:15,626
Snippets:113
Trust Score:5.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /api/uploadposts/autodms/logs

Source: https://docs.upload-post.com/api/reference

Get activity logs for a specific AutoDM monitor.

```APIDOC
## GET /api/uploadposts/autodms/logs

### Description
Get activity logs for a specific AutoDM monitor.

### Method
GET

### Endpoint
/api/uploadposts/autodms/logs

### Parameters
#### Query Parameters
- **monitor_id** (string) - Required - The ID of the monitor to retrieve logs for.

### Response
#### Success Response (200)
- **logs** (array) - List of log entries

#### Response Example
{
  "logs": [
    {
      "timestamp": "2023-01-01T00:00:00Z",
      "event": "DM sent",
      "user_id": "user123"
    }
  ]
}
```

--------------------------------

### GET /api/uploadposts/suggestions

Source: https://docs.upload-post.com/api/reference

Get suggestions for what to tag a post with and what people search around a keyword. One endpoint with a platform and a type, not one per network. Returns hashtags[] with name and view_count for type=hashtags; keywords[] with each term and its search volume for type=keywords. Supported platforms: tiktok. Required capability: profile_analytics for type=hashtags; trend_search (reconnected account) for type=keywords.

```APIDOC
## [GET] /api/uploadposts/suggestions

### Description
What to tag a post with and what people search around a keyword. One endpoint with a `platform` and a `type`, not one per network.

### Method
GET

### Endpoint
/api/uploadposts/suggestions

### Parameters
#### Query Parameters
- **platform** (string) - Required - The platform to get suggestions for. Supported: `tiktok`.
- **type** (string) - Required - The type of suggestions: `hashtags` or `keywords`.

### Response
#### Success Response
- **hashtags[]** (array) - For `type=hashtags`.
  - **name** (string) - The hashtag name without leading `#`.
  - **view_count** (number) - The view count for the hashtag.
- **keywords[]** (array) - For `type=keywords`.
  - **term** (string) - The keyword term.
  - **search volume** (number) - The search volume for the keyword.

### Required Capabilities
- **profile_analytics** - Required for `type=hashtags`.
- **trend_search** - Required for `type=keywords` (reconnected account).

```

--------------------------------

### GET /api/uploadposts/total-impressions/{profile_username}

Source: https://docs.upload-post.com/api/reference

Get unified total impressions aggregated across platforms for a given profile. Supports date range filtering and per-platform breakdown.

```APIDOC
## GET /api/uploadposts/total-impressions/{profile_username}

### Description
Get unified total impressions aggregated across platforms for a given profile.

### Method
GET

### Endpoint
/api/uploadposts/total-impressions/{profile_username}

### Parameters
#### Path Parameters
- **profile_username** (string) - Required - The username of the profile.

#### Query Parameters
- **date_from** (string) - Optional - Start date for filtering.
- **date_to** (string) - Optional - End date for filtering.

### Response
#### Success Response (200)
- **total_impressions** (number) - Total impressions across platforms.
- **per_platform** (object) - Breakdown of impressions by platform.

#### Response Example
{
  "total_impressions": 10000,
  "per_platform": {
    "instagram": 4000,
    "tiktok": 3000,
    "linkedin": 3000
  }
}
```

--------------------------------

### POST /api/uploadposts/analyze-shorts

Source: https://docs.upload-post.com/api/reference

Send a short-form video and get AI-written titles, descriptions, captions and hashtags per platform. Uses the monthly AI Shorts quota of your plan.

```APIDOC
## [POST] /api/uploadposts/analyze-shorts

### Description
Send a short-form video and get AI-written titles, descriptions, captions and hashtags per platform. Uses the monthly AI Shorts quota of your plan.

### Method
POST

### Endpoint
/api/uploadposts/analyze-shorts

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### Connect API

Source: https://docs.upload-post.com/api/reference

Build your own social account connection page instead of using the hosted one. Server-side OAuth start endpoints return the authorize URL for each platform; a single-use state authenticates the callback, and the end user returns to your `redirect_url` with `connect_status=success|cancelled|error` and a stable `error_code` on failure.

```APIDOC
## Connect API

### Description
Build your own social account connection page instead of using the hosted one. Server-side OAuth start endpoints return the authorize URL for each platform; a single-use state authenticates the callback, and the end user returns to your `redirect_url` with `connect_status=success|cancelled|error` and a stable `error_code` on failure.

### Endpoint
- `POST /api/uploadposts/oauth/{platform}/start` - Get the authorize URL for a platform

### Supported Platforms
TikTok, Instagram, Facebook, LinkedIn, YouTube, X (Twitter), Threads, Reddit, Pinterest, Google Business Profile, Snapchat
```

--------------------------------

### GET /api/uploadposts/pinterest/boards

Source: https://docs.upload-post.com/api/reference

List all Pinterest boards (public and secret) from connected accounts. Required for targeting specific boards when pinning content. Returns board IDs, names, and associated Pinterest accounts.

```APIDOC
## [GET] /api/uploadposts/pinterest/boards

### Description
List all Pinterest boards (public and secret) from connected accounts. Required for targeting specific boards when pinning content.

### Method
GET

### Endpoint
/api/uploadposts/pinterest/boards

### Response
#### Success Response
- **Board IDs** (string) - The board identifier.
- **Names** (string) - The board name.
- **Associated Pinterest accounts** (string) - The Pinterest account associated with the board.

```

--------------------------------

### POST /api/uploadposts/autodms/start

Source: https://docs.upload-post.com/api/reference

Start a new AutoDM monitor that automatically sends private DMs to users who comment on your Instagram posts.

```APIDOC
## POST /api/uploadposts/autodms/start

### Description
Start a new AutoDM monitor that automatically sends private DMs to users who comment on your Instagram posts. Monitors run in the background 24/7 with duplicate prevention and rate limiting.

### Method
POST

### Endpoint
/api/uploadposts/autodms/start

### Parameters
#### Request Body
- **post_id** (string) - Required - The Instagram post ID to monitor.
- **message** (string) - Required - The DM message to send to commenters.

### Request Example
{
  "post_id": "123456",
  "message": "Thanks for commenting!"
}

### Response
#### Success Response (200)
- **monitor_id** (string) - ID of the started monitor

#### Response Example
{
  "monitor_id": "monitor123"
}
```

--------------------------------

### GET /api/uploadposts/threads/publishing_limit

Source: https://docs.upload-post.com/api/reference

Get the remaining Threads posts and replies quota (250 posts / 1000 replies per 24 hours).

```APIDOC
## [GET] /api/uploadposts/threads/publishing_limit

### Description
Remaining Threads posts and replies quota (250 posts / 1000 replies per 24 hours).

### Method
GET

### Endpoint
/api/uploadposts/threads/publishing_limit

### Response
#### Success Response
- **remaining posts** (number) - Remaining posts quota.
- **remaining replies** (number) - Remaining replies quota.

```

--------------------------------

### GET /api/uploadposts/autodms/status

Source: https://docs.upload-post.com/api/reference

Get status of all AutoDM monitors. Supports ?include_inactive=true to also return stopped/expired ones.

```APIDOC
## GET /api/uploadposts/autodms/status

### Description
Get status of all AutoDM monitors. Supports ?include_inactive=true to also return stopped/expired ones.

### Method
GET

### Endpoint
/api/uploadposts/autodms/status

### Parameters
#### Query Parameters
- **include_inactive** (boolean) - Optional - If true, includes stopped/expired monitors.

### Response
#### Success Response (200)
- **monitors** (array) - List of monitors with their status

#### Response Example
{
  "monitors": [
    {
      "id": "monitor123",
      "status": "active",
      "post_id": "123456"
    }
  ]
}
```

--------------------------------

### GET /api/uploadposts/post-analytics?platform_post_id=

Source: https://docs.upload-post.com/api/reference

Get analytics for organic posts using the platform's post ID. Supports TikTok per-post breakdown including retention curve and impression sources.

```APIDOC
## GET /api/uploadposts/post-analytics?platform_post_id=

### Description
Get analytics for organic posts using the platform's post ID.

### Method
GET

### Endpoint
/api/uploadposts/post-analytics?platform_post_id=

### Parameters
#### Query Parameters
- **platform_post_id** (string) - Required - The platform's post ID.

### Response
#### Success Response (200)
- **retention_curve** (array) - Retention curve data.
- **impression_sources** (object) - Sources of impressions.
- **audience_types** (object) - Audience type breakdown.
- **reach** (number) - Total reach.
- **favorites** (number) - Number of favorites.
- **new_followers** (number) - New followers gained.

#### Response Example
{
  "retention_curve": [],
  "impression_sources": {},
  "audience_types": {},
  "reach": 5000,
  "favorites": 100,
  "new_followers": 50
}
```

--------------------------------

### GET /api/uploadposts/instagram/publishing_limit

Source: https://docs.upload-post.com/api/reference

Get the remaining Instagram content-publishing quota for a connected profile.

```APIDOC
## [GET] /api/uploadposts/instagram/publishing_limit

### Description
Remaining Instagram content-publishing quota for a connected profile.

### Method
GET

### Endpoint
/api/uploadposts/instagram/publishing_limit

### Response
#### Success Response
- **remaining** (number) - The remaining publishing quota.

```

--------------------------------

### GET /api/uploadposts/history

Source: https://docs.upload-post.com/api/reference

Retrieve a paginated history of all your past uploads across platforms. Includes detailed metadata, success/failure status, and platform-specific information.

```APIDOC
## [GET] /api/uploadposts/history

### Description
Retrieve a paginated history of all your past uploads across platforms. Includes detailed metadata, success/failure status, and platform-specific information.

### Method
GET

### Endpoint
/api/uploadposts/history

### Parameters
#### Query Parameters
- **platform** (string) - Optional - Filter by platform.
- **status** (string) - Optional - Filter by status.
- **profile_username** (string) - Optional - Filter by profile username.
- **start** (string) - Optional - Start date for filtering.
- **end** (string) - Optional - End date for filtering.
- **request_id** (string) - Optional - Exact lookup by request ID.
- **job_id** (string) - Optional - Exact lookup by job ID.
- **external_id** (string) - Optional - Exact lookup by external ID.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /api/uploadposts/comments

Source: https://docs.upload-post.com/api/reference

List comments on a post across multiple platforms. Add comment_id to get replies under a specific comment.

```APIDOC
## GET /api/uploadposts/comments

### Description
List comments on a post across Instagram, Facebook, YouTube, LinkedIn, TikTok, X, Threads, and Bluesky. Add comment_id to get replies under one comment instead. Reddit comments return 503 reddit_unavailable.

### Method
GET

### Endpoint
/api/uploadposts/comments

### Parameters
#### Query Parameters
- **post_id** (string) - Required - The ID of the post to retrieve comments for.
- **comment_id** (string) - Optional - If provided, returns replies under that comment.

### Response
#### Success Response (200)
- **comments** (array) - List of comments

#### Response Example
{
  "comments": [
    {
      "id": "comment123",
      "text": "Great post!",
      "created_at": "2023-01-01T00:00:00Z"
    }
  ]
}
```

--------------------------------

### GET /api/uploadposts/post-analytics/{request_id}

Source: https://docs.upload-post.com/api/reference

Get per-post analytics for a specific post identified by request_id. Provides live post metrics and profile snapshots.

```APIDOC
## GET /api/uploadposts/post-analytics/{request_id}

### Description
Get per-post analytics for a specific post identified by request_id.

### Method
GET

### Endpoint
/api/uploadposts/post-analytics/{request_id}

### Parameters
#### Path Parameters
- **request_id** (string) - Required - The unique identifier of the post request.

### Response
#### Success Response (200)
- **post_metrics** (object) - Metrics for the post.
- **profile_snapshot** (object) - Snapshot of the profile at the time of the request.

#### Response Example
{
  "post_metrics": {
    "likes": 100,
    "comments": 20
  },
  "profile_snapshot": {
    "followers": 1234
  }
}
```

--------------------------------

### GET /api/uploadposts/audience

Source: https://docs.upload-post.com/api/reference

Get audience insights for a profile, including activity by hour, demographics, and benchmark comparisons. Currently supports TikTok.

```APIDOC
## GET /api/uploadposts/audience

### Description
Get audience insights for a profile, including activity by hour, demographics, and benchmark comparisons.

### Method
GET

### Endpoint
/api/uploadposts/audience

### Parameters
#### Query Parameters
- **platform** (string) - Required - The platform (currently only `tiktok`).
- **benchmark_category** (string) - Optional - Category for benchmark comparison.

### Response
#### Success Response (200)
- **range** (object) - The actual time range used after trimming.
- **audience** (object) - Countries, cities, ages, genders.
- **activity_by_hour** (object) - Activity distribution by hour.
- **followers_daily** (array) - Daily follower counts.
- **profile_actions** (object) - Profile action metrics.
- **bio_description** (string) - Bio description.
- **benchmark_categories** (array) - Available benchmark categories.
- **benchmark** (object) - Benchmark data when `benchmark_category` is provided.

#### Response Example
{
  "range": {
    "start": "2023-01-01",
    "end": "2023-01-31"
  },
  "audience": {
    "countries": {},
    "cities": {},
    "ages": {},
    "genders": {}
  },
  "activity_by_hour": {},
  "followers_daily": [],
  "profile_actions": {},
  "bio_description": "Example bio",
  "benchmark_categories": [],
  "benchmark": {}
}
```

--------------------------------

### GET /api/uploadposts/google-business/locations

Source: https://docs.upload-post.com/api/reference

List the Google Business Profile locations available to an account. Essential for agencies and SaaS platforms where users manage multiple locations.

```APIDOC
## GET /api/uploadposts/google-business/locations

### Description
List the Google Business Profile locations available to an account.

### Method
GET

### Endpoint
/api/uploadposts/google-business/locations

### Response
#### Success Response (200)
- **locations** (array) - List of locations.
  - **id** (string) - Location ID.
  - **name** (string) - Business name.

#### Response Example
{
  "locations": [
    {
      "id": "123",
      "name": "Example Business"
    }
  ]
}
```

--------------------------------

### GET /api/uploadposts/tiktok/settings

Source: https://docs.upload-post.com/api/reference

Get what a connected TikTok account is actually allowed to publish. TikTok narrows the four privacy_level values per account — a private account has no PUBLIC_TO_EVERYONE — so ask here before offering them. Returns privacy_level_options, max_video_post_duration_sec and the account's comment / duet / stitch switches.

```APIDOC
## [GET] /api/uploadposts/tiktok/settings

### Description
What a connected TikTok account is actually allowed to publish. TikTok narrows the four `privacy_level` values per account — a private account has no `PUBLIC_TO_EVERYONE` — so ask here before offering them.

### Method
GET

### Endpoint
/api/uploadposts/tiktok/settings

### Response
#### Success Response
- **privacy_level_options** (array) - The allowed privacy levels.
- **max_video_post_duration_sec** (number) - Maximum video post duration in seconds.
- **comment / duet / stitch switches** (boolean) - Whether comments, duets, and stitches are enabled.

```

--------------------------------

### GET /api/uploadposts/post-analytics/cached

Source: https://docs.upload-post.com/api/reference

Bulk replay of per-post metrics that were previously fetched. Supports cursor pagination, platform filter, and date range. Not subject to the platform analytics rate limit.

```APIDOC
## GET /api/uploadposts/post-analytics/cached

### Description
Bulk replay of per-post metrics that were previously fetched. Only contains posts previously read through a live endpoint; there is no background refresh.

### Method
GET

### Endpoint
/api/uploadposts/post-analytics/cached

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Cursor for pagination.
- **limit** (number) - Optional - Number of posts per page (max 200).
- **platform** (string) - Optional - Filter by platform.
- **since** (string) - Optional - Start date for filtering.
- **until** (string) - Optional - End date for filtering.

### Response
#### Success Response (200)
- **posts** (array) - List of cached post analytics.
- **next_cursor** (string) - Cursor for the next page.

#### Response Example
{
  "posts": [
    {
      "request_id": "123",
      "captured_at": "2023-01-01T00:00:00Z"
    }
  ],
  "next_cursor": "abc"
}
```

--------------------------------

### GET /api/analytics/{profile_username}

Source: https://docs.upload-post.com/api/reference

Retrieve detailed analytics and performance metrics for social media profiles across connected platforms. Supports multiple platforms and provides metrics like followers, impressions, reach, and profile views.

```APIDOC
## GET /api/analytics/{profile_username}

### Description
Retrieve detailed analytics and performance metrics for your social media profiles across connected platforms.

### Method
GET

### Endpoint
/api/analytics/{profile_username}

### Parameters
#### Path Parameters
- **profile_username** (string) - Required - The username of the social media profile.

### Response
#### Success Response (200)
- **followers** (number) - Follower count.
- **impressions** (number) - Total impressions.
- **reach** (number) - Total reach.
- **profile_views** (number) - Profile view count.
- **time_series_data** (array) - Time-series metrics.
- **metric_type** (string) - Type of metric.
- **follower_demographics** (object) - Instagram-specific follower demographics.
- **engaged_audience_demographics** (object) - Instagram-specific engaged audience demographics.

#### Response Example
{
  "followers": 1234,
  "impressions": 5678,
  "reach": 4321,
  "profile_views": 987,
  "time_series_data": [],
  "metric_type": "followers",
  "follower_demographics": {},
  "engaged_audience_demographics": {}
}
```

--------------------------------

### GET /api/uploadposts/linkedin/pages

Source: https://docs.upload-post.com/api/reference

Fetch LinkedIn company pages associated with your connected accounts. Essential for business page posting.

```APIDOC
## GET /api/uploadposts/linkedin/pages

### Description
Fetch LinkedIn company pages associated with your connected accounts.

### Method
GET

### Endpoint
/api/uploadposts/linkedin/pages

### Response
#### Success Response (200)
- **pages** (array) - List of LinkedIn pages.
  - **organization_urn** (string) - Organization URN.
  - **company_name** (string) - Company name.
  - **vanity_url** (string) - Vanity URL.
  - **page_logo** (string) - URL of the page logo.

#### Response Example
{
  "pages": [
    {
      "organization_urn": "urn:li:organization:123",
      "company_name": "Example Corp",
      "vanity_url": "example-corp",
      "page_logo": "https://example.com/logo.png"
    }
  ]
}
```

--------------------------------

### GET /api/uploadposts/facebook/pages

Source: https://docs.upload-post.com/api/reference

Retrieve all Facebook pages accessible through connected accounts. Required for posting to specific Facebook pages.

```APIDOC
## GET /api/uploadposts/facebook/pages

### Description
Retrieve all Facebook pages accessible through connected accounts.

### Method
GET

### Endpoint
/api/uploadposts/facebook/pages

### Response
#### Success Response (200)
- **pages** (array) - List of Facebook pages.
  - **id** (string) - Page ID.
  - **name** (string) - Page name.
  - **profile_picture** (string) - URL of the profile picture.
  - **account** (object) - Associated account information.

#### Response Example
{
  "pages": [
    {
      "id": "123",
      "name": "My Page",
      "profile_picture": "https://example.com/pic.jpg",
      "account": {}
    }
  ]
}
```

--------------------------------

### GET /api/uploadposts/tiktok/locations

Source: https://docs.upload-post.com/api/reference

Search TikTok places to tag a location on a post with tiktok_location_id and tiktok_location_name. Returns location_id, location_name and postal address (max 20 matches).

```APIDOC
## [GET] /api/uploadposts/tiktok/locations

### Description
Search TikTok places to tag a location on a post with `tiktok_location_id` + `tiktok_location_name`.

### Method
GET

### Endpoint
/api/uploadposts/tiktok/locations

### Response
#### Success Response
- **location_id** (string) - The TikTok location ID.
- **location_name** (string) - The TikTok location name.
- **postal address** (string) - The postal address of the location.
- **max 20 matches** (number) - Maximum number of matches returned.

```

--------------------------------

### GET /api/uploadposts/tiktok/music/search

Source: https://docs.upload-post.com/api/reference

Search the Commercial Music Library by song title or artist. TikTok has no music search endpoint, so the search runs over the trending charts Upload-Post caches — not over TikTok's whole catalogue. Returns the same track objects as the trending endpoint, ranked by relevance.

```APIDOC
## [GET] /api/uploadposts/tiktok/music/search

### Description
Search the Commercial Music Library by song title or artist. TikTok has no music search endpoint, so the search runs over the trending charts Upload-Post caches — not over TikTok's whole catalogue.

### Method
GET

### Endpoint
/api/uploadposts/tiktok/music/search

### Response
#### Success Response
- **id** (string) - The track ID to send as `tiktok_music_id`.
- **titles** (string) - The track title.
- **artists** (string) - The artist name.
- **duration** (number) - The track duration.
- **artwork** (string) - URL to artwork.
- **audio previews** (string) - URL to audio preview.
- **relevance** (number) - Relevance ranking.

```

--------------------------------

### GET /api/uploadposts/media

Source: https://docs.upload-post.com/api/reference

Retrieve a list of recent media from any connected social media account. Supports multiple platforms including Instagram, TikTok, YouTube, LinkedIn, Facebook, X, Threads, Pinterest, Bluesky, and Reddit.

```APIDOC
## GET /api/uploadposts/media

### Description
Retrieve a list of recent media (posts, reels, videos, pins, tweets, etc.) from any connected social media account. Supports Instagram, TikTok, YouTube, LinkedIn, Facebook, X, Threads, Pinterest, Bluesky, and Reddit.

### Method
GET

### Endpoint
/api/uploadposts/media

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of media items to return. Default is 25, max 100, capped per platform. LinkedIn, Discord and Telegram support limit only.
- **cursor** (string) - Optional - Cursor for cursor-based pagination.

### Response
#### Success Response (200)
- **media_ids** (array) - List of media IDs
- **captions** (array) - Captions for each media item
- **media_types** (array) - Type of media (e.g., image, video)
- **permalinks** (array) - URLs to the media items
- **timestamps** (array) - Creation timestamps
- **thumbnail_urls** (array) - URLs to thumbnails

#### Response Example
{
  "media": [
    {
      "id": "123456",
      "caption": "Sample caption",
      "media_type": "IMAGE",
      "permalink": "https://example.com/post/123456",
      "timestamp": "2023-01-01T00:00:00Z",
      "thumbnail_url": "https://example.com/thumb.jpg"
    }
  ]
}
```

--------------------------------

### GET /api/uploadposts/status

Source: https://docs.upload-post.com/api/reference

Track the progress and results of asynchronous uploads initiated with async_upload=true or scheduled posts. Essential for monitoring long-running upload operations and checking scheduled post execution status.

```APIDOC
## [GET] /api/uploadposts/status

### Description
Track the progress and results of asynchronous uploads initiated with async_upload=true or scheduled posts. Essential for monitoring long-running upload operations and checking scheduled post execution status.

### Method
GET

### Endpoint
/api/uploadposts/status

### Parameters
#### Query Parameters
- **request_id** (string) - Required for async uploads - The request ID of the async upload.
- **job_id** (string) - Required for scheduled posts - The job ID of the scheduled post.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /api/uploadposts/tiktok/music/trending

Source: https://docs.upload-post.com/api/reference

List trending tracks from TikTok's Commercial Music Library — the catalogue of songs you can attach to a video through the API with tiktok_music_id. Returns track id, titles, artists, duration, artwork and audio previews.

```APIDOC
## [GET] /api/uploadposts/tiktok/music/trending

### Description
List trending tracks from TikTok's Commercial Music Library — the catalogue of songs you can attach to a video through the API with `tiktok_music_id`.

### Method
GET

### Endpoint
/api/uploadposts/tiktok/music/trending

### Response
#### Success Response
- **id** (string) - The track ID to send as `tiktok_music_id`.
- **titles** (string) - The track title.
- **artists** (string) - The artist name.
- **duration** (number) - The track duration.
- **artwork** (string) - URL to artwork.
- **audio previews** (string) - URL to audio preview.

```

--------------------------------

### ChatGPT Ads API

Source: https://docs.upload-post.com/api/reference

Run ads inside ChatGPT from the same API key you publish with. Connect an OpenAI Ads account once, then create campaigns, ad groups and ads, upload creatives and pull performance insights. Spend runs on your own OpenAI billing; every object is created paused unless you ask for active.

```APIDOC
## ChatGPT Ads API

### Description
Run ads inside ChatGPT from the same API key you publish with. Connect an OpenAI Ads account once, then create campaigns, ad groups and ads, upload creatives and pull performance insights. Spend runs on your own OpenAI billing; every object is created paused unless you ask for `active`.

### Endpoints
- `POST /api/uploadposts/ads/chatgpt/connect`
- `GET/DELETE /api/uploadposts/ads/chatgpt/accounts`
- `GET/POST /api/uploadposts/ads/chatgpt/campaigns`
- `GET/POST /api/uploadposts/ads/chatgpt/adgroups`
- `GET/POST /api/uploadposts/ads/chatgpt/ads`
- `POST /api/uploadposts/ads/chatgpt/creatives`
- `POST /api/uploadposts/ads/chatgpt/promote`
- `GET /api/uploadposts/ads/chatgpt/insights`

### Requirements
- An OpenAI Ads Manager account and an API key from [ads.openai.com](https://ads.openai.com) (one key per ad account)
```

--------------------------------

### POST /api/uploadposts/autodms/resume

Source: https://docs.upload-post.com/api/reference

Resume a paused AutoDM monitor.

```APIDOC
## POST /api/uploadposts/autodms/resume

### Description
Resume a paused AutoDM monitor.

### Method
POST

### Endpoint
/api/uploadposts/autodms/resume

### Parameters
#### Request Body
- **monitor_id** (string) - Required - The ID of the monitor to resume.

### Request Example
{
  "monitor_id": "monitor123"
}

### Response
#### Success Response (200)
- **status** (string) - Success message

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### Current User API

Source: https://docs.upload-post.com/api/reference

Validate your API key and retrieve basic account information including email and subscription plan.

```APIDOC
## Current User API

### Description
Validate your API key and retrieve basic account information including email and subscription plan.

### Endpoint
- `GET /api/uploadposts/me`

### Use Case
API key validation, plan verification, account confirmation
```

--------------------------------

### POST /api/uploadposts/posts/save

Source: https://docs.upload-post.com/api/reference

Save (repin) a Pinterest pin onto a board.

```APIDOC
## [POST] /api/uploadposts/posts/save

### Description
Save (repin) a Pinterest pin onto a board.

### Method
POST

### Endpoint
/api/uploadposts/posts/save

```

--------------------------------

### GET /api/uploadposts/dms/conversations

Source: https://docs.upload-post.com/api/reference

Retrieve Instagram DM conversations.

```APIDOC
## GET /api/uploadposts/dms/conversations

### Description
Retrieve Instagram DM conversations. Requires the instagram_business_manage_messages permission.

### Method
GET

### Endpoint
/api/uploadposts/dms/conversations

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of conversations to return.
- **cursor** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **conversations** (array) - List of conversations

#### Response Example
{
  "conversations": [
    {
      "id": "conversation123",
      "participants": ["user1", "user2"],
      "last_message": "Hello"
    }
  ]
}
```

--------------------------------

### POST /api/uploadposts/comments/create

Source: https://docs.upload-post.com/api/reference

Create a comment on a post or reply to a comment across supported platforms.

```APIDOC
## POST /api/uploadposts/comments/create

### Description
Create a comment on a post or reply to a comment across Instagram, Facebook, YouTube, LinkedIn, TikTok, X, Threads, and Bluesky.

### Method
POST

### Endpoint
/api/uploadposts/comments/create

### Parameters
#### Request Body
- **post_id** (string) - Required - The ID of the post to comment on.
- **comment_id** (string) - Optional - If provided, the comment is a reply to this comment.
- **message** (string) - Required - The text of the comment.

### Request Example
{
  "post_id": "123456",
  "comment_id": "comment123",
  "message": "Nice post!"
}

### Response
#### Success Response (200)
- **comment_id** (string) - ID of the created comment

#### Response Example
{
  "comment_id": "new_comment_123"
}
```

--------------------------------

### Schedule Management

Source: https://docs.upload-post.com/api/reference

Schedule posts for future publication across supported platforms. Manage your content calendar programmatically. Supported platforms include X (Twitter), LinkedIn, Facebook, Instagram, TikTok, Bluesky, Threads, Pinterest, YouTube, Discord, Telegram. Use an external_id on upload to map scheduled jobs back to your own system.

```APIDOC
## Schedule Management

### Description
Schedule posts for future publication across supported platforms. Manage your content calendar programmatically. Supported platforms include X (Twitter), LinkedIn, Facebook, Instagram, TikTok, Bluesky, Threads, Pinterest, YouTube, Discord, Telegram. Use an external_id on upload to map scheduled jobs back to your own system.

### Endpoint
Various scheduling endpoints

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /api/upload

Source: https://docs.upload-post.com/api/reference

Uploads videos to multiple social media platforms including TikTok, Instagram, LinkedIn, YouTube, Facebook, and more. Supports both synchronous and asynchronous uploads with scheduling capabilities. Reddit posting is currently unavailable.

```APIDOC
## POST /api/upload

### Description
Uploads videos to supported social media platforms. Supports both synchronous and asynchronous uploads with scheduling capabilities. Reddit posting is currently unavailable (HTTP 503 `error_code: "reddit_unavailable"`).

### Method
POST

### Endpoint
/api/upload

### Authentication
API key in the `Authorization` header.

### Supported Platforms
TikTok, Instagram, LinkedIn, YouTube, Facebook, X (Twitter), Threads, Pinterest, Bluesky, Discord, Telegram, Google Business Profile, Mastodon, WordPress. Reddit posting is currently unavailable (`reddit_unavailable`).

### Error Codes
- `reddit_unavailable` - Reddit posting is currently unavailable (HTTP 503).
```

--------------------------------

### POST /api/uploadposts/youtube/thumbnail

Source: https://docs.upload-post.com/api/reference

Set or replace the custom thumbnail of an already-published YouTube video from a file or a public URL.

```APIDOC
## [POST] /api/uploadposts/youtube/thumbnail

### Description
Set or replace the custom thumbnail of an already-published YouTube video from a file or a public URL.

### Method
POST

### Endpoint
/api/uploadposts/youtube/thumbnail

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /api/uploadposts/autodms/pause

Source: https://docs.upload-post.com/api/reference

Pause an AutoDM monitor.

```APIDOC
## POST /api/uploadposts/autodms/pause

### Description
Pause an AutoDM monitor.

### Method
POST

### Endpoint
/api/uploadposts/autodms/pause

### Parameters
#### Request Body
- **monitor_id** (string) - Required - The ID of the monitor to pause.

### Request Example
{
  "monitor_id": "monitor123"
}

### Response
#### Success Response (200)
- **status** (string) - Success message

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### POST /api/uploadposts/posts/retry

Source: https://docs.upload-post.com/api/reference

Re-enqueue platforms that failed on an upload. The original media snapshot is reused.

```APIDOC
## [POST] /api/uploadposts/posts/retry

### Description
Re-enqueue platforms that failed on an upload. The original media snapshot is reused.

### Method
POST

### Endpoint
/api/uploadposts/posts/retry

```

--------------------------------

### POST /api/uploadposts/posts/edit

Source: https://docs.upload-post.com/api/reference

Update caption or metadata on a live Facebook, LinkedIn, X, YouTube or Google Business post.

```APIDOC
## [POST] /api/uploadposts/posts/edit

### Description
Update caption or metadata on a live Facebook, LinkedIn, X, YouTube or Google Business post.

### Method
POST

### Endpoint
/api/uploadposts/posts/edit

```

--------------------------------

### GET/POST/DELETE /api/uploadposts/users/profile-webhook

Source: https://docs.upload-post.com/api/reference

Manage per-profile webhooks for real-time notifications about upload results and social account connection changes.

```APIDOC
## [GET/POST/DELETE] /api/uploadposts/users/profile-webhook

### Description
Manage per-profile webhooks for real-time notifications about upload results and social account connection changes.

### Method
GET, POST, DELETE

### Endpoint
/api/uploadposts/users/profile-webhook

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /api/uploadposts/rewrite-captions

Source: https://docs.upload-post.com/api/reference

Rewrite existing captions into another language. Uses the monthly AI Shorts quota of your plan.

```APIDOC
## [POST] /api/uploadposts/rewrite-captions

### Description
Rewrite existing captions into another language. Uses the monthly AI Shorts quota of your plan.

### Method
POST

### Endpoint
/api/uploadposts/rewrite-captions

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET/POST/DELETE /api/uploadposts/users/google-business-location

Source: https://docs.upload-post.com/api/reference

Pin one Google Business location to a profile so every upload from that profile publishes there without passing gbp_location_id. The pin takes precedence over the request parameter. Returns available locations plus the pinned gbp_location_id and gbp_location_name.

```APIDOC
## [GET/POST/DELETE] /api/uploadposts/users/google-business-location

### Description
Pin one Google Business location to a profile so every upload from that profile publishes there without passing `gbp_location_id`. Google's OAuth chooser only picks the Google account, so this is how a multi-location account stops being asked to select one on every post. The pin takes precedence over the request parameter.

### Method
GET, POST, DELETE

### Endpoint
/api/uploadposts/users/google-business-location

### Response
#### Success Response
- **gbp_location_id** (string) - The pinned Google Business location ID.
- **gbp_location_name** (string) - The pinned Google Business location name.
- **available locations** (array) - List of available locations.

```

--------------------------------

### POST /api/uploadposts/posts/repost

Source: https://docs.upload-post.com/api/reference

Reshare a LinkedIn post, retweet an X post or repost a Threads post.

```APIDOC
## [POST] /api/uploadposts/posts/repost

### Description
Reshare a LinkedIn post, retweet an X post or repost a Threads post.

### Method
POST

### Endpoint
/api/uploadposts/posts/repost

```

--------------------------------

### User Profiles API

Source: https://docs.upload-post.com/api/reference

Manage user profiles and generate JWTs for linking social accounts when integrating Upload-Post into your own platform. Essential for white-label integrations and multi-user applications.

```APIDOC
## User Profiles API

### Description
Manage user profiles and generate JWTs for linking social accounts when integrating Upload-Post into your own platform. Essential for white-label integrations and multi-user applications.

### Endpoints
- `POST /api/uploadposts/users` - Create user profiles
- `GET /api/uploadposts/users` - Retrieve user profiles
- `DELETE /api/uploadposts/users` - Delete user profiles
- `POST /api/uploadposts/users/generate-jwt` - Generate authentication tokens
- `GET /api/uploadposts/users/validate-jwt` - Validate tokens

### White-label
The connect page supports `en`, `es`, `de`, `fr`, `pt`, `pl` and `tr`, plus per-key text overrides via [`ui_labels`](./user-profiles.md#custom-ui-labels).

See the [User Profile Integration Guide](../guides/user-profile-integration.md) for implementation workflow.
```

--------------------------------

### POST /api/uploadposts/autodms/stop

Source: https://docs.upload-post.com/api/reference

Stop an AutoDM monitor.

```APIDOC
## POST /api/uploadposts/autodms/stop

### Description
Stop an AutoDM monitor.

### Method
POST

### Endpoint
/api/uploadposts/autodms/stop

### Parameters
#### Request Body
- **monitor_id** (string) - Required - The ID of the monitor to stop.

### Request Example
{
  "monitor_id": "monitor123"
}

### Response
#### Success Response (200)
- **status** (string) - Success message

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### GET/POST/DELETE /api/uploadposts/users/facebook-page

Source: https://docs.upload-post.com/api/reference

Pin a Facebook Page to a profile so every upload from that profile targets it without passing facebook_page_id. The pin takes precedence over the request parameter.

```APIDOC
## GET/POST/DELETE /api/uploadposts/users/facebook-page

### Description
Pin a Facebook Page to a profile so every upload from that profile targets it without passing `facebook_page_id`. The pin takes precedence over the request parameter.

### Method
GET, POST, DELETE

### Endpoint
/api/uploadposts/users/facebook-page

### Parameters
#### Request Body (POST)
- **facebook_page_id** (string) - Required - The ID of the Facebook Page to pin.

### Response
#### Success Response (200)
- **available_pages** (array) - List of available Facebook Pages.
- **pinned_facebook_page_id** (string) - The pinned page ID.
- **pinned_facebook_page_name** (string) - The pinned page name.

#### Response Example
{
  "available_pages": [],
  "pinned_facebook_page_id": "123",
  "pinned_facebook_page_name": "My Page"
}
```

--------------------------------

### POST /api/uploadposts/autodms/delete

Source: https://docs.upload-post.com/api/reference

Delete an AutoDM monitor.

```APIDOC
## POST /api/uploadposts/autodms/delete

### Description
Delete an AutoDM monitor.

### Method
POST

### Endpoint
/api/uploadposts/autodms/delete

### Parameters
#### Request Body
- **monitor_id** (string) - Required - The ID of the monitor to delete.

### Request Example
{
  "monitor_id": "monitor123"
}

### Response
#### Success Response (200)
- **status** (string) - Success message

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### POST /api/uploadposts/comments/action

Source: https://docs.upload-post.com/api/reference

Perform platform-specific actions on comments such as hide, like, pin, edit, hold, enable/disable comments, approve, or ignore.

```APIDOC
## POST /api/uploadposts/comments/action

### Description
Perform platform-specific actions on comments. Supported actions include hide/unhide, like/unlike, pin/unpin, Facebook edit, YouTube hold, Instagram enable_comments/disable_comments, Threads approve/ignore.

### Method
POST

### Endpoint
/api/uploadposts/comments/action

### Parameters
#### Request Body
- **comment_id** (string) - Required - The ID of the comment to act on.
- **action** (string) - Required - The action to perform. Possible values: hide, unhide, like, unlike, pin, unpin, edit, hold, enable_comments, disable_comments, approve, ignore.
- **additional_data** (object) - Optional - Platform-specific data (e.g., edited text for Facebook edit).

### Request Example
{
  "comment_id": "comment123",
  "action": "hide"
}

### Response
#### Success Response (200)
- **status** (string) - Success message

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### POST /api/upload_text

Source: https://docs.upload-post.com/api/reference

Creates and distributes text-only posts across social platforms. Ideal for announcements, updates, and text-based content. Also covers LinkedIn polls and long-form X Articles.

```APIDOC
## POST /api/upload_text

### Description
Creates and distributes text-only posts across supported social platforms. Ideal for announcements, updates, and text-based content. Also covers LinkedIn polls and long-form X Articles.

### Method
POST

### Endpoint
/api/upload_text

### Authentication
API key in the `Authorization` header.

### Supported Platforms
X (Twitter), LinkedIn, Facebook, Threads, Bluesky, Discord, Telegram, Google Business Profile, Slack, Mastodon, Nostr, Lemmy, Dev.to, Hashnode, WordPress, Whop, Listmonk. Reddit posting is currently unavailable (`reddit_unavailable`).

### Additional Features
- LinkedIn polls: `linkedin_poll_question` + `linkedin_poll_options[]`
- Long-form X Articles: `x_article_title`, publish or save as draft

### Error Codes
- `reddit_unavailable` - Reddit posting is currently unavailable.
```

--------------------------------

### POST /api/upload_photos

Source: https://docs.upload-post.com/api/reference

Uploads photos and image carousels to multiple social media platforms including LinkedIn, Facebook, X (Twitter), Instagram, TikTok, and more. Reddit posting is currently unavailable.

```APIDOC
## POST /api/upload_photos

### Description
Uploads photos and image carousels to supported social media platforms. Reddit posting is currently unavailable.

### Method
POST

### Endpoint
/api/upload_photos

### Authentication
API key in the `Authorization` header.

### Supported Platforms
LinkedIn, Facebook, X (Twitter), Instagram, TikTok, Threads, Pinterest, Bluesky, Discord, Telegram, Google Business Profile, Mastodon, Lemmy, WordPress. Reddit posting is currently unavailable (`reddit_unavailable`).

### Error Codes
- `reddit_unavailable` - Reddit posting is currently unavailable.
```
Tokens:
Raw