PostFast

https://postfa.st/docs
Admin
PostFast is a REST API that enables developers to programmatically manage social media content...
Tokens:14,462
Snippets:83
Trust Score:7.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Pinterest Boards

Source: https://postfa.st/docs

Retrieves all Pinterest boards for a connected Pinterest account. This is used to get the board ID required when creating Pinterest posts.

```APIDOC
## GET /social-media/{socialMediaId}/pinterest-boards

### Description
Retrieves all Pinterest boards for a connected Pinterest account. Use this to get the board ID required when creating Pinterest posts.

### Method
GET

### Endpoint
/social-media/{socialMediaId}/pinterest-boards

### Path Parameters
- **socialMediaId** (string) - Required - The ID of the connected Pinterest social media account (UUID format).

### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Success Response (200 OK)
An array of objects, each representing a Pinterest board:
  * **id**: string - Internal PostFast board ID.
  * **boardId**: string - Pinterest's native board ID (use this for `pinterestBoardId`).
  * **name**: string - Board name.
  * **description** (string | null) - Board description.
  * **imageUrl** (string | null) - Board cover image URL.

### Response Example
```json
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "boardId": "1234567890123456789",
    "name": "Travel Inspiration",
    "description": "My favorite travel destinations",
    "imageUrl": "https://i.pinimg.com/..."
  },
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "boardId": "9876543210987654321",
    "name": "Recipe Ideas",
    "description": null,
    "imageUrl": "https://i.pinimg.com/..."
  }
]
```
```

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

### Rate Limit Headers Example

Source: https://postfa.st/docs

API responses include these headers to indicate current rate limit status.

```http
X-RateLimit-Limit-short: 60
X-RateLimit-Remaining-short: 59
X-RateLimit-Reset-short: 60
X-RateLimit-Limit-medium: 150
X-RateLimit-Remaining-medium: 149
X-RateLimit-Reset-medium: 300
Retry-After-long: 2395
```

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

### Generate Connect URL

Source: https://postfa.st/docs

This example shows the structure of a connect URL response. The `token` is a JWT and should not be truncated. Share this URL with clients to allow them to connect social media accounts without a PostFast account.

```json
{
  "connectUrl": "https://app.postfa.st/connect?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3Jrc3BhY2VJZCI6ImYxYTJiM2M0LWQ1ZTYtNzg5MC0xMjM0LTU2Nzg5MGFiY2RlZiIsImV4cCI6MTcwOTI..."
}
```

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

### GET /social-media/:id/pinterest-boards

Source: https://postfa.st/docs

Retrieves a list of Pinterest boards for a specific connected social media account.

```APIDOC
## GET /social-media/:id/pinterest-boards

### Description
Retrieves a list of Pinterest boards for a specific connected social media account.

### Method
GET

### Endpoint
/social-media/:id/pinterest-boards

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the connected social media account.

#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Response
#### Success Response (200)
- **boards** (array) - A list of Pinterest boards, each with an ID and name.
```

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

### GET /social-media/my-social-accounts

Source: https://postfa.st/docs

Retrieves a list of all social media accounts connected to the user's workspace.

```APIDOC
## GET /social-media/my-social-accounts

### Description
Retrieves a list of all social media accounts connected to the user's workspace.

### Method
GET

### Endpoint
/social-media/my-social-accounts

### Parameters
#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Response
#### Success Response (200)
- **accounts** (array) - A list of connected social media accounts, each with an ID and platform name.
```

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

### Retrieve Pinterest Boards for an Account

Source: https://postfa.st/docs

Gets all Pinterest boards for a connected Pinterest account. Use the returned `boardId` when creating Pinterest posts. Rate limited to 90 requests per hour.

```curl
curl -X GET "https://api.postfa.st/social-media/550e8400-e29b-41d4-a716-446655440000/pinterest-boards" \
  -H "pf-api-key: YOUR_WORKSPACE_API_KEY"
```

```json
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "boardId": "1234567890123456789",
    "name": "Travel Inspiration",
    "description": "My favorite travel destinations",
    "imageUrl": "https://i.pinimg.com/..."
  },
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "boardId": "9876543210987654321",
    "name": "Recipe Ideas",
    "description": null,
    "imageUrl": "https://i.pinimg.com/..."
  }
]
```

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

### Get YouTube Playlists

Source: https://postfa.st/docs

Retrieves all YouTube playlists for a connected YouTube account. This is used to get the playlist ID if you want to add videos to a playlist after publishing.

