Skip to main content

​
Welcome to Postiz API

The Postiz Public API enables you to programmatically manage your social media content across 28+ platforms. Schedule posts, manage integrations, upload media, and more.

​
Base URL

All API endpoints are relative to: 
https://api.postiz.com
For self-hosted instances, use your custom domain.

​
API Version

The current API version is v1. All endpoints are prefixed with /public/v1/. 
https://api.postiz.com/public/v1/posts

​
Key Features

Schedule Posts

Create and schedule posts across multiple social media platforms simultaneously

Media Management

Upload images, videos, and other media files for your posts

Integration Control

List and manage your connected social media accounts

Rate Limited

30 requests per hour by default to ensure optimal performance

​
Quick Start

  1. Get your API key from the Postiz dashboard under Settings → API Keys
  2. Authenticate your requests by including the API key in the Authorization header
  3. Make your first request to create a post or list integrations
curl https://api.postiz.com/public/v1/integrations \
  -H "Authorization: YOUR_API_KEY"

​
SDKs and Tools

Postiz provides official SDKs and CLI tools to make integration easier:
  • Node.js SDK: @postiz/node - Full TypeScript support
  • CLI Tool: postiz - Command-line interface for all API operations

​
Response Format

All API responses are returned in JSON format: 
{
  "id": "post-123",
  "status": "scheduled",
  "date": "2024-12-31T12:00:00Z"
}

​
Error Handling

The API uses standard HTTP status codes:
  • 200 - Success
  • 400 - Bad Request (validation error)
  • 401 - Unauthorized (invalid API key)
  • 404 - Not Found
  • 429 - Too Many Requests (rate limit exceeded)
  • 500 - Internal Server Error
Error responses include a descriptive message: 
{
  "msg": "Invalid API key"
}

​
Available Endpoints

The Public API provides the following endpoints:

​
Posts

  • POST /public/v1/posts - Create and schedule posts
  • GET /public/v1/posts - List all posts with filtering
  • DELETE /public/v1/posts/:id - Delete a specific post
  • DELETE /public/v1/posts/group/:group - Delete all posts in a group
  • GET /public/v1/posts/:id/missing - Get missing content requirements
  • PUT /public/v1/posts/:id/release-id - Update post release ID

​
Media

  • POST /public/v1/upload - Upload media files
  • POST /public/v1/upload-from-url - Upload media from URL
  • POST /public/v1/generate-video - Generate AI videos
  • POST /public/v1/video/function - Video processing functions

​
Integrations

  • GET /public/v1/integrations - List connected platforms
  • GET /public/v1/is-connected - Check connection status
  • GET /public/v1/integration-settings/:id - Get platform-specific settings

​
Analytics & Notifications

  • GET /public/v1/analytics/:integration - Get platform analytics
  • GET /public/v1/notifications - List notifications

​
Utilities

  • GET /public/v1/find-slot/:id - Find next available time slot
Core endpoints are documented in detail in the Endpoints section. Advanced endpoints are available but may have limited documentation.

​
Next Steps

Authentication

Learn how to authenticate your API requests

Create Your First Post

Schedule a post to your social media accounts

Rate Limits

Understand API rate limiting policies

Node.js SDK

Use the official Node.js SDK

Build docs developers (and LLMs) love

Get started for freeTalk to us