Postiz

https://docs.postiz.com/
Admin
Postiz is a platform that helps users manage social media accounts by scheduling posts, generating...
Tokens:102,983
Snippets:973
Trust Score:9.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Dev Container CLI and Start

Source: https://docs.postiz.com/installation/devcontainer

Installs the Dev Container CLI globally and then starts a new dev container. This is the primary command for setting up the development environment.

```bash
npm install -g @devcontainers/cli
devcontainer up
```

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

### Upload and Post Workflow Example

Source: https://docs.postiz.com/cli/media-upload

This example demonstrates uploading a photo and then using its URL to create a post. Ensure you have `jq` installed for JSON parsing.

```bash
# 1. Upload the file
RESULT=$(postiz upload photo.jpg)
FILE_URL=$(echo "$RESULT" | jq -r '.path')

# 2. Use the URL in a post
postiz posts:create \
  -c "Check out this photo!" \
  -m "$FILE_URL" \
  -s "2025-01-15T10:00:00Z" \
  -i "your-integration-id"
```

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

### Install Nginx

Source: https://docs.postiz.com/reverse-proxies/nginx

Installs Nginx and enables it to start on boot. Tailored for Ubuntu/Debian systems.

```bash
sudo apt update && sudo apt install nginx -y
sudo systemctl start nginx && sudo systemctl enable nginx
```

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

### Complete Example: Private/Unlisted Video

Source: https://docs.postiz.com/public-api/providers/youtube

An example for setting up private or unlisted YouTube videos.

```APIDOC
## Complete Example: Private/Unlisted Video

```json
{
  "settings": {
    "__type": "youtube",
    "title": "Private Team Update",
    "type": "unlisted",
    "selfDeclaredMadeForKids": "no",
    "tags": []
  }
}
```
```

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

### Complete Example: Quick Announcement

Source: https://docs.postiz.com/public-api/providers/skool

An example of a 'now' type Skool post, suitable for immediate announcements or live session notifications.

```APIDOC
### Quick Announcement

```json
{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-skool-integration-id"
      },
      "value": [
        {
          "content": "We're going live in 30 minutes! Join us for a Q&A session about scaling your business.\n\nDrop your questions below and we'll cover them live! 🎙️",
          "image": []
        }
      ],
      "settings": {
        "__type": "skool",
        "group": "your-group-id",
        "label": "your-label-id",
        "title": "🔴 LIVE Q&A Starting Soon!"
      }
    }
  ]
}
```
```

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

### Complete Example: Post with Image

Source: https://docs.postiz.com/public-api/providers/skool

An example of a Skool post that includes an image, demonstrating how to attach media to your posts.

```APIDOC
### Post with Image

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-skool-integration-id"
      },
      "value": [
        {
          "content": "Here's my progress report for this month. Really happy with the results!\n\nKey metrics:\n- Revenue up 25%\n- New members: 150\n- Engagement rate: 45%",
          "image": [
            {
              "id": "metrics-image-id",
              "path": "https://uploads.postiz.com/metrics.png"
            }
          ]
        }
      ],
      "settings": {
        "__type": "skool",
        "group": "your-group-id",
        "label": "your-label-id",
        "title": "Monthly Progress Report - December 2024"
      }
    }
  ]
}
```
```

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

### Example Authorization URL

Source: https://docs.postiz.com/public-api/oauth

An example of the authorization URL with specific client ID and state parameters.

```bash
https://platform.postiz.com/oauth/authorize?client_id=pca_VklHTpdEJ6dJ73FHQEJ97qVA0lcMDsrs&response_type=code&state=random123
```

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

### Simple Pin Example (Minimal Settings)

Source: https://docs.postiz.com/public-api/providers/pinterest

An example of a simple Pin configuration using only the minimal required settings.

```APIDOC
### Simple Pin (Minimal Settings)