```APIDOC
## GET /social-media/{socialMediaId}/youtube-playlists

### Description
Retrieves all YouTube playlists for a connected YouTube account. Use this to get the playlist ID if you want to add videos to a playlist after publishing.

### Method
GET

### Endpoint
/social-media/{socialMediaId}/youtube-playlists

### Path Parameters
- **socialMediaId** (string) - Required - The ID of the connected YouTube social media account (UUID format).

### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Success Response (200 OK)
An array of objects, each representing a YouTube playlist:
  * **id**: string - Internal PostFast playlist ID.
  * **playlistId**: string - YouTube's native playlist ID.
  * **title**: string - Playlist title.
  * **description** (string | null) - Playlist description.
  * **thumbnailUrl** (string | null) - URL of the playlist's thumbnail.

### Response Example
```json
[
  {
    "id": "770e8400-e29b-41d4-a716-446655440002",
    "playlistId": "PLabcdef1234567890",
    "title": "My Awesome Videos",
    "description": "A collection of my best videos.",
    "thumbnailUrl": "https://i.ytimg.com/..."
  },
  {
    "id": "880e8400-e29b-41d4-a716-446655440003",
    "playlistId": "PLfedcba0987654321",
    "title": "Tutorials",
    "description": null,
    "thumbnailUrl": null
  }
]
```
```

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

### Get Signed Upload URLs for Files

Source: https://postfa.st/docs

Request pre-signed S3 URLs for uploading files. Perform a PUT request to the signed URL with raw file data. The Content-Type header must match the one used during URL generation.

```javascript
const response = await fetch('https://api.postfa.st/file/get-signed-upload-urls', {
  method: 'POST',
  headers: {
    'pf-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contentType: 'image/png',
    count: 2
  })
});

const data = await response.json();
```

```json
[
  {
    "key": "image/a1b2c3d4-e5f6-7890-1234-567890abcdef.png",
    "signedUrl": "https://s3.amazonaws.com/postfast-uploads/image/a1b2c3d4-e5f6-7890-1234-567890abcdef.png?AWSAccessKeyId=AKIAEXAMPLE&Expires=1640995200&Signature=..."
  },
  {
    "key": "image/b2c3d4e5-f6a7-8901-2345-67890abcdef1.png",
    "signedUrl": "https://s3.amazonaws.com/postfast-uploads/image/b2c3d4e5-f6a7-8901-2345-67890abcdef1.png?AWSAccessKeyId=AKIAEXAMPLE&Expires=1640995200&Signature=..."
  }
]
```

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

### GET /social-posts/analytics

Source: https://postfa.st/docs

Retrieves analytics data for social posts.

```APIDOC
## GET /social-posts/analytics

### Description
Retrieves analytics data for social posts.

### Method
GET

### Endpoint
/social-posts/analytics

### Parameters
#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

#### Query Parameters
- **postId** (string) - Optional - Filter analytics for a specific post ID.
- **startDate** (string) - Optional - Filter analytics from a specific start date (YYYY-MM-DD).
- **endDate** (string) - Optional - Filter analytics up to a specific end date (YYYY-MM-DD).

### Response
#### Success Response (200)
- **analytics** (object) - An object containing various analytics metrics like likes, shares, comments, and reach.
```

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

### GET /social-posts

Source: https://postfa.st/docs

Retrieves a list of all social posts created through PostFast.

```APIDOC
## GET /social-posts

### Description
Retrieves a list of all social posts created through PostFast.

### Method
GET

### Endpoint
/social-posts

### Parameters
#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Response
#### Success Response (200)
- **posts** (array) - A list of social posts, each with details like content, scheduled time, and status.
```

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

### Get Signed Upload URLs

Source: https://postfa.st/docs

Obtain pre-signed S3 URLs for uploading files. After receiving the signed URLs, perform an HTTP PUT request to the `signedUrl` with the raw file data. The `Content-Type` header must match the `contentType` used to generate the URL.

