Network options

What each network can be told, beyond the text and the media.

View as MarkdownOpenAPIBase URL https://postwire.io

Send them in options, keyed by network, on POST /api/post and POST /api/schedule (or inside a per_platform draft). A network ignores the options of the others.

Example

JSON
{
  "platforms": [
    "tiktok",
    "youtube",
    "instagram"
  ],
  "video_url": "https://example.com/clip.mp4",
  "text": "Proofing, 36 hours in 30 seconds",
  "options": {
    "tiktok": {
      "privacy_level": "PUBLIC_TO_EVERYONE",
      "ai_generated": false
    },
    "youtube": {
      "privacy": "public",
      "tags": [
        "sourdough",
        "baking"
      ]
    },
    "instagram": {
      "post_type": "reels"
    }
  }
}

A thread and a first comment

A thread on X, Bluesky and Mastodon: per_platform.<network>.thread is the list of posts after the text, each published as a reply to the one before (Bluesky reply refs, Mastodon in_reply_to_id). Or thread: true: PostWire splits a long text at the network's limit (X 280 as X counts, Bluesky 300, Mastodon 500 or the server's own), at paragraph, sentence or word boundaries, never inside a link. Media stays on the first post. Bluesky and Mastodon take up to 10 posts, X up to 26. A post over the limit is refused before anything goes out, never cut. A thread counts as one post of the plan.

First comment on LinkedIn, X, Bluesky and Mastodon: first_comment (in per_platform.<network> or options.<network>) is posted by the author right under the post, or under the last post of a thread. It is the place for the link: the post keeps its reach and the link is one tap away. On X it is the reply under the chain and uses X credits like any X post.

Every post's URL comes back in the result (thread.posts on Bluesky and Mastodon, thread.tweets on X). If the network refuses a later post, the posts before it stay published and the result names the one refused and lists the rest (thread.not_posted). A first comment that fails is tried again on its own later; the post is never sent twice.

A thread and a first comment

JSON
{
  "platforms": [
    "bluesky",
    "mastodon",
    "linkedin"
  ],
  "text": "We rebuilt our onboarding from scratch. Here is what changed.",
  "per_platform": {
    "bluesky": {
      "thread": [
        "Step 1: one screen instead of four.",
        "Step 2: connect a network before you write anything."
      ],
      "first_comment": "The full write-up: https://example.com/onboarding"
    },
    "mastodon": {
      "thread": true,
      "first_comment": "The full write-up: https://example.com/onboarding"
    },
    "linkedin": {
      "first_comment": "The full write-up: https://example.com/onboarding"
    }
  }
}

TikTok

FieldTypeDescription
options.tiktok.privacy_levelstringWho sees the post. Words also work: public, followers, friends, private. When TikTok does not allow the value for this creator, the closest allowed level that is not more open is used and the result says so. Default: the level saved for the connection (PATCH /api/connect/tiktok/settings with default_privacy public, followers, friends or private; null clears it), else SELF_ONLY. One of: PUBLIC_TO_EVERYONE, FOLLOWER_OF_CREATOR, MUTUAL_FOLLOW_FRIENDS, SELF_ONLY.
options.tiktok.disable_commentbooleanDefault false.
options.tiktok.disable_duetbooleanVideos only. Default false.
options.tiktok.disable_stitchbooleanVideos only. Default false.
options.tiktok.brand_organic_togglebooleanDiscloses that the post promotes the creator's own business. Default false.
options.tiktok.branded_content_togglebooleanDiscloses a paid partnership with a third party. Cannot be private. Default false.
options.tiktok.ai_generatedbooleanAdds TikTok's AI-generated content label (post_info.is_aigc). Default false.
options.tiktok.auto_add_musicbooleanPhoto posts: let TikTok add music. Default true.
options.tiktok.photo_cover_indexintegerPhoto posts: which image is the cover. Default 0.
options.tiktok.as_draftbooleanSend the photos or the video to the creator's TikTok inbox as a draft instead of publishing: the person opens TikTok, adds a trending sound and posts it from there. The result says delivered_to: "inbox" and as_draft: true. Needs a connection made with the video.upload permission. Default false.
options.tiktok.upload_methodstringVideos only: the "upload method" editors use so TikTok leaves the export as it is. PostWire rewrites the MP4 header on the way to TikTok (nothing is re-encoded, no daily limit, files up to 1 GB streamed). max is the usual choice (what editors mean by the method); safe rewrites the movie header only. Also accepted at the top level of /api/post and /api/schedule as upload_method. When the file cannot be patched (a host without byte ranges, a fragmented MP4) the post goes out as-is and the result's notice says so. One of: max, safe.

YouTube

FieldTypeDescription
options.youtube.privacystringDefault: the privacy saved for the connection (POST /api/connect/youtube/settings), else private. One of: public, unlisted, private.
options.youtube.titlestringDefaults to the first line of the text; cut at 100 characters. Up to 100 characters.
options.youtube.tagsarray of stringTrimmed to YouTube's 500-character budget across all tags.
options.youtube.thumbnail_urlstring (uri)Custom thumbnail (the channel must be allowed to set custom thumbnails).
options.youtube.ai_generatedbooleanDeclares altered or synthetic content (status.containsSyntheticMedia). Default false.