```json
{
  "settings": {
    "__type": "pinterest",
    "board": "1234567890123456789",
    "title": "",
    "link": "",
    "dominant_color": ""
  }
}
```
```

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

### Example Dev.to Post Configuration

Source: https://docs.postiz.com/public-api/providers/devto

An example of a complete post configuration, including content, settings, and scheduling. Note the nested structure for `posts` and `settings`.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-devto-integration-id"
      },
      "value": [
        {
          "content": "# Getting Started\n\nIn this tutorial, we'll explore...\n\n```javascript\nconst hello = 'world';\nconsole.log(hello);\n```\n\n## Conclusion\n\nThanks for reading!",
          "image": []
        }
      ],
      "settings": {
        "__type": "devto",
        "title": "10 JavaScript Tips for Better Code",
        "tags": [
          { "value": "javascript", "label": "javascript" },
          { "value": "webdev", "label": "webdev" },
          { "value": "tutorial", "label": "tutorial" },
          { "value": "beginners", "label": "beginners" }
        ]
      }
    }
  ]
}
```

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

### Complete Example: Public Video with Tags

Source: https://docs.postiz.com/public-api/providers/youtube

An example demonstrating how to configure settings for a public YouTube video, including title, visibility, and tags.

```APIDOC
## Complete Example: Public Video with Tags

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-youtube-integration-id"
      },
      "value": [
        {
          "content": "In this video, I'll show you how to use the Postiz API to automate your social media workflow.\n\nTimestamps:\n0:00 Introduction\n1:30 Setup\n5:00 First API call\n10:00 Conclusion",
          "image": [
            {
              "id": "video-id",
              "path": "https://uploads.postiz.com/tutorial.mp4"
            }
          ]
        }
      ],
      "settings": {
        "__type": "youtube",
        "title": "How to Use Postiz API - Complete Tutorial",
        "type": "public",
        "selfDeclaredMadeForKids": "no",
        "tags": [
          { "value": "postiz", "label": "postiz" },
          { "value": "api", "label": "api" },
          { "value": "tutorial", "label": "tutorial" },
          { "value": "social media automation", "label": "social media automation" }
        ]
      }
    }
  ]
}
```
```

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

### Example: Text Post

Source: https://docs.postiz.com/public-api/providers/threads

A complete example demonstrating how to schedule a simple text post to Threads.

```APIDOC
## Text Post

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-threads-integration-id"
      },
      "value": [
        {
          "content": "Hello from the Postiz API!",
          "image": []
        }
      ],
      "settings": {
        "__type": "threads"
      }
    }
  ]
}
```
```

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

### Pin with All Options Example

Source: https://docs.postiz.com/public-api/providers/pinterest

An example demonstrating a Pin with all available settings configured, including detailed content, image, and comprehensive Pinterest settings.

```APIDOC
### Pin with All Options

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-pinterest-integration-id"
      },
      "value": [
        {
          "content": "Try this delicious recipe! Perfect for summer dinners. Full recipe on my blog 👇",
          "image": [
            {
              "id": "recipe-image-id",
              "path": "https://uploads.postiz.com/recipe.jpg"
            }
          ]
        }
      ],
      "settings": {
        "__type": "pinterest",
        "board": "9876543210987654321",
        "title": "Easy Summer Pasta Recipe",
        "link": "https://myrecipes.com/summer-pasta",
        "dominant_color": "#E8B4B8"
      }
    }
  ]
}
```
```

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

### Complete Example: Video with Custom Thumbnail

Source: https://docs.postiz.com/public-api/providers/youtube

An example showing how to include a custom thumbnail for a YouTube video upload.

```APIDOC
## Complete Example: Video with Custom Thumbnail

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-youtube-integration-id"
      },
      "value": [
        {
          "content": "Full video description here...",
          "image": [
            {
              "id": "video-id",
              "path": "https://uploads.postiz.com/video.mp4"
            }
          ]
        }
      ],
      "settings": {
        "__type": "youtube",
        "title": "My Awesome Video",
        "type": "public",
        "selfDeclaredMadeForKids": "no",
        "thumbnail": {
          "id": "thumb-id",
          "path": "https://uploads.postiz.com/thumbnail.jpg"
        },
        "tags": []
      }
    }
  ]
}
```
```

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

### Complete Forum Post Example

Source: https://docs.postiz.com/public-api/providers/whop