```APIDOC
## POST /file/get-signed-upload-urls

### Description
Requests pre-signed S3 URLs for uploading files.

### Method
POST

### Endpoint
/file/get-signed-upload-urls

### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.
- **Content-Type** (string) - Required - Application JSON.

### Request Body
- **contentType** (string) - Required - The MIME type of the file to be uploaded.
- **count** (integer) - Required - The number of signed URLs to generate.

### Request Example
```json
{
  "contentType": "image/png",
  "count": 2
}
```

### Success Response (200 OK)
An array of objects, each containing:
  * **key**: string - The S3 object key for upload.
  * **signedUrl**: string - The pre-signed S3 URL for PUT request.

### Response Example
```json
[
  {
    "key": "image/a1b2c3d4-e5f6-7890-1234-567890abcdef.png",
    "signedUrl": "https://s3.amazonaws.com/postfast-uploads/image/a1b2c3d4-e5f6-7890-1234-567890abcdef.png?AWSAccessKeyId=AKIAEXAMPLE&Expires=1640995200&Signature=..."
  },
  {
    "key": "image/b2c3d4e5-f6a7-8901-2345-67890abcdef1.png",
    "signedUrl": "https://s3.amazonaws.com/postfast-uploads/image/b2c3d4e5-f6a7-8901-2345-67890abcdef1.png?AWSAccessKeyId=AKIAEXAMPLE&Expires=1640995200&Signature=..."
  }
]
```
```

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

### GET /social-media/:id/youtube-playlists

Source: https://postfa.st/docs

Retrieves a list of YouTube playlists for a specific connected social media account.

```APIDOC
## GET /social-media/:id/youtube-playlists

### Description
Retrieves a list of YouTube playlists for a specific connected social media account.

### Method
GET

### Endpoint
/social-media/:id/youtube-playlists

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the connected social media account.

#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Response
#### Success Response (200)
- **playlists** (array) - A list of YouTube playlists, each with an ID and title.
```

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

### Retrieve YouTube Playlists for an Account

Source: https://postfa.st/docs

Fetches all YouTube playlists for a connected YouTube account. Use this to get the playlist ID for adding videos to a playlist after publishing. Rate limited to 90 requests per hour.

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

### GET /social-media/:id/gbp-locations

Source: https://postfa.st/docs

Retrieves a list of Google Business Profile locations for a specific connected social media account.

```APIDOC
## GET /social-media/:id/gbp-locations

### Description
Retrieves a list of Google Business Profile locations for a specific connected social media account.

### Method
GET

### Endpoint
/social-media/:id/gbp-locations

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the connected social media account.

#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Response
#### Success Response (200)
- **locations** (array) - A list of Google Business Profile locations, each with an ID and name.
```

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

### Get Social Media Accounts

Source: https://postfa.st/docs

Retrieves a list of all social media accounts connected to your workspace. Account IDs are immutable and can be cached.

```APIDOC
## GET /social-media/my-social-accounts

### Description
Retrieves a list of social media accounts connected to the workspace associated with the API key. Social media account IDs are immutable and can be safely cached.

### Method
GET

### Endpoint
/social-media/my-social-accounts

### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Success Response (200 OK)
An array of objects, each representing a social media account:
  * **id**: string - Unique identifier for the account.
  * **platform**: string - E.g., "X", "FACEBOOK", "INSTAGRAM", "THREADS", "LINKEDIN", "TIKTOK", "YOUTUBE", "BLUESKY".
  * **platformUsername** (string) - Optional - Username on the platform.
  * **displayName** (string) - Optional - Display name.

### Response Example
```json
[
  {
    "id": "f1a2b3c4-d5e6-7890-1234-567890abcdef",
    "platform": "X",
    "platformUsername": "postfast_app",
    "displayName": "PostFast Official"
  },
  {
    "id": "a2b3c4d5-e6f7-8901-2345-67890abcdef1",
    "platform": "FACEBOOK",
    "platformUsername": null,
    "displayName": "My FB Page"
  }
]
```
```

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

### GET /social-posts

Source: https://postfa.st/docs

Query and paginate your social posts with filters. Supports filtering by platforms, statuses, and date ranges.

