postiz/apps/sdk
Nevo David d504fac08d feat: remove view, update package json for sdk build 2025-07-27 13:09:33 +07:00
..
src feat: update postiz sdk 2025-07-19 21:37:35 +07:00
.babelrc feat: sdk 2025-07-07 18:59:03 +07:00
.npmignore feat: sdk 2025-07-07 18:59:03 +07:00
README.md feat: postiz backlink 2025-07-07 19:13:15 +07:00
package.json feat: remove view, update package json for sdk build 2025-07-27 13:09:33 +07:00
tsconfig.json feat: sdk 2025-07-07 18:59:03 +07:00
tsup.config.ts feat: sdk 2025-07-07 18:59:03 +07:00

README.md

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.