This example demonstrates how to schedule a forum post with content and a title. It includes integration details and the Whop-specific settings.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-whop-integration-id"
      },
      "value": [
        {
          "content": "# Weekly Update\n\nHere's what we shipped this week:\n\n- New dashboard redesign\n- Performance improvements\n- Bug fixes\n\nLet us know what you think!",
          "image": []
        }
      ],
      "settings": {
        "__type": "whop",
        "company": "biz_xxxxxxxxxxxx",
        "experience": "exp_xxxxxxxxxxxx",
        "title": "Weekly Update - Dec 14"
      }
    }
  ]
}
```

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

### Complete Example: Community Post

Source: https://docs.postiz.com/public-api/providers/skool

An example of a complete Skool post configuration, including content, image (optional), and settings.

```APIDOC
### Community Post

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-skool-integration-id"
      },
      "value": [
        {
          "content": "Hey everyone! 👋\n\nI wanted to share some tips that helped me grow my community:\n\n1. Be consistent with posting\n2. Engage with every comment\n3. Create valuable content\n\nWhat strategies have worked for you?",
          "image": []
        }
      ],
      "settings": {
        "__type": "skool",
        "group": "your-group-id",
        "label": "your-label-id",
        "title": "Community Growth Tips - What Worked For Me"
      }
    }
  ]
}
```
```

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

### Example: Post with Image

Source: https://docs.postiz.com/public-api/providers/mastodon

This example demonstrates how to include an image with a post to Mastodon.

```APIDOC
### Post with Image

```json
{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-mastodon-integration-id"
      },
      "value": [
        {
          "content": "Sharing a launch screenshot",
          "image": [
            {
              "id": "image-id",
              "path": "https://uploads.postiz.com/launch.png"
            }
          ]
        }
      ],
      "settings": {
        "__type": "mastodon"
      }
    }
  ]
}
```
```

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

### WordPress Post Publishing Example

Source: https://docs.postiz.com/public-api/providers/wordpress

An example demonstrating how to structure data for publishing a post to WordPress, including content and settings.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-wordpress-integration-id"
      },
      "value": [
        {
          "content": "<h2>Introduction</h2>\n<p>Welcome to our latest blog post...</p>\n\n<h2>Main Content</h2>\n<p>Here's what you need to know...</p>",
          "image": []
        }
      ],
      "settings": {
        "__type": "wordpress",
        "title": "Latest Company Updates",
        "type": "post"
      }
    }
  ]
}
```

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

### Example: Text Post

Source: https://docs.postiz.com/public-api/providers/mastodon

This example demonstrates how to schedule a simple text post to Mastodon.

```APIDOC
## Complete Example

### Text Post

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-mastodon-integration-id"
      },
      "value": [
        {
          "content": "Hello from the Postiz API! 🐘",
          "image": []
        }
      ],
      "settings": {
        "__type": "mastodon"
      }
    }
  ]
}
```
```

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

### Complete Example for Scheduling X Post

Source: https://docs.postiz.com/public-api/providers/x

This example demonstrates how to schedule a single X (Twitter) post with specified settings.

```APIDOC
## Complete Example

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-x-integration-id"
      },
      "value": [
        {
          "content": "Hello from the Postiz API! 🚀",
          "image": []
        }
      ],
      "settings": {
        "__type": "x",
        "who_can_reply_post": "everyone",
        "community": "",
        "made_with_ai": false,
        "paid_partnership": false
      }
    }
  ]
}
```
```

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

### Post with Image Example

Source: https://docs.postiz.com/public-api/providers/bluesky

Example of how to create a post on Bluesky that includes an image.

```APIDOC
## Post with Image

```json
{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-bluesky-integration-id"
      },
      "value": [
        {
          "content": "Sharing today's launch screenshot",
          "image": [
            {
              "id": "image-id",
              "path": "https://uploads.postiz.com/launch.png"
            }
          ]
        }
      ],
      "settings": {
        "__type": "bluesky"
      }
    }
  ]
}
```
```

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

### Complete Example: Text Post for Threads

Source: https://docs.postiz.com/public-api/providers/threads

Example of a complete JSON payload for scheduling a simple text post to Threads.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-threads-integration-id"
      },
      "value": [
        {
          "content": "Hello from the Postiz API!",
          "image": []
        }
      ],
      "settings": {
        "__type": "threads"
      }
    }
  ]
}
```

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

### Thread Post Example

Source: https://docs.postiz.com/public-api/providers/bluesky

Example of how to create a thread on Bluesky by chaining multiple posts.