```APIDOC
## GET /social-posts

### Description
Query and paginate your social posts with filters. Supports filtering by platforms, statuses, and date ranges.

### Method
GET

### Endpoint
/social-posts

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number (0-based indexing)
- **limit** (integer) - Optional - Number of items per page (min: 1, max: 50)
- **platforms** (string) - Optional - Comma-separated platform values (e.g., FACEBOOK,INSTAGRAM)
- **statuses** (string) - Optional - Comma-separated status values (DRAFT, SCHEDULED, PUBLISHED, FAILED)
- **from** (ISO 8601) - Optional - Start date filter in UTC (inclusive, filters by scheduledAt)
- **to** (ISO 8601) - Optional - End date filter in UTC (inclusive, filters by scheduledAt)

### Response
#### Success Response (200)
- **data** (array) - Array of social post objects.
- **totalCount** (integer) - Total number of posts matching the query.
- **pageInfo** (object) - Pagination information.
  - **page** (integer) - Display page (1-based).
  - **hasNextPage** (boolean) - Indicates if more pages are available.
  - **perPage** (integer) - Number of items per page.

#### Response Example
```json
{
  "data": [
    {
      "id": "string (UUID)",
      "content": "string",
      "status": "DRAFT | SCHEDULED | PUBLISHED | FAILED",
      "approvalStatus": "PENDING_APPROVAL | IN_PROGRESS | APPROVED | REJECTED | NEEDS_WORK",
      "socialMediaId": "string (UUID)",
      "mediaItems": [
        {
          "key": "string",
          "type": "IMAGE | VIDEO",
          "url": "string",
          "sortOrder": 0
        }
      ],
      "scheduledAt": "2025-01-31T10:00:00.000Z",
      "publishedAt": "2025-01-31T10:00:00.000Z | null",
      "failedAt": "2025-01-31T10:00:00.000Z | null",
      "platformPostId": "string | null",
      "groupId": "string (UUID) | null",
      "lastError": {
        "message": "string",
        "code": "string | null"
      } | null,
      "firstComment": "string | null",
      "firstCommentError": "string | null"
    }
  ],
  "totalCount": 100,
  "pageInfo": {
    "page": 1,
    "hasNextPage": true,
    "perPage": 20
  }
}
```

### Request Example
```javascript
const response = await fetch('https://api.postfa.st/social-posts?page=0&limit=20', {
  method: 'GET',
  headers: {
    'pf-api-key': 'YOUR_API_KEY'
  }
});

const data = await response.json();
```
```

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

### Get YouTube Playlists

Source: https://postfa.st/docs

Retrieves a list of YouTube playlists for a connected social media account. Use the `playlistId` when creating YouTube posts.

```curl
curl -X GET "https://api.postfa.st/social-media/550e8400-e29b-41d4-a716-446655440000/youtube-playlists" \
  -H "pf-api-key: YOUR_WORKSPACE_API_KEY"
```

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

### Get Google Business Profile Locations

Source: https://postfa.st/docs

Retrieves all synced Google Business Profile locations for a connected account. Use the `locationId` when creating Google Business Profile posts.

```curl
curl -X GET "https://api.postfa.st/social-media/550e8400-e29b-41d4-a716-446655440000/gbp-locations" \
  -H "pf-api-key: YOUR_API_KEY"
```

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

### Get YouTube Playlists

Source: https://postfa.st/docs

Retrieves a list of YouTube playlists associated with a connected social media account. The `playlistId` from the response can be used when creating YouTube posts.

```APIDOC
## GET /social-media/{socialMediaId}/youtube-playlists

### Description
Retrieves a list of YouTube playlists for a given social media account.

### Method
GET

### Endpoint
/social-media/{socialMediaId}/youtube-playlists

### Parameters
#### Path Parameters
- **socialMediaId** (string) - Required - The ID of the connected YouTube social media account (UUID format).

#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Response
#### Success Response (200 OK)
An array of objects, each representing a YouTube playlist:
- **id** (string) - Internal PostFast playlist ID.
- **playlistId** (string) - YouTube's native playlist ID (use this for `youtubePlaylistId`).
- **title** (string) - Playlist title.
- **description** (string | null) - Playlist description.
- **thumbnailUrl** (string | null) - Playlist thumbnail image URL.

### Request Example
```bash
curl -X GET "https://api.postfa.st/social-media/550e8400-e29b-41d4-a716-446655440000/youtube-playlists" \
  -H "pf-api-key: YOUR_WORKSPACE_API_KEY"
```

### Response Example
```json
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "playlistId": "PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf",
    "title": "My Music Collection",
    "description": "Favorite songs and albums",
    "thumbnailUrl": "https://i.ytimg.com/"
  }
]
```
```

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

### Get Google Business Profile Locations

Source: https://postfa.st/docs

Retrieves all synced Google Business Profile locations for a connected account. The `locationId` from the response is needed when creating Google Business Profile posts.