Instagram

FieldTypeDescription
options.instagram.post_typestringfeed (default: a photo is an image post, a video is a Reel), reels (needs a video) or story. One of: feed, reels, story.
options.instagram.trial_reelbooleanPublish a Reel as a trial reel (shown to non-followers first). Falls back to a normal Reel when the account cannot use trial reels. Default false.

Facebook

FieldTypeDescription
options.facebook.post_typestringfeed (default), reels (needs a video) or story (photo or video). One of: feed, reels, story.

LinkedIn

FieldTypeDescription
options.linkedin.first_commentstringPosted as the author's first comment right after the post (where a link goes without hurting reach). A failed comment is retried later; the post is never re-sent. Also accepted as per_platform.linkedin.first_comment.
options.linkedin.document_urlstring (uri)A PDF, PPT or DOC published as a document (carousel) post.
options.linkedin.document_titlestring

Bluesky

FieldTypeDescription
options.bluesky.alt_textstringAlt text for photo_url (with media, each item has its own alt).
options.bluesky.first_commentstringOne reply by the author under the post (under the last post of a thread): the place for the link. At most 300 characters. Also accepted as per_platform.bluesky.first_comment.
options.bluesky.threadarray of string or trueSame as per_platform.bluesky.thread: the posts after the main one, or true to split a long text at 300 characters.

Mastodon

FieldTypeDescription
options.mastodon.alt_textstringAlt text for photo_url or video_url (with media, each item has its own alt).
options.mastodon.first_commentstringOne reply by the author under the post (under the last post of a thread): the place for the link. At most 500 characters, or the server's own limit. Also accepted as per_platform.mastodon.first_comment.
options.mastodon.threadarray of string or trueSame as per_platform.mastodon.thread: the posts after the main one, or true to split a long text at the server's limit.

X

FieldTypeDescription
options.x.replystringOne more X post published as a reply under the last post of the chain: under the main post, or under the last post of per_platform.x.thread when there is one (the usual place for a link). At most 280 characters as X counts them (a link counts 23, an emoji 2); longer is refused with code bad_x_thread before anything goes out. It is an X post: 1 X credit, 10 with a link, and it counts toward the daily X limit. Also accepted as per_platform.x.reply.
options.x.first_commentstringSame as reply, by the name the other networks use. reply wins when both are sent.

WordPress

FieldTypeDescription
options.wordpress.titlestringArticle title. Without one, an opening '# heading' of the text, else its first line (the result says so). The writer keeps it to 70 characters.
options.wordpress.tagsarray of stringTag names (up to 10). Existing tags are matched by name; new ones are created when the user may (Editors, Administrators), else listed in the result's notice.
options.wordpress.summarystringThe post's excerpt.
options.wordpress.statusstringpublish (default) or draft: saved on the blog for review there. Default: the connection's choice (default_status). Also per_platform.<blog>.status. One of: publish, draft.
options.wordpress.categoriesarray of stringCategory names (up to 10), matched or created the same way.
options.wordpress.featured_imagestring (uri)Image uploaded to the media library and set as the featured image (default: photo_url). Up to 15 MB.

Dev.to

FieldTypeDescription
options.devto.titlestringArticle title. Without one, an opening '# heading' of the text, else its first line (the result says so). The writer keeps it to 70 characters.
options.devto.tagsarray of stringAt most 4; sent as lowercase letters and digits ("Web Dev" becomes webdev). Up to 4 items.
options.devto.summarystringThe article's description.
options.devto.statusstringpublish (default) or draft: saved on the blog for review there. Default: the connection's choice (default_status). Also per_platform.<blog>.status. One of: publish, draft.
options.devto.canonical_urlstring (uri)Where the article was first published.
options.devto.main_imagestring (uri)Cover image (default: photo_url).
options.devto.seriesstringSeries name.

Hashnode

FieldTypeDescription
options.hashnode.titlestringArticle title. Without one, an opening '# heading' of the text, else its first line (the result says so). The writer keeps it to 70 characters.
options.hashnode.tagsarray of stringTag names, up to 5. Up to 5 items.
options.hashnode.summarystringThe SEO description.
options.hashnode.statusstringpublish (default) or draft: saved on the blog for review there. Default: the connection's choice (default_status). Also per_platform.<blog>.status. One of: publish, draft.
options.hashnode.subtitlestringUp to 150 characters.
options.hashnode.canonical_urlstring (uri)Where the article was first published (originalArticleURL).
options.hashnode.cover_imagestring (uri)Cover image (default: photo_url).

Nostr

FieldTypeDescription
options.nostr.long_formbooleantrue: publish as a long-form article (NIP-23, kind 30023) with title, summary, image and tags; false: always a note (kind 1). Default: a note, or an article past 2,000 characters.
options.nostr.titlestringLong-form only. Default: the first line.
options.nostr.summarystringLong-form only.
options.nostr.tagsarray of stringTopics (t tags), with the post's own #hashtags; up to 10.

Before you choose a TikTok privacy level, GET /api/tiktok/creator-info returns the levels TikTok allows for the connected creator.