```APIDOC
## Thread Post

Create a thread by adding multiple items to the `value` array. Each entry becomes a reply chained to the previous one:

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-bluesky-integration-id"
      },
      "value": [
        {
          "content": "1/ Starting a thread on Bluesky from the API",
          "image": []
        },
        {
          "content": "2/ Each value entry becomes a reply in the thread",
          "image": []
        }
      ],
      "settings": {
        "__type": "bluesky"
      }
    }
  ]
}
```
```

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

### Text Post Example

Source: https://docs.postiz.com/public-api/providers/bluesky

Example of how to create a simple text post on Bluesky.

```APIDOC
## Text Post

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-bluesky-integration-id"
      },
      "value": [
        {
          "content": "Hello from the Postiz API! 🦋",
          "image": []
        }
      ],
      "settings": {
        "__type": "bluesky"
      }
    }
  ]
}
```
```

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

### Complete Example: Thread Post for Threads

Source: https://docs.postiz.com/public-api/providers/threads

Example of creating a thread by adding multiple entries to the `value` array, where each entry becomes a reply.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-threads-integration-id"
      },
      "value": [
        {
          "content": "1/ Starting a thread on Threads from the API",
          "image": []
        },
        {
          "content": "2/ Each value entry becomes a reply",
          "image": []
        }
      ],
      "settings": {
        "__type": "threads"
      }
    }
  ]
}
```

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

### Create Post - LinkedIn Example

Source: https://docs.postiz.com/public-api/posts/create

Example for creating a post on LinkedIn. Supports basic content and image attachments.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-linkedin-integration-id"
      },
      "value": [
        {
          "content": "Check out our latest product showcase!",
          "image": []
        }
      ],
      "settings": {
        "__type": "linkedin",
        "post_as_images_carousel": false
      }
    }
  ]
}
```

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

### Example: Thread Post

Source: https://docs.postiz.com/public-api/providers/threads

An example showing how to create a thread on Threads by chaining multiple posts together within the `value` array.

```APIDOC
## Thread Post

Create a thread by adding multiple items to the `value` array. Each entry becomes a reply chained to the previous post:

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-threads-integration-id"
      },
      "value": [
        {
          "content": "1/ Starting a thread on Threads from the API",
          "image": []
        },
        {
          "content": "2/ Each value entry becomes a reply",
          "image": []
        }
      ],
      "settings": {
        "__type": "threads"
      }
    }
  ]
}
```
```

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

### Verify Postiz CLI Installation

Source: https://docs.postiz.com/cli/introduction

Verify that the Postiz CLI has been installed correctly by running the help command. This should display available commands and options.

```bash
postiz --help
```

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

### Complete Example: Post with Image for Threads

Source: https://docs.postiz.com/public-api/providers/threads

Example of scheduling a post to Threads that includes an image. The image is specified with an `id` and `path`.

```json
{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-threads-integration-id"
      },
      "value": [
        {
          "content": "Sharing today's launch screenshot",
          "image": [
            {
              "id": "image-id",
              "path": "https://uploads.postiz.com/launch.png"
            }
          ]
        }
      ],
      "settings": {
        "__type": "threads"
      }
    }
  ]
}
```

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

### Create Post - X (Twitter) Example

Source: https://docs.postiz.com/public-api/posts/create

Example for creating a post on X (Twitter). Includes platform-specific settings like 'who_can_reply_post'.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-x-integration-id"
      },
      "value": [
        {
          "content": "Hello from the Postiz API!",
          "image": []
        }
      ],
      "settings": {
        "__type": "x",
        "who_can_reply_post": "everyone",
        "community": ""
      }
    }
  ]
}
```

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

### Basic Pin Example

Source: https://docs.postiz.com/public-api/providers/pinterest

A basic example of how to schedule a Pin with minimal settings, including content, image, and essential Pinterest settings.

```APIDOC
### Basic Pin

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-pinterest-integration-id"
      },
      "value": [
        {
          "content": "Beautiful home decor inspiration for your living room! 🏠✨",
          "image": [
            {
              "id": "pin-image-id",
              "path": "https://uploads.postiz.com/decor.jpg"
            }
          ]
        }
      ],
      "settings": {
        "__type": "pinterest",
        "board": "1234567890123456789",
        "title": "Living Room Decor Ideas",
        "link": "https://myblog.com/living-room-decor",
        "dominant_color": ""
      }
    }
  ]
}
```
```

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

### Standard Google My Business Post Example

Source: https://docs.postiz.com/public-api/providers/gmb

Example configuration for a standard Google My Business post. Ensure `__type` is set to 'gmb' and `topicType` is 'STANDARD'.

```json
{
  "settings": {
    "__type": "gmb",
    "topicType": "STANDARD",
    "callToActionType": "LEARN_MORE",
    "callToActionUrl": "https://example.com/news"
  }
}
```

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

### Install Postiz CLI with npm

Source: https://docs.postiz.com/cli/introduction

Install the Postiz CLI globally using npm. This command makes the 'postiz' command available in your terminal.

```bash
npm install -g postiz
```

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

### Thread Example for Scheduling X Posts

Source: https://docs.postiz.com/public-api/providers/x

This example shows how to create and schedule an X (Twitter) thread by providing multiple items in the `value` array.

```APIDOC
## Thread Example