```APIDOC
## GET /social-media/{socialMediaId}/gbp-locations

### Description
Returns all synced Google Business Profile locations for a connected account.

### Method
GET

### Endpoint
/social-media/{socialMediaId}/gbp-locations

### Parameters
#### Path Parameters
- **socialMediaId** (string) - Required - The UUID of the connected social media account where the platform is `GOOGLE_BUSINESS_PROFILE`.

#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

### Response
#### Success Response (200 OK)
An array of GBP location objects:
- **id** (string) - Internal UUID.
- **locationId** (string) - GBP resource name. Use as `gbpLocationId` when creating posts.
- **title** (string) - Business name.
- **address** (string) - Business address.
- **mapsUri** (string | null) - Google Maps link to the location.

### Request Example
```bash
curl -X GET "https://api.postfa.st/social-media/550e8400-e29b-41d4-a716-446655440000/gbp-locations" \
  -H "pf-api-key: YOUR_API_KEY"
```

### Response Example
```json
[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "locationId": "accounts/109049740544589765860/locations/4875357571247123933",
    "title": "PostFast HQ",
    "address": "123 Main St, Sofia, Bulgaria",
    "mapsUri": "https://maps.google.com/?cid=..."
  }
]
```
```

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

### Get Social Post Analytics

Source: https://postfa.st/docs

Fetches published posts along with their latest performance metrics. This endpoint is useful for tracking the engagement of your published content. It only returns posts that have been successfully published.

```APIDOC
## GET /social-posts/analytics

### Description
Fetch published posts with their latest performance metrics.

### Method
GET

### Endpoint
/social-posts/analytics

### Query Parameters
- **startDate** (ISO 8601 date) - Required - Start of date range (e.g. `2026-01-01T00:00:00.000Z`)
- **endDate** (ISO 8601 date) - Required - End of date range (e.g. `2026-01-31T23:59:59.999Z`)
- **socialMediaIds** (Comma-separated UUIDs) - Optional - Filter by specific social media account IDs.

### Response
#### Success Response (200 OK)
- **data** (array) - An array of published posts with their analytics.
  - **id** (string (UUID)) - The unique ID of the post.
  - **content** (string) - The content of the post.
  - **socialMediaId** (string (UUID)) - The ID of the social media account.
  - **platformPostId** (string) - The ID of the post on the social media platform.
  - **publishedAt** (string) - The ISO 8601 timestamp when the post was published.
  - **latestMetric** (object | null) - The latest performance metrics for the post.
    - **likes** (string) - Number of likes.
    - **comments** (string) - Number of comments.
    - **shares** (string) - Number of shares.
    - **impressions** (string) - Number of impressions.
    - **clicks** (string) - Number of clicks.
    - **reach** (string) - Number of reach.
    - **extras** (object) - Additional metrics.
      - **saves** (string) - Number of saves.
      - **reposts** (string) - Number of reposts.
    - **fetchedAt** (string) - The ISO 8601 timestamp when the metrics were fetched.

#### Response Example
```json
{
  "data": [
    {
      "id": "string (UUID)",
      "content": "string",
      "socialMediaId": "string (UUID)",
      "platformPostId": "string",
      "publishedAt": "2026-01-15T10:00:00.000Z",
      "latestMetric": {
        "likes": "1234",
        "comments": "56",
        "shares": "78",
        "impressions": "9012",
        "clicks": "345",
        "reach": "6789",
        "extras": {
          "saves": "12",
          "reposts": "3"
        },
        "fetchedAt": "2026-01-16T08:00:00.000Z"
      }
    }
  ]
}
```
```

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

### Create Post

Source: https://postfa.st/docs

This endpoint allows users to create and schedule posts with various media types and platform-specific configurations.

