Skip to content

docs(public-api): document thumbnailTimestamp on the media object #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
giladresisi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(public-api): document thumbnailTimestamp on the media object #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions public-api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2574,6 +2574,10 @@
},
"path": {
"type": "string"
},
"thumbnailTimestamp": {
"type": "number",
"description": "Milliseconds into the video to use as the cover/thumbnail frame. Supported by Instagram, Instagram Standalone, TikTok Business, and TikTok (Direct Post only, not the UPLOAD/inbox flow); other providers ignore it. For TikTok, in our testing the cover was applied only to public posts (privacy_level PUBLIC_TO_EVERYONE)."
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
}
},
Expand Down
14 changes: 14 additions & 0 deletions public-api/posts/create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ Before re-submitting, strip the server-managed fields from the fetched object, r

Then set a fresh `type` (`now`, `schedule`, or `draft`) and `date`, and `POST` the cleaned object.

## Video cover frame (`thumbnailTimestamp`)

Each media object in a post's `image` array accepts an optional `thumbnailTimestamp` field: the number of milliseconds into the video to use as the cover/thumbnail frame.

```json
{
"image": [{ "id": "vid-123", "path": "https://uploads.postiz.com/video.mp4", "thumbnailTimestamp": 3000 }]
}
```

Supported providers: Instagram, Instagram Standalone, TikTok Business, and TikTok (Direct Post only — the `UPLOAD`/inbox flow does not support cover selection). Other providers ignore the field.

For TikTok, in our testing the cover was applied only to public posts (`privacy_level: "PUBLIC_TO_EVERYONE"`); posts published with a restricted privacy level kept the first frame as the cover.

## Provider-Specific Settings

When creating posts, each social media platform requires different settings. The `settings` object must include a `__type` field that identifies the platform.
Expand Down
Loading