Create a thread by adding multiple items to the `value` array:

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-x-integration-id"
      },
      "value": [
        {
          "content": "1/ This is the first tweet in my thread",
          "image": []
        },
        {
          "content": "2/ This is the second tweet",
          "image": []
        },
        {
          "content": "3/ And this is the final tweet!",
          "image": []
        }
      ],
      "settings": {
        "__type": "x",
        "who_can_reply_post": "everyone"
      }
    }
  ]
}
```
```

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

### GET /posts/{id}/missing OpenAPI Specification

Source: https://docs.postiz.com/public-api/posts/missing-content

This OpenAPI specification defines the GET /posts/{id}/missing endpoint. It details the request parameters, response structure, and provides an example of the expected JSON response for missing content items.

```yaml
GET /posts/{id}/missing
openapi: 3.1.0
info:
  title: Postiz Public API
  description: >-
    API for managing social media posts, integrations, and media uploads in
    Postiz.


    ## Authentication


    All endpoints require an API key passed in the `Authorization` header:

    ```

    Authorization: your-api-key

    ```


    Get your API key from Postiz Settings.


    ## Rate Limits


    There is a limit of **30 requests per hour**.


    ## Terminology


    The UI uses `channel`, but the API uses `integration`. They refer to the
    same thing.


    ## Supported Platforms (27) 


    **Social Platforms:** X (Twitter), LinkedIn, LinkedIn Page, Facebook, 
    Instagram, Instagram Standalone, Threads, Bluesky, Mastodon, Warpcast
    (Farcaster), Nostr, VK


    **Video Platforms:** YouTube, TikTok


    **Community Platforms:** Reddit, Lemmy, Discord, Slack, Telegram


    **Design Platforms:** Pinterest, Dribbble


    **Blogging Platforms:** Medium, Dev.to, Hashnode, WordPress


    **Business:** Google My Business (GMB), Listmonk (newsletters)
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.postiz.com/public/v1
    description: Postiz Cloud
  - url: https://{your-domain}/api/public/v1
    description: Self-hosted
    variables:
      your-domain:
        default: localhost:5000
        description: Your Postiz instance domain
security:
  - ApiKeyAuth: []
tags:
  - name: Integrations
    description: Manage connected social media channels
  - name: Posts
    description: Create, list, and delete posts
  - name: Uploads
    description: Upload media files
  - name: Notifications
    description: View organization notifications
  - name: Analytics
    description: View analytics for integrations and posts
  - name: Video Generation
    description: Generate videos with AI
paths:
  /posts/{id}/missing:
    get:
      tags:
        - Posts
      summary: Get missing content
      description: >-
        When a post has been published but the platform did not return a usable
        post ID (the `releaseId` is set to `"missing"`), this endpoint fetches
        recent content from the provider so you can match and connect the
        correct one to the post.


        The provider must implement the optional `missing` method. If the
        provider does not support it, an empty array is returned.
      operationId: getMissingContent
      parameters:
        - name: id
          in: path
          required: true
          description: Post ID
          schema:
            type: string
      responses:
        '200':
          description: List of recent content items from the provider
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MissingContentItem'
              example:
                - id: '7321456789012345678'
                  url: https://p16-sign.tiktokcdn-us.com/obj/cover-image.jpeg
                - id: '7321456789012345679'
                  url: https://p16-sign.tiktokcdn-us.com/obj/cover-image2.jpeg
components:
  schemas:
    MissingContentItem:
      type: object
      properties:
        id:
          type: string
          description: Platform-specific content ID
        url:
          type: string
          description: Thumbnail or preview URL for the content
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Your Postiz API key

```

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

### Configure Environment Variables