```APIDOC
## POST /posts

### Description
Creates a new post, which can be published immediately, scheduled for a future time, or saved as a draft. Supports various media types and platform-specific settings.

### Method
POST

### Endpoint
/posts

### Parameters
#### Request Body (`application/json`)
- **posts** (array) - Required - Array of post objects:
  - **content** (string) - Required - Text content of the post.
  - **mediaItems** (array) - Optional - Array of media item objects:
    - **key** (string) - Required - S3 object key obtained from `/file/get-signed-upload-urls`.
    - **type** (string) - Required - Type of media, either 'IMAGE' or 'VIDEO'.
    - **sortOrder** (number) - Required - Order of the media item in the sequence.
    - **coverTimestamp** (string) - Optional - Timestamp in milliseconds for video cover image (e.g., "5000"). Supported by TikTok, Instagram Reels, and Pinterest video pins.
    - **coverImageKey** (string) - Optional - S3 key for a custom cover image for videos. Overrides `coverTimestamp` on supported platforms.
  - **scheduledAt** (string) - Optional for drafts, otherwise required - ISO 8601 date-time string (UTC).
  - **socialMediaId** (string) - Required - ID of the social media account from `/social-media/my-social-accounts`.
  - **firstComment** (string) - Optional - Text for an automatic first comment. Supported on X, Instagram, Facebook, YouTube, and Threads.
- **status** (string) - Optional - Post status: 'DRAFT' or 'SCHEDULED'. Defaults to 'SCHEDULED'.
- **approvalStatus** (string) - Optional - Approval status: 'APPROVED' or 'PENDING_APPROVAL'. Defaults to 'APPROVED'.
- **controls** (object) - Optional - Platform-specific controls:
  - **X (Twitter) Controls:**
    - **xCommunityId** (string) - Optional - Community ID for X posts.
    - **xRetweetUrl** (string) - Optional - URL of a tweet to retweet.
  - **Instagram Controls:**
    - **instagramPublishType** (string) - Optional - 'TIMELINE', 'STORY', or 'REEL'. Defaults to 'TIMELINE'.
    - **instagramPostToGrid** (boolean) - Optional - Post to profile grid. Defaults to true.
    - **instagramCollaborators** (string[]) - Optional - Array of Instagram usernames for collaboration.
    - **instagramTrialReelStrategy** (string) - Optional - Strategy for publishing reels as trials.
  - **Facebook Controls:**
    - **facebookContentType** (string) - Optional - 'POST', 'REEL', or 'STORY'. Defaults to 'POST'.
    - **facebookReelsCollaborators** (string[]) - Optional - Array of Facebook usernames for Reel collaboration.
  - **TikTok Controls:**
    - **tiktokTitle** (string) - Optional - Visible carousel title for photo carousels (max 90 chars).
    - **tiktokPrivacy** (string) - Optional - Privacy setting: 'PUBLIC', 'MUTUAL_FRIENDS', 'FOLLOWER_OF_CREATOR', 'ONLY_ME'. Defaults to 'PUBLIC'.
    - **tiktokIsDraft** (boolean) - Optional - Save as draft. Defaults to false.
    - **tiktokAllowComments** (boolean) - Optional - Allow comments. Defaults to true.
    - **tiktokAllowDuet** (boolean) - Optional - Allow duets. Defaults to true.
    - **tiktokAllowStitch** (boolean) - Optional - Allow stitches. Defaults to true.
    - **tiktokBrandOrganic** (boolean) - Optional - Brand organic content. Defaults to false.
    - **tiktokBrandContent** (boolean) - Optional - Branded content. Defaults to false.
    - **tiktokAutoAddMusic** (boolean) - Optional - Auto-add music. Defaults to false.
    - **tiktokIsAigc** (boolean) - Optional - Disclose AI-generated content. Defaults to false.
  - **YouTube Controls:**
    - **youtubeThumbnailKey** (string) - Optional - S3 key for YouTube thumbnail.

### Request Example
```json
{
  "posts": [
    {
      "content": "Check out this new feature! #api",
      "mediaItems": [
        {
          "key": "s3://your-bucket/image.jpg",
          "type": "IMAGE",
          "sortOrder": 1
        }
      ],
      "scheduledAt": "2024-12-31T23:59:59.000Z",
      "socialMediaId": "your-social-media-id",
      "firstComment": "Excited to share!"
    }
  ],
  "status": "SCHEDULED",
  "controls": {
    "X (Twitter) Controls": {
      "xCommunityId": "your-community-id"
    },
    "Instagram Controls": {
      "instagramPublishType": "REEL",
      "instagramCollaborators": ["user1", "user2"]
    }
  }
}
```

### Response
#### Success Response (200)
- **postId** (string) - The ID of the created post.
- **status** (string) - The status of the created post.

#### Response Example
```json
{
  "postId": "post-12345",
  "status": "SCHEDULED"
}
```
```

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

### POST /social-media/connect-link

Source: https://postfa.st/docs

Initiates the process to connect a new social media account by providing a linking URL.

```APIDOC
## POST /social-media/connect-link

### Description
Initiates the process to connect a new social media account by providing a linking URL.

### Method
POST

### Endpoint
/social-media/connect-link

### Parameters
#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

#### Request Body (`application/json`)
- **platform** (string) - Required - The social media platform to connect (e.g., 'facebook', 'twitter', 'linkedin').
- **redirectUri** (string) - Required - The URI to redirect to after successful authentication.

### Request Example
```json
{
  "platform": "facebook",
  "redirectUri": "https://your-app.com/callback"
}
```

### Response
#### Success Response (200)
- **connectUrl** (string) - The URL to redirect the user to for authentication.
```

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

