Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions cli/managing-posts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ postiz posts:create \
| `-s, --date` | Schedule date in ISO 8601 format (required) |
| `-t, --type` | `schedule` (default) or `draft` |
| `-m, --media` | Comma-separated media URLs (use after uploading) |
| `--alt` | Comma-separated alt texts for the media of the corresponding `-m`, in the same order (use `--json` with `image[].alt` for alt texts containing commas) |
| `-i, --integrations` | Comma-separated integration IDs (required) |
| `-d, --delay` | Delay between comments in milliseconds (default: 5000) |
| `--settings` | Platform-specific settings as JSON |
Expand Down
16 changes: 16 additions & 0 deletions cli/platform-examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,22 @@ postiz posts:create \
-i "instagram-id"
```

### Image with Alt Text

`--alt` pairs with `-m` in the same order. Instagram applies it to images in posts and carousels only, not to videos or stories:

```bash
IMAGE_2=$(postiz upload beach.jpg)
IMAGE_URL_2=$(echo "$IMAGE_2" | jq -r '.path')
postiz posts:create \
-c "Beautiful day! #photography" \
-m "$IMAGE_URL,$IMAGE_URL_2" \
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
--alt "A sunset over the sea,A sandy beach" \
-s "2025-01-15T10:00:00Z" \
--settings '{"post_type":"post"}' \
-i "instagram-id"
```

### Story

```bash
Expand Down
12 changes: 12 additions & 0 deletions public-api/posts/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@ 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.

## Image alt text (`alt`)

Each media object in a post's `image` array accepts an optional `alt` field: a text description of the image for accessibility.

```json
{
"image": [{ "id": "img-123", "path": "https://uploads.postiz.com/sunset.jpg", "alt": "A sunset over the sea" }]
}
```

Providers that support alt text (Instagram, Instagram Standalone, Bluesky, Mastodon, Slack, Tumblr) send it with the image; other providers ignore the field. Instagram applies it to images only (single images and carousel items, up to 1000 characters), not to videos or stories.

## 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.
Expand Down
2 changes: 2 additions & 0 deletions public-api/providers/instagram.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Use `__type: "instagram"` for Facebook Business-linked accounts and `__type: "in
| `collaborators` | `array` | No | List of collaborator usernames |
| `audio` | `object` | No | Audio to attach to a Reel (single video only) |

Alt text is not a setting: set [`alt`](/public-api/posts/create#image-alt-text-alt) on the media object in `image`. Instagram receives it as `alt_text` on images (single images and carousel items, up to 1000 characters); it is not sent for videos or stories.

### `post_type`

| Value | Description |
Expand Down
Loading