Source: https://docs.postiz.com/installation/development

Copy the example environment file and populate it with your specific database, Redis, JWT, and other service credentials. Ensure all required settings are provided for local development.

```bash
# Required Settings
DATABASE_URL="postgresql://postiz-user:postiz-password@localhost:5432/postiz-db-local"
REDIS_URL="redis://localhost:6379"
JWT_SECRET="random string for your JWT secret, make it long"
FRONTEND_URL="http://localhost:4200"
NEXT_PUBLIC_BACKEND_URL="http://localhost:3000"
BACKEND_INTERNAL_URL="http://localhost:3000"
TEMPORAL_ADDRESS="localhost:7233"

# Optional. Your upload directory path if you host your files locally.
UPLOAD_DIRECTORY="/opt/postiz/uploads/"

# Optional: your upload directory slug if you host your files locally.
NEXT_PUBLIC_UPLOAD_STATIC_DIRECTORY=""

# Your email provider, optional
EMAIL_PROVIDER="resend|nodemailer"
RESEND_API_KEY="re_1234567890" # api key if you choose resend
EMAIL_HOST="smtp.gmail.com" # smtp host if you choose nodemailer
EMAIL_PORT="465" # smtp port if you choose nodemailer
EMAIL_SECURE="true" # smtp secure if you choose nodemailer
EMAIL_USER="user" # smtp user if you choose nodemailer
EMAIL_PASS="pass" # smtp pass if you choose nodemailer

## These are dummy values, you must create your own from Cloudflare.
## Remember to set your public internet IP address in the allow-list for the API token.
CLOUDFLARE_ACCOUNT_ID="QhcMSXQyPuMCRpSQcSYdEuTYgHeCXHbu"
CLOUDFLARE_ACCESS_KEY="dcfCMSuFEeCNfvByUureMZEfxWJmDqZe"
CLOUDFLARE_SECRET_ACCESS_KEY="zTTMXBmtyLPwHEdpACGHgDgzRTNpTJewiNriLnUS"
CLOUDFLARE_BUCKETNAME="postiz"
CLOUDFLARE_BUCKET_URL="https://QhcMSXQyPuMCRpSQcSYdEuTYgHeCXHbu.r2.cloudflarestorage.com/"
CLOUDFLARE_REGION="auto"

# Social Media API Settings
X_API_KEY="Twitter API key for normal oAuth not oAuth2"
X_API_SECRET="Twitter API secret for normal oAuth not oAuth2"
LINKEDIN_CLIENT_ID="Linkedin Client ID"
LINKEDIN_CLIENT_SECRET="Linkedin Client Secret"
REDDIT_CLIENT_ID="Reddit Client ID"
REDDIT_CLIENT_SECRET="Linkedin Client Secret"
GITHUB_CLIENT_ID="GitHub Client ID"
GITHUB_CLIENT_SECRET="GitHub Client Secret"

# AI
OPENAI_API_KEY="OpenAI API key"

# Developer Settings
NX_ADD_PLUGINS=false
IS_GENERAL="true" # required for now

```

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

### Get Pinterest Boards

Source: https://docs.postiz.com/cli/integrations

An example of triggering a tool to retrieve Pinterest boards. It uses the integration ID 'pinterest-id' and the method 'getBoards'.

```bash
postiz integrations:trigger pinterest-id getBoards
```

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

### Example Hashnode Article Post Configuration

Source: https://docs.postiz.com/public-api/providers/hashnode

An example demonstrating how to structure a post for Hashnode, including content and specific settings. Note the required fields like title, publication, and tags.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-hashnode-integration-id"
      },
      "value": [
        {
          "content": "# Introduction\n\nWelcome to this comprehensive guide...\n\n## Prerequisites\n\n- Node.js installed\n- Basic JavaScript knowledge\n\n## Getting Started\n\nLet\'s begin...",
          "image": []
        }
      ],
      "settings": {
        "__type": "hashnode",
        "title": "Complete Guide to TypeScript",
        "subtitle": "From basics to advanced patterns",
        "publication": "your-publication-id",
        "tags": [
          { "value": "typescript-id", "label": "TypeScript" },
          { "value": "javascript-id", "label": "JavaScript" }
        ]
      }
    }
  ]
}
```

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

### Get LinkedIn Company Pages

Source: https://docs.postiz.com/cli/integrations

An example of triggering a tool to fetch LinkedIn company pages. It uses the integration ID 'linkedin-id' and the method 'getCompanies'.

```bash
postiz integrations:trigger linkedin-id getCompanies
```

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

### Create Post - General Example

Source: https://docs.postiz.com/public-api/posts/create

Example for creating a post on platforms like Threads, Mastodon, Bluesky, Telegram, Nostr, VK, and Kick. Requires an integration ID and post content.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-integration-id"
      },
      "value": [
        {
          "content": "Hello world!",
          "image": []
        }
      ],
      "settings": {
        "__type": "bluesky"
      }
    }
  ]
}
```

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

