postiz/apps/sdk/README.md

761 B

Postiz NodeJS SDK

This is the NodeJS SDK for Postiz.

You can start by installing the package:

npm install @postiz/node

Usage

import Postiz from '@postiz/node';
const postiz = new Postiz('your api key', 'your self-hosted instance (optional)');

The available methods are:

  • post(posts: CreatePostDto) - Schedule a post to Postiz
  • postList(filters: GetPostsDto) - Get a list of posts
  • upload(file: Buffer, extension: string) - Upload a file to Postiz
  • integrations() - Get a list of connected channels
  • deletePost(id: string) - Delete a post by ID

Alternatively you can use the SDK with curl, check the Postiz API documentation for more information.