Skip to main content

Overview

Represents a video or slideshow post on a social media account.

Fields

FieldTypeDescription
idstringUnique post identifier
account_idstringID of the account that created this post
type'video' | 'slideshow'Type of post content
statusstringCurrent status: 'scheduled', 'pending', 'complete', or 'failed'
social_idstring | nullPlatform-specific post ID (TikTok video ID or Instagram reel code, available after posting)
captionstring | nullPost caption/description text (max 500 characters)
media_urlsstring[] | nullArray of URLs to video/image files used in the post
music_post_idstring | nullID of the music/audio track used in the post
scheduled_atstring | nullWhen the post is scheduled to be published (ISO 8601 format)
postUrlstring | undefinedDirect URL to view the post on the social platform. Only available when status is 'complete'. Format: TikTok: https://www.tiktok.com/@username/video/{social_id}, Instagram: https://www.instagram.com/p/{social_id}/

Post Status Values

StatusDescriptionCan Delete?
scheduledPost is scheduled to be published at a future time✅ Yes
pendingPost is currently being processed/published✅ Yes
completePost was successfully published to the platform❌ No
failedPost failed to publish (check error logs)✅ Yes
retryingPost is being retried after a previous failure✅ Yes
Posts with status complete (already published) cannot be deleted via the API to prevent accidental removal of live content. Only unpublished, pending, or failed posts can be deleted using the Delete Posts endpoint.

Post Types

TypeDescription
videoSingle video post
slideshowMultiple images with music/audio

Example Responses

Complete TikTok Post

{
  "id": "post_abc123",
  "account_id": "acc_123456",
  "type": "video",
  "status": "complete",
  "social_id": "7234567890123456789",
  "caption": "Check out this awesome video! 🎥 #viral",
  "media_urls": [
    "https://storage.example.com/video1.mp4"
  ],
  "music_post_id": "music_xyz789",
  "scheduled_at": "2024-01-15T14:30:00Z",
  "postUrl": "https://www.tiktok.com/@username/video/7234567890123456789"
}

Complete Instagram Post

{
  "id": "post_def456",
  "account_id": "acc_789012",
  "type": "video",
  "status": "complete",
  "social_id": "ABC123xyz",
  "caption": "Amazing content! ✨ #instagram",
  "media_urls": [
    "https://storage.example.com/video2.mp4"
  ],
  "music_post_id": "music_xyz789",
  "scheduled_at": "2024-01-15T16:00:00Z",
  "postUrl": "https://www.instagram.com/p/ABC123xyz/"
}

Scheduled Post (no postUrl)

{
  "id": "post_ghi789",
  "account_id": "acc_123456",
  "type": "slideshow",
  "status": "scheduled",
  "social_id": null,
  "caption": "Coming soon! 🎬",
  "media_urls": [
    "https://storage.example.com/img1.jpg",
    "https://storage.example.com/img2.jpg"
  ],
  "music_post_id": "music_abc123",
  "scheduled_at": "2024-01-20T10:00:00Z"
}