### Get YouTube Playlists

Source: https://docs.postiz.com/cli/integrations

An example of triggering a tool to retrieve a list of YouTube playlists associated with an account. It uses the integration ID 'youtube-id' and the method 'getPlaylists'.

```bash
postiz integrations:trigger youtube-id getPlaylists
```

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

### Get Reddit Flairs for a Subreddit

Source: https://docs.postiz.com/cli/integrations

An example of triggering a tool to fetch Reddit flairs. It specifies the integration ID (assumed to be 'reddit-id'), the method 'getFlairs', and provides the subreddit name in the data payload.

```bash
postiz integrations:trigger reddit-id getFlairs -d '{"subreddit":"programming"}'
```

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

### Scripting Analytics with jq

Source: https://docs.postiz.com/cli/analytics

Use `jq` to extract specific metrics from the analytics output. Examples include getting follower count trends, percentage changes for all metrics, or the latest total for post metrics.

```bash
# Get just the follower count trend
postiz analytics:platform integration-id -d 30 | jq '.[] | select(.label=="Followers")'
```

```bash
# Get percentage changes for all metrics
postiz analytics:platform integration-id | jq '.[] | {label, percentageChange}'
```

```bash
# Get the latest total for each post metric
postiz analytics:post post-id | jq '.[] | {label, latest: .data[-1].total}'
```

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

### Run the Development Server

Source: https://docs.postiz.com/installation/development

Start the Postiz development server. After running this command, you can access the application in your browser.

```bash
pnpm run dev
```

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

### Story Post Example

Source: https://docs.postiz.com/public-api/providers/instagram

Example of how to post an Instagram Story.

```APIDOC
## Story Post

```json
{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-instagram-integration-id"
      },
      "value": [
        {
          "content": "",
          "image": [
            {
              "id": "story-image-id",
              "path": "https://uploads.postiz.com/story.jpg"
            }
          ]
        }
      ],
      "settings": {
        "__type": "instagram",
        "post_type": "story"
      }
    }
  ]
}
```
```

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

### Collaborative Post Example

Source: https://docs.postiz.com/public-api/providers/instagram

Example of creating a collaborative post with other users.

```APIDOC
## Collaborative Post

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-instagram-integration-id"
      },
      "value": [
        {
          "content": "Amazing collab with @partner! 🤝",
          "image": [
            {
              "id": "collab-image-id",
              "path": "https://uploads.postiz.com/collab.jpg"
            }
          ]
        }
      ],
      "settings": {
        "__type": "instagram",
        "post_type": "post",
        "collaborators": [
          { "label": "partner_username" }
        ]
      }
    }
  ]
}
```
```

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

### Carousel Post Example

Source: https://docs.postiz.com/public-api/providers/instagram

Example of creating a carousel post with multiple images.

```APIDOC
## Carousel Post

Create a carousel by adding multiple images:

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-instagram-integration-id"
      },
      "value": [
        {
          "content": "Swipe to see all the photos! 📸",
          "image": [
            { "id": "img1", "path": "https://uploads.postiz.com/1.jpg" },
            { "id": "img2", "path": "https://uploads.postiz.com/2.jpg" },
            { "id": "img3", "path": "https://uploads.postiz.com/3.jpg" }
          ]
        }
      ],
      "settings": {
        "__type": "instagram",
        "post_type": "post"
      }
    }
  ]
}
```
```

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

### Complete Moltbook Post Example

Source: https://docs.postiz.com/public-api/providers/moltbook

