PostFast API

I. Authentication

Overview

All API requests must be authenticated using an API key specific to your workspace. The API key must be included in the request headers as pf-api-key.

Generating an API Key

Users with an ADMIN role in a workspace can generate an API key from the Workspace Settings page within the PostFast web application. Each API key is uniquely tied to a single workspace and grants access only to the social media accounts connected within that specific workspace. This key is then used for authenticating your REST API requests.

Example Header:

pf-api-key: YOUR_WORKSPACE_API_KEY

Rate Limiting

All API endpoints are subject to both global rate limits and endpoint-specific limits. Rate limits are tracked per API key, meaning each workspace has its own separate rate limit allowances.

The most restrictive limit applies first - if any rate limit is exceeded, the request will be rejected with a 429 status code.

Global Rate Limits (All Endpoints)

• 60 requests per minute
• 150 requests per 5 minutes
• 300 requests per hour
• 2000 requests per day

Rate Limit Headers

API responses include relevant rate limit headers for active throttlers:

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

Header meanings:

• X-RateLimit-Limit-[throttler]: Maximum requests allowed
• X-RateLimit-Remaining-[throttler]: Requests remaining in window
• X-RateLimit-Reset-[throttler]: Seconds until window resets
• Retry-After-[throttler]: Seconds to wait before retry (when limited)

Rate Limit Exceeded (429 Response)

When rate limits are exceeded, you'll receive:

{
  "statusCode": 429,
  "message": "ThrottlerException: Too Many Requests"
}

Note: Headers vary by endpoint and show only active throttlers. Different endpoints may display different header combinations based on their specific rate limits.

III. Typical Workflow: Scheduling Posts with Media

1. Authentication: Ensure you have a valid pf-api-key for your workspace.
2. (Optional) Identify Target Account: Call GET /social-media/my-social-accounts to list available social media accounts and retrieve the id of the account you want to post to. Store these IDs as they are generally stable.
3. Request Signed URLs for Media: If your posts include media:
   • Call POST /file/get-signed-upload-urls with the contentType (e.g., image/png) and count.
   • Receive a response containing an array of { key, signedUrl } objects.
4. Upload Media to S3: For each media item:
   • Perform an HTTP PUT request to the signedUrl.
   • The request body must be the raw file data.
   • The Content-Type header of this PUT request must match the contentType used in the previous step.
   Node.jscURLPythonn8n

   // 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
   }

5. Create the Social Posts:
   • Call POST /social-posts.
   • In the request body, include an array of posts in the posts field, each containing content, scheduledAt, and socialMediaId.
   • If media was uploaded, populate the mediaItems array for each post using the key(s) from step 3 (e.g., image/a1b2c3d4-e5f6-7890-1234-567890abcdef.png). Ensure the type field ('IMAGE' or 'VIDEO') matches the key prefix.
   • Optionally include controls for platform-specific settings.