### POST /file/get-signed-upload-urls

Source: https://postfa.st/docs

Generates pre-signed URLs for uploading media files directly to S3. Supports images, videos, and documents with specific size and type limitations.

```APIDOC
## POST /file/get-signed-upload-urls

### Description
Generates pre-signed URLs for uploading media files (images, videos, or PDFs) directly to S3.

### Method
POST

### Endpoint
/file/get-signed-upload-urls

### Parameters
#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

#### Request Body
- **contentType** (string) - Required - The MIME type of the file.
  - Supported image types: `image/jpeg`, `image/png`, `image/gif`, `image/webp`.
  - Supported video types: `video/mp4`, `video/webm`, `video/mov`, `video/quicktime`.
  - Supported document types (for LinkedIn document posts only): `application/pdf`, `application/msword` (.doc), `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (.docx), `application/vnd.ms-powerpoint` (.ppt), `application/vnd.openxmlformats-officedocument.presentationml.presentation` (.pptx).
- **count** (number) - Required - Number of signed URLs.
  - Min: 1.
  - Max: 8 for images.
  - Max: 1 for videos (must be 1 if `contentType` is video).
  - Max: 1 for documents (must be 1 for PDF, DOC, DOCX, PPT, PPTX content types).

### Request Example
```json
{
  "contentType": "image/jpeg",
  "count": 3
}
```

### Response
#### Success Response (200)
- **urls** (array) - An array of pre-signed URLs for uploading files.
- **fileKey** (string) - The unique key for the uploaded file.
```

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

### Upload Media to S3 using Signed URL (Node.js)

Source: https://postfa.st/docs

This code demonstrates how to upload a file to S3 using a pre-signed URL obtained from the API. The Content-Type header must match the one used when requesting the signed URL.

```javascript
// Upload file to S3 using the signed URL from previous step  
const fs = require('fs');
const file = fs.readFileSync('/path/to/your/image.png');

const response = await fetch(signedUrl, {
  method: 'PUT',
  body: file,
  headers: {
    'Content-Type': 'image/png' // Must match contentType from step 1
  }
});

if (response.ok) {
  // File uploaded successfully
  // Use the 'key' from step 1 in your social posts
}
```

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

### Query Social Posts with Pagination (Node.js)

Source: https://postfa.st/docs

Fetch social posts using pagination. Request page 0 for the first page; the response will show page 1 in `pageInfo`. Use `pageInfo.hasNextPage` to determine if more pages are available and fetch subsequent pages with incrementing page numbers.

```javascript
const response = await fetch('https://api.postfa.st/social-posts?page=0&limit=20', {
  method: 'GET',
  headers: {
    'pf-api-key': 'YOUR_API_KEY'
  }
});

const data = await response.json();
// Request page=0 returns first page
// Response shows page: 1 in pageInfo (display number)
// Use page=1, page=2, etc. for subsequent pages

// Check if more pages available:
if (data.pageInfo.hasNextPage) {
  // Fetch next page with page=1
}
```

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

### Upload Media to S3

Source: https://postfa.st/docs

Obtains signed URLs for uploading media files to S3 and then uploads the file content using a PUT request.

```APIDOC
## PUT /file/get-signed-upload-urls (Media Upload)

### Description
This process involves two steps: first, obtaining a signed URL for uploading media, and second, using that URL to upload the actual file content to S3.

### Method
PUT

### Endpoint
[Signed URL obtained from POST /file/get-signed-upload-urls]

### Parameters
#### Request Body
- **file data** (binary) - Required - The raw binary data of the file to be uploaded.

#### Headers
- **Content-Type** (string) - Required - The MIME type of the file (e.g., `image/png`). Must match the `contentType` provided when requesting the signed URL.

### Request Example
```javascript
const fs = require('fs');
const file = fs.readFileSync('/path/to/your/image.png');

const response = await fetch(signedUrl, {
  method: 'PUT',
  body: file,
  headers: {
    'Content-Type': 'image/png' // Must match contentType from step 1
  }
});

if (response.ok) {
  // File uploaded successfully
  // Use the 'key' from step 1 in your social posts
}
```
```

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

### Create Social Posts

Source: https://postfa.st/docs

Creates new social posts, optionally including media and scheduling information.

```APIDOC
## POST /social-posts