This example demonstrates how to structure a complete post for Moltbook, including scheduling, content, and Moltbook-specific settings. Replace 'your-moltbook-integration-id' and 'submolt-id' with your actual values.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-moltbook-integration-id"
      },
      "value": [
        {
          "content": "Hello Moltbook!",
          "image": []
        }
      ],
      "settings": {
        "__type": "moltbook",
        "submolt": "submolt-id"
      }
    }
  ]
}
```

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

### Feed Post Example

Source: https://docs.postiz.com/public-api/providers/instagram

Example of how to schedule a regular feed post to Instagram.

```APIDOC
## Feed Post

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-instagram-integration-id"
      },
      "value": [
        {
          "content": "Beautiful sunset today! 🌅\n\n#sunset #photography #nature",
          "image": [
            {
              "id": "image-id",
              "path": "https://uploads.postiz.com/sunset.jpg"
            }
          ]
        }
      ],
      "settings": {
        "__type": "instagram",
        "post_type": "post",
        "is_trial_reel": false,
        "collaborators": []
      }
    }
  ]
}
```
```

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

### Pin Example with All Options

Source: https://docs.postiz.com/public-api/providers/pinterest

Demonstrates a Pinterest Pin configuration including all available optional fields like title, link, and dominant color. Ensure the image path and integration ID are correctly set.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-pinterest-integration-id"
      },
      "value": [
        {
          "content": "Try this delicious recipe! Perfect for summer dinners. Full recipe on my blog 👇",
          "image": [
            {
              "id": "recipe-image-id",
              "path": "https://uploads.postiz.com/recipe.jpg"
            }
          ]
        }
      ],
      "settings": {
        "__type": "pinterest",
        "board": "9876543210987654321",
        "title": "Easy Summer Pasta Recipe",
        "link": "https://myrecipes.com/summer-pasta",
        "dominant_color": "#E8B4B8"
      }
    }
  ]
}
```

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

### Full Google My Business Post Schedule Example

Source: https://docs.postiz.com/public-api/providers/gmb

A comprehensive example demonstrating how to schedule a Google My Business offer post within a larger schedule object. This includes post content, image, and detailed offer settings.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-gmb-integration-id"
      },
      "value": [
        {
          "content": "🎉 Big Holiday Sale! Get 20% off all products this weekend only. Visit us in-store or shop online!",
          "image": [
            {
              "id": "img-id",
              "path": "https://uploads.postiz.com/sale-banner.jpg"
            }
          ]
        }
      ],
      "settings": {
        "__type": "gmb",
        "topicType": "OFFER",
        "callToActionType": "GET_OFFER",
        "callToActionUrl": "https://example.com/holiday-sale",
        "offerCouponCode": "HOLIDAY20",
        "offerTerms": "Valid December 14-15, 2024. In-store and online."
      }
    }
  ]
}
```

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

### Complete YouTube Upload Example (Video with Custom Thumbnail)

Source: https://docs.postiz.com/public-api/providers/youtube

An example demonstrating how to configure a YouTube upload with a custom thumbnail. Ensure the thumbnail object includes 'id' and 'path'.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-youtube-integration-id"
      },
      "value": [
        {
          "content": "Full video description here...",
          "image": [
            {
              "id": "video-id",
              "path": "https://uploads.postiz.com/video.mp4"
            }
          ]
        }
      ],
      "settings": {
        "__type": "youtube",
        "title": "My Awesome Video",
        "type": "public",
        "selfDeclaredMadeForKids": "no",
        "thumbnail": {
          "id": "thumb-id",
          "path": "https://uploads.postiz.com/thumbnail.jpg"
        },
        "tags": []
      }
    }
  ]
}
```

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

### Postiz CLI Quick Start: List Scheduled Posts

Source: https://docs.postiz.com/cli/introduction

List all scheduled posts managed by Postiz. This command helps you review upcoming content and their statuses.

```bash
postiz posts:list
```

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

### Example Lemmy Post Configuration

Source: https://docs.postiz.com/public-api/providers/lemmy

An example of a complete post configuration including Lemmy settings. This shows how to schedule a post with content and target specific Lemmy communities.

```json
{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-lemmy-integration-id"
      },
      "value": [
        {
          "content": "Check out this interesting article about open-source software!",
          "image": []
        }
      ],
      "settings": {
        "__type": "lemmy",
        "subreddit": [
          {
            "value": {
              "subreddit": "opensource",
              "id": "123456",
              "title": "Why Open Source Matters",
              "url": ""
            }
          }
        ]
      }
    }
  ]
}
```
Tokens:
Raw