Skip to main content

BlogToSocialInput

At least one of url or (title + excerpt) must be provided. If both are given, direct values take priority over the scraped URL content.

urlstring<uri>

Blog post URL to scrape. Required if title and excerpt are not provided.

Possible values: <= 2000 characters

Example: https://example.com/blog/my-post
titlestring

Blog post title. Required if url is not provided.

Possible values: <= 500 characters

Example: 10 Tips for Better Social Media
excerptstring

Blog post summary or excerpt. Required if url is not provided.

Possible values: <= 5000 characters

Example: Social media success starts with consistency and knowing your audience...
image_url(string | null)<uri>nullable

Featured image URL for the blog post. When create_post is true, the image is imported into the workspace media library and attached to the draft post. If omitted in URL mode, the scraper attempts to extract the og:image meta tag.

Possible values: <= 2000 characters

Example: https://example.com/images/post-cover.jpg
platformsstring[]nullable

Target social media platforms. Only connected accounts matching these platforms are used. If omitted, all connected accounts in the workspace are targeted.

Possible values: [twitter, facebook_page, instagram, threads, mastodon, youtube, gbp, pinterest, linkedin, linkedin_page, tiktok, bluesky]

Example: ["twitter","linkedin"]
account_idsinteger[]nullable

Specific account IDs to generate captions for. Takes precedence over platforms when both are provided.

Example: [5,12]
tonestring | nullnullable

Writing tone for all generated captions.

Possible values: [neutral, friendly, formal, edgy, engaging, casual, professional, humorous, inspirational, conversational, null]

Default value: engaging
Example: professional
content_lengthstring | nullnullable

Desired length of the generated captions.

Possible values: [short, medium, long, null]

Default value: medium
Example: medium
hashtagsstring | nullnullable

Hashtag quantity: none (0), few (1-3), some (3-5), many (5+).

Possible values: [none, few, some, many, null]

Default value: few
Example: few
ctastring | nullnullable

Call-to-action type appended to each caption.

Possible values: [none, question, link, subscribe, follow, share, learn_more, signup, buy, download, null]

Default value: none
Example: link
languagestring | nullnullable

Output language as an ISO 639-1 code (e.g. en, de, fr). Use auto to match the blog post's language automatically.

Possible values: <= 10 characters

Default value: auto
Example: auto
custom_instructionsstring | nullnullable

Additional instructions appended to the AI prompt (e.g. "always mention our free tier").

Possible values: <= 500 characters

Example: Always mention that PostBoost has a free plan.
create_postboolean | nullnullable

When true, creates a draft post in the workspace with per-account caption versions. If an image is available, it is imported and attached to the post.

Default value: false
use_brand_voiceboolean | nullnullable

Apply the workspace brand voice (see GET brand-voice) to the captions. An explicit tone is kept, but the brand voice wins on vocabulary, words to avoid and calls to action.

Default value: true
BlogToSocialInput
{
"url": "https://example.com/blog/my-post",
"title": "10 Tips for Better Social Media",
"excerpt": "Social media success starts with consistency and knowing your audience...",
"image_url": "https://example.com/images/post-cover.jpg",
"platforms": [
"twitter",
"linkedin"
],
"account_ids": [
5,
12
],
"tone": "professional",
"content_length": "medium",
"hashtags": "few",
"cta": "link",
"language": "auto",
"custom_instructions": "Always mention that PostBoost has a free plan.",
"create_post": false,
"use_brand_voice": true
}