### Description
Creates one or more social posts. You can include content, scheduling time, and associated media items. Platform-specific controls can also be applied.

### Method
POST

### Endpoint
/social-posts

### Request Body
- **posts** (array) - Required - An array of post objects to be created.
  - **content** (string) - Required - The main text content of the post.
  - **scheduledAt** (string) - Optional - The date and time the post should be published (ISO 8601 format).
  - **socialMediaId** (string) - Required - The ID of the social media account to post to.
  - **mediaItems** (array) - Optional - An array of media items to associate with the post.
    - **key** (string) - Required - The key (filename) of the uploaded media.
    - **type** (string) - Required - The type of media ('IMAGE' or 'VIDEO').
  - **controls** (object) - Optional - Platform-specific settings for the post.

### Request Example
```json
{
  "posts": [
    {
      "content": "Check out this new feature! #postfast",
      "scheduledAt": "2026-03-15T10:00:00.000Z",
      "socialMediaId": "account-id-123",
      "mediaItems": [
        {
          "key": "image/a1b2c3d4-e5f6-7890-1234-567890abcdef.png",
          "type": "IMAGE"
        }
      ],
      "controls": {
        "linkedin": {
          "commentPolicy": "ALLOWED"
        }
      }
    }
  ]
}
```
```

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

### Create TikTok Video Post

Source: https://postfa.st/docs

Use this endpoint to create a TikTok video post. Ensure the media item type is VIDEO and provide a cover timestamp. Controls for TikTok privacy, comments, and duets can be specified.

```javascript
const response = await fetch('https://api.postfa.st/social-posts', {
  method: 'POST',
  headers: {
    'pf-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    posts: [
      {
        content: "3 productivity hacks that changed my morning routine ☀️ Which one are you trying first? #productivity #morningroutine #lifehacks",
        mediaItems: [
          {
            key: "video/a7b8c9d1-e2f3-4567-8901-23456789abcd.mp4",
            type: "VIDEO",
            sortOrder: 0,
            coverTimestamp: "3000"
          }
        ],
        scheduledAt: "2025-01-31T10:00:00.000Z",
        socialMediaId: "550e8400-e29b-41d4-a716-446655440001"
      }
    ],
    controls: {
      tiktokPrivacy: "PUBLIC",
      tiktokAllowComments: true,
      tiktokAllowDuet: true
    }
  })
});

const data = await response.json();
```

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

### Request Body for Signed Upload URLs

Source: https://postfa.st/docs

Specify the content type and number of signed URLs needed for media uploads.

```json
{
  "contentType": "image/jpeg",
  "count": 3
}
```

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

### API Key Authentication Header

Source: https://postfa.st/docs

Include your workspace API key in the request headers for authentication.

```http
pf-api-key: YOUR_WORKSPACE_API_KEY
```

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

### POST /social-posts

Source: https://postfa.st/docs

Creates a new social post to be scheduled or published immediately.

```APIDOC
## POST /social-posts

### Description
Creates a new social post to be scheduled or published immediately.

### Method
POST

### Endpoint
/social-posts

### Parameters
#### Request Headers
- **pf-api-key** (string) - Required - Your workspace API key.

#### Request Body (`application/json`)
- **content** (string) - Required - The text content of the post.
- **mediaUrls** (array) - Optional - An array of URLs for media to be attached to the post.
- **scheduleTime** (string) - Optional - The ISO 8601 formatted date and time for scheduling the post.
- **accounts** (array) - Required - An array of social media account IDs to post to.

### Request Example
```json
{
  "content": "Check out our new product!",
  "mediaUrls": ["https://example.com/image.jpg"],
  "scheduleTime": "2023-10-27T10:00:00Z",
  "accounts": ["account_id_1", "account_id_2"]
}
```

### Response
#### Success Response (200)
- **postId** (string) - The ID of the newly created social post.
- **message** (string) - A confirmation message.
```

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

### Base URL for API Requests

Source: https://postfa.st/docs

The base URL for all PostFast API requests.

```text
https://api.postfa.st/
```

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

### POST /social-posts

Source: https://postfa.st/docs

Creates and schedules one or more social posts.

```APIDOC
## POST /social-posts

### Description
Creates and schedules one or more social posts.

### Method
POST

### Endpoint
/social-posts

### Parameters
#### Request Headers
- **pf-api-key** (string) - Required

### Request Example
(Request body and example response not provided in source)
```
Tokens:
Raw