Skip to main content

Post

idintegerrequired
uuidstring<uuid>required
statusPostStatusrequired

publishing is reported while the post is being sent to the networks.

Possible values: [draft, scheduled, published, failed, needs_approval, publishing]

publish_progress object

Only present while the post is publishing.

totalintegerrequired

Number of accounts the post goes to.

publishedintegerrequired
failedintegerrequired
accounts object[]required
  • Array [
  • idintegerrequired
    uuidstring<uuid>required
    namestringrequired
    Example: My Instagram
    usernamestringrequired
    Example: myhandle
    image(string | null)<uri>nullable
    providerstringrequired

    Network key. Known values: twitter, facebook_page, instagram, instagram_standalone, threads, linkedin, linkedin_page, tiktok, youtube, pinterest, gbp, bluesky, mastodon, pixelfed, telegram, discord, slack. New networks add new keys, so treat unknown values as valid.

    Example: instagram
    dataobjectrequired

    Provider-specific metadata.

    authorizedbooleanrequired
    profile_url(string | null)<uri>nullable

    Public URL of the account's profile on the network, when known.

    publish_statusstring

    Only present when the account is embedded in a post. Publishing state of this account for the post.

    Possible values: [pending, publishing, published, failed]

    published_partsinteger

    Only present when the account is embedded in a post. How many parts (for example thread items or a first comment) are live on the network.

    Possible values: >= 0

    external_urlstring | nullnullable

    Only present when the account is embedded in a post. URL of the published post on the network, null until it is live.

    provider_post_idstring | nullnullable

    Only present when the account is embedded in a post. The network's own ID of the published post (for example a LinkedIn share URN or a tweet ID), null until it is live.

    errors object[]

    Only present when the account is embedded in a post. Why publishing to this account failed. A raw network error is stored as two entries: a readable line ("<Network>: <message> (code <code>)") and an object {platform, code, message, raw} with the network's original response in raw. Other failures are a single readable string.

  • Array [
  • oneOf
    string
  • ]
  • created_atstringrequired

    UTC, formatted Y-m-d H:i:s.

    Example: 2026-10-11 09:30:00
  • ]
  • versions object[]required
  • Array [
  • account_idintegerrequired

    Use 0 for the original/default version.

    is_originalbooleanrequired

    Must be true for the first version.

    synced_withinteger | nullnullable

    Account ID of the version this version follows (0 = the original), or null when it is edited independently. Ignored on the original version.

    Possible values: >= 0

    content object[]required

    Ordered content items. Item 0 is the post. Item 1 is the first comment on Facebook Page, Instagram and LinkedIn (LinkedIn only when first comments are enabled on this server), or the next thread post on X, Threads, Bluesky, Mastodon and Pixelfed. See PostContent.

    Possible values: >= 1

  • Array [
  • bodystring | nullnullable

    Post text/caption. For a second item on Facebook Page, Instagram or LinkedIn this is the first comment.

    url(string | null)<uri>nullable

    Link shown as a preview card on LinkedIn, Bluesky and Facebook Pages (Facebook builds the card from the page's own Open Graph tags). If omitted and the item has no media, the first link in body is used.

    mediainteger[]

    Array of media IDs from the media library.

    video_thumbsobject[]
  • ]
  • options object

    Platform-specific publishing options, keyed by network (tiktok, youtube, instagram, mastodon, …). Options of networks the post does not publish to are ignored. To label a post as AI-generated on every network that supports it, send ai_generated on the post instead of setting tiktok.is_aigc, youtube.contains_synthetic_media or instagram.ai_generated yourself.

    tiktok object

    TikTok options. Every field is a map of account-<account id> to a value, so one post can carry different settings for several TikTok accounts.

    privacy_level object
    is_aigc object

    TikTok's "AI-generated content" label.

    property name*boolean
    allow_comments object
    property name*boolean
    allow_duet object
    property name*boolean
    allow_stitch object
    property name*boolean
    auto_add_music object
    property name*boolean
    content_disclosure object

    Discloses branded or promotional content; then set brand_organic_toggle and/or brand_content_toggle.

    property name*boolean
    brand_organic_toggle object
    property name*boolean
    brand_content_toggle object
    property name*boolean
    youtube object

    YouTube options. The video title is required.

    titlestring

    Possible values: <= 100 characters

    statusstring

    Possible values: [public, private, unlisted]

    Default value: public
    made_for_kidsboolean
    Default value: false
    contains_synthetic_mediaboolean

    YouTube's "altered or synthetic content" disclosure. Set by ai_generated.

    Default value: false
    instagram object

    Instagram options (instagram for accounts connected through Facebook, instagram_standalone for Instagram Login).

    typestring

    Possible values: [post, reel, story]

    Default value: post
    collaboratorsstring[]

    Usernames invited as collaborators (not for stories).

    Possible values: <= 3

    ai_generatedboolean

    Instagram's "AI info" label on the post (on the carousel itself for carousels; not for stories). Set by ai_generated.

    Default value: false
    instagram_standalone object

    Instagram options (instagram for accounts connected through Facebook, instagram_standalone for Instagram Login).

    typestring

    Possible values: [post, reel, story]

    Default value: post
    collaboratorsstring[]

    Usernames invited as collaborators (not for stories).

    Possible values: <= 3

    ai_generatedboolean

    Instagram's "AI info" label on the post (on the carousel itself for carousels; not for stories). Set by ai_generated.

    Default value: false
    property name*any

    Platform-specific publishing options, keyed by network (tiktok, youtube, instagram, mastodon, …). Options of networks the post does not publish to are ignored. To label a post as AI-generated on every network that supports it, send ai_generated on the post instead of setting tiktok.is_aigc, youtube.contains_synthetic_media or instagram.ai_generated yourself.

  • ]
  • tags object[]required
  • Array [
  • idintegerrequired
    uuidstring<uuid>required
    namestringrequired
    Example: Campaign 2025
    hex_colorstringrequired
    Example: #3B82F6
  • ]
  • scheduled_atstring | nullnullable

    Y-m-d H:i:s in UTC (not RFC 3339).

    Example: 2026-10-16 10:00:00
    published_atstring | nullnullable

    Y-m-d H:i:s in UTC (not RFC 3339).

    Example: 2026-10-16 10:00:04
    created_atstringrequired

    Y-m-d H:i:s in UTC (not RFC 3339).

    Example: 2026-10-16 09:58:12
    trashedbooleanrequired
    Post
    {
    "id": 0,
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "draft",
    "publish_progress": {
    "total": 0,
    "published": 0,
    "failed": 0
    },
    "accounts": [
    {
    "id": 0,
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "My Instagram",
    "username": "myhandle",
    "image": "string",
    "provider": "instagram",
    "data": {},
    "authorized": true,
    "profile_url": "string",
    "publish_status": "pending",
    "published_parts": 0,
    "external_url": "string",
    "provider_post_id": "string",
    "errors": [
    "string",
    {
    "platform": "string",
    "code": "string",
    "message": "string"
    }
    ],
    "created_at": "2026-10-11 09:30:00"
    }
    ],
    "versions": [
    {
    "account_id": 0,
    "is_original": true,
    "synced_with": 0,
    "content": [
    {
    "body": "string",
    "url": "string",
    "media": [
    0
    ],
    "video_thumbs": [
    {}
    ]
    }
    ],
    "options": {
    "tiktok": {
    "privacy_level": {
    "account-12": "PUBLIC_TO_EVERYONE"
    },
    "is_aigc": {
    "account-12": true
    },
    "allow_comments": {},
    "allow_duet": {},
    "allow_stitch": {},
    "auto_add_music": {},
    "content_disclosure": {},
    "brand_organic_toggle": {},
    "brand_content_toggle": {}
    },
    "youtube": {
    "title": "string",
    "status": "public",
    "made_for_kids": false,
    "contains_synthetic_media": false
    },
    "instagram": {
    "type": "post",
    "collaborators": [
    "string"
    ],
    "ai_generated": false
    },
    "instagram_standalone": {
    "type": "post",
    "collaborators": [
    "string"
    ],
    "ai_generated": false
    }
    }
    }
    ],
    "tags": [
    {
    "id": 0,
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Campaign 2025",
    "hex_color": "#3B82F6"
    }
    ],
    "scheduled_at": "2026-10-16 10:00:00",
    "published_at": "2026-10-16 10:00:04",
    "created_at": "2026-10-16 09:58:12",
    "trashed": true
    }