Schedule social posts to TikTok, Instagram, Facebook, YouTube and X; manage accounts and media
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Connect a social account. Opens the platform in the person's browser so they can sign in and approve access — that part cannot happen here, because it needs their session and their consent. Call it again after they finish and it reports the connected account. With `invite`, the link is for someone else instead — a friend or family member who will create a brand-new account and connect it, with no login of their own here. They get a page showing the profile to set up (picture, username, name, bio) with copy buttons, the steps to switch Instagram to a Creator account, and a Connect button. Give the person the `url`. Calling again with the same platform and username returns the same invite, updated with whatever profile fields are given, and its status — so that is also how to check whether they have finished. Upload the profile picture first with media_upload, and pass its id once the PUT succeeds.
Which platform to connect.
Set to make a link for someone without a login here, who will create the account. Leave out to connect an account yourself.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Connect a social account. Opens the platform in the person's browser so they can sign in and approve access — that part cannot happen here, because it needs their session and their consent. Call it again after they finish and it reports the connected account. With `invite`, the link is for someone else instead — a friend or family member who will create a brand-new account and connect it, with no login of their own here. They get a page showing the profile to set up (picture, username, name, bio) with copy buttons, the steps to switch Instagram to a Creator account, and a Connect button. Give the person the `url`. Calling again with the same platform and username returns the same invite, updated with whatever profile fields are given, and its status — so that is also how to check whether they have finished. Upload the profile picture first with media_upload, and pass its id once the PUT succeeds.
| Argument | Type | Description |
|---|---|---|
| invite | object | Set to make a link for someone without a login here, who will create the account. Leave out to connect an account yourself. |
| platform* | string | Which platform to connect. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"platform"
],
"properties": {
"invite": {
"type": "object",
"required": [
"username"
],
"properties": {
"bio": {
"type": "string",
"maxLength": 150,
"description": "The profile bio. Instagram caps it at 150 characters."
},
"username": {
"type": "string",
"maxLength": 31,
"minLength": 1,
"description": "The handle they should register, without the @. Also what identifies this invite on a repeat call. Instagram allows letters, numbers, periods and underscores, up to 30."
},
"display_name": {
"type": "string",
"maxLength": 64,
"description": "The profile name shown above the bio."
},
"avatar_media_id": {
"type": "string",
"description": "An image uploaded with media_upload to use as the profile picture. The invite goes into the same workspace as the image."
}
},
"description": "Set to make a link for someone without a login here, who will create the account. Leave out to connect an account yourself."
},
"platform": {
"enum": [
"tiktok",
"instagram",
"facebook",
"youtube",
"x"
],
"type": "string",
"description": "Which platform to connect."
}
}
}List every social account you can post to, across all your workspaces. Each account includes the workspace it belongs to and any groups it is in. Use the returned ids to name post destinations explicitly, or a group name to name several at once. metrics true adds how each account is performing — followers, posts, total likes and following, each with how far it moved over the period — and orders by followers, largest first. Numbers are as of the last sweep rather than live; every account carries the time it was measured, and one nobody has measured yet has no metrics at all rather than zeroes.
| Argument | Type | Description |
|---|---|---|
| period | string | With metrics: the window every change is measured over. Defaults to 24h. A change is the difference against the last observation before the window opened, so it is null when there was none. |
| metrics | boolean | Include followers and how they moved. Defaults to false. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"period": {
"enum": [
"24h",
"7d"
],
"type": "string",
"description": "With metrics: the window every change is measured over. Defaults to 24h. A change is the difference against the last observation before the window opened, so it is null when there was none."
},
"metrics": {
"type": "boolean",
"description": "Include followers and how they moved. Defaults to false."
}
}
}Remove a group. The accounts in it are not touched and stay connected — only the name and its membership go. Posts already scheduled through it are unaffected, because a post records the accounts rather than the group.
| Argument | Type | Description |
|---|---|---|
| name* | string | The group to remove, from groups_list. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The group to remove, from groups_list."
}
}
}Your named sets of accounts. Each group lists its members with the state of each, and how many of them need reconnecting — a post naming a group is refused outright if any member cannot publish, so check here before composing one. Use a group name with posts_save instead of listing account ids.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Create a group or change one. A group is a name for a set of accounts, so posts_save can take the name instead of every id. Found by name without regard to case: an existing group is updated (new_name renames it), and a new name creates one, which needs account_ids. account_ids is always the full membership afterwards, not a list to add. All the accounts must be in one workspace.
| Argument | Type | Description |
|---|---|---|
| name* | string | The group, matched without regard to case. Created when there is none by this name. |
| new_name | string | Rename an existing group to this. |
| account_ids | array | The complete membership, from accounts_list — whatever is sent replaces what was there. Required to create a group; omit it to leave an existing group’s members alone. |
| description | string | What it is for, so it can be chosen without reading it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The group, matched without regard to case. Created when there is none by this name."
},
"new_name": {
"type": "string",
"description": "Rename an existing group to this."
},
"account_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The complete membership, from accounts_list — whatever is sent replaces what was there. Required to create a group; omit it to leave an existing group’s members alone."
},
"description": {
"type": "string",
"description": "What it is for, so it can be chosen without reading it."
}
}
}Remove a file and its stored bytes. This cannot be undone. A file a post still uses cannot be removed, and neither can raw material kept with purpose source: switch it to library with media_save first.
| Argument | Type | Description |
|---|---|---|
| id* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
}
}Files in your workspaces, newest first, 50 at a time. Use these ids when attaching media to a post. By default these are the files to post; purpose: source lists the raw material kept to reuse instead. Narrow with kind, tags (files carrying every one) or search (words in the description or tags), or pass media_id for one file of either purpose. Each file has a url to download it from. When nextCursor is not null, pass it as cursor for the next page.
| Argument | Type | Description |
|---|---|---|
| kind | string | Only this kind of file. |
| tags | array | Only files carrying every one of these tags. |
| limit | integer | How many to return. Defaults to 50. |
| cursor | string | nextCursor from the previous page, for the page after it. |
| search | string | Words in the description or the tags, ignoring case. |
| purpose | string | library, the default: files to post. source: raw material kept to reuse — generated takes, recordings, sound effects, saved memes. |
| media_id | string | One file by id. Every other argument is ignored. |
Say what a file is, in your own words. description is what it shows: on a base image, who is on camera — "a woman in her early twenties, blonde hair in a loose bun" — and a campaign reads it so the same person appears in every render instead of changing between them. tags are labels to filter by, like sound-effect; metadata is how it was made — provider, model, prompt, jobId, costUsd, sourceUrl, ref, inputs. Each replaces what is there: null clears a description or metadata, [] clears tags. purpose switches a file between library, to post, and source, raw material kept to reuse. For several files at once, items, up to 50: a file not recorded yet comes back in not_found, to save once media_list shows it. Nothing else about a file can be changed here; what it is was read from the file itself.
| Argument | Type | Description |
|---|---|---|
| id | string | The file to change. For several, use items instead. |
| tags | array | Labels to filter by, replacing those there. [] removes them all. |
| items | array | Several files at once, each an id and what to change. Only files that have arrived are changed; the rest come back in not_found. |
| purpose | string | library, the default: a file to post. source: raw material kept to find and reuse — a generated take, a recording, a sound effect, a saved meme. A source file is listed only when asked for, and is never posted or picked up by a campaign as it is. |
| metadata | any | How it was made, replacing what is there, or null to remove it. |
| description | any |
Get a file into ViewPrinter, under an id you can pass to posts_save, media_save or anything else that takes a media id. If the person attached the file in this chat, or has it on their phone or computer, call this with no arguments, as an ordinary tool call — not from code, and without trying to send the file yourself. Apps that show widgets put an upload box under the call, which sends the file to ViewPrinter directly even when you have no network access: tell the person to use it. It takes one video or up to ten photos and posts their media ids to the chat, in order, when they are in. Where no box appears, give the person `upload_page`: any device, no sign-in, lasts an hour. Only if you hold the file yourself and can make HTTP requests (a terminal agent, a server), pass kind and mime_type and PUT the bytes to `url` with exactly the `headers` returned. Apps that show widgets never get `url`: the upload box is the way there. Add sha256 (hex) and a file this workspace already has comes back as existing: true, with nothing to upload. If the file is already on the web — a model’s output link, a meme’s direct link — pass from_url instead, with any description, tags and metadata: ViewPrinter fetches it itself and answers fetching: true straight away. It is recorded within minutes; check with media_list and media_id, and if it never appears the link could not be fetched. purpose: source keeps raw material — a generated take, a recording, a sound effect, a saved meme — to find and reuse later. media_list shows it only when asked for purpose source, and it is never posted or used by a campaign as it is. Several files at once: items, up to 50, each as you would pass one; the answers come back in items, in order. Either way the file lands under `id` and is recorded as soon as it arrives. With the box or the page, wait for the person before using it.
| Argument | Type | Description |
|---|---|---|
| kind | string | What the file is. With mime_type when you hold the file. With from_url it is optional, and checked against what the link serves. |
| tags | array | With from_url: labels to filter by, e.g. sound-effect. |
What each platform accepts. Called with nothing, it lists every platform with the media kinds and counts it takes and its caption limit — enough to decide where a post can go. Name platforms to add their recommended sizes and durations, their options with what each one does, and the quirks that decide how a post is treated. Read this before scheduling rather than discovering the rules by being rejected.
| Argument | Type | Description |
|---|---|---|
| platforms | array | Which platforms to describe in full. Omit for a short answer covering all of them. Naming only the platforms you are posting to keeps the reply small — full detail for all of them is several times the size. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"platforms": {
"type": "array",
"items": {
"type": "string"
},
"description": "Which platforms to describe in full. Omit for a short answer covering all of them. Naming only the platforms you are posting to keeps the reply small — full detail for all of them is several times the size."
}
}
}Posts in your workspaces, newest first, one page at a time, each with the state of every destination it was sent to and the numbers it has earned so far. Call it to find one post (post_id), to check whether something published, and before changing or cancelling anything — posts_save takes a post_id from here. Numbers are as of the last sweep, and every destination carries the time it was measured — one nobody has measured yet has no metrics at all rather than zeroes. `trial` names an Instagram trial reel's graduation strategy, and is null for anything that is not one. A trial is shown to non-followers first, so its numbers come from a colder audience than an ordinary post's: compare trials with trials. Each row also carries `insights`: what the platform's own analytics said on that delivery, never summed across deliveries. reach (distinct accounts), totalWatchMs and avgWatchMs, replays, follows (gained from the post), completionRate and skipRate as fractions 0..1, `retention` — the full audience-retention curve as Facebook sends it, `points[i]` being the share still watching at i twentieths of the video and `bucketMs` one twentieth in milliseconds — and `breakdowns` such as clicks by type. retentionAt3s and retentionAtHalf are read off that curve, interpolated between buckets, so hooks can be ranked by how many viewers they held; null without a curve or a known video length. Null means the platform does not report it; a name listed in `unavailable` means it would have and refused this time. Compare watch time across platforms as totalWatchMs / views: Facebook averages per play and Instagram per viewer, so avgWatchMs is not comparable between them. Every filter is optional and they combine: a date range, statuses, platforms, accounts, groups and products by name, where the post came from, and a caption search. Pass nextCursor back as cursor for the next page; null means there is no more.
| Argument | Type | Description |
|---|---|---|
| by | string | With rank_by: the running total, or how much it moved over the period. Defaults to the total. Insights rank by value only. |
Create, change or cancel a post. This publishes: a new post is queued for every account named and goes out at scheduled_at, or as soon as possible without one. Do not tell anyone their post is saved or scheduled until this has returned successfully. No post_id creates a post. Name accounts with ids from accounts_list, or a group from groups_list for all of its members — the two combine, and a group is expanded now, so adding an account to it later does not add it to this post. Accounts must all be in one workspace. Attach media by id from media_list; a post is either a video or a set of images, never both. draft true holds it here without sending anything. With post_id, changes a post that has not gone out: caption, time, destinations, or draft state. account_ids and groups then replace the destination list entirely. draft false sends a draft. Setting scheduled_at on a post whose destinations failed queues the failed ones again and leaves the published ones alone — fix what made them fail first, usually by reconnecting. The caption and destinations can only change while nothing has published; after that only the time can, and new words mean a new post. With post_id and cancel true, stops it: destinations that have not started are cancelled, and any already being published cannot be recalled and come back in still_going. Safe to repeat. Publishing has to be enabled on the account; where it is not, a new post saves nothing at all and a draft is left as it was, and the answer says so. Cancelling works whether or not publishing is enabled.
| Argument | Type | Description |
|---|---|---|
| draft | boolean | True holds the post here: nothing is queued and nothing reaches any platform. On an existing post, false sends a draft and true returns a scheduled post to draft. Unrelated to the per-platform draft option, which uploads to the platform for the creator to finish. |
| cancel | boolean | With post_id: stop the post before it goes out. |
Delete a product. Its accounts stay connected and belong to no product afterwards. Refused while it has campaigns. Its knowledge documents and gathered research are deleted with it, so this is refused while it has any unless confirm_discard is true — read the refusal, which says how many would go, before confirming.
| Argument | Type | Description |
|---|---|---|
| id* | string | The product, from products_list. |
| confirm_discard | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The product, from products_list."
},
"confirm_discard": {
"type": "boolean"
}
}
}The products your accounts post for — an app, a book, a shop — each with the accounts linked to it and the workspace it is in. An account belongs to at most one product. Use products_save to create one or change which accounts belong to it.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Create a product, or change one. Found by id when given, otherwise by name (ignoring case) and created when there is none, so saving the same product twice changes nothing the second time. account_ids is the complete list of accounts that post for it: accounts in another product move here, and accounts in this one that are not listed leave it. Leave it out to keep the accounts as they are. A product holds accounts from one workspace; when you are in several and name no accounts, pass workspace_id (from accounts_list).
| Argument | Type | Description |
|---|---|---|
| id | string | An existing product to change, from products_list. |
| name* | string | The name, or the new name when id is given. |
| account_ids | array | Every account that posts for it, from accounts_list. |
| description | string | What it is, in a sentence or two. |
| workspace_id | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"description": "An existing product to change, from products_list."
},
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "The name, or the new name when id is given."
},
"account_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Every account that posts for it, from accounts_list."
},
"description": {
"type": "string",
"maxLength": 500,
"description": "What it is, in a sentence or two."
},
"workspace_id": {
"type": "string"
}
}
}Ask a question about your niche and get back the posts that answer it, from TikTok and Instagram unless platforms narrows it. Give question and product_id and it starts searching for that question, which takes a few minutes, and returns at once with a thread_id and status working. Call it again with just the thread_id, about every 15 seconds, until status is ready; then posts are the answer, best first. Each has its URL, caption, hashtags, views, likes, comments, shares and saves, the creator’s follower count, and outperformance: views as a multiple of that creator’s median over the posts we hold of theirs, null when we hold too few. fit says how well a post suits your product (in_niche, adjacent, off_topic) and posts judged off-topic are left out unless you ask for all. A thread takes one question at a time: asking again while it is working does not start a new one. With a failed status, ask the question again. Starting a question uses search credit, so do not repeat one that is working. With neither question nor thread_id it reads what is already indexed, instantly. A post we have watched also carries hook, genre, format and repeatableStructure (null until watched), and a question’s answer gives each post a why: one line on what the video is and how it was judged. The top-level formats and ideas are empty for now.
| Argument | Type | Description |
|---|---|---|
| fit | string | How closely a post must fit your product. relevant (default) drops posts judged off-topic and keeps ones not judged yet; in_niche keeps only judged in-niche posts; all keeps everything. |
| limit | integer | How many posts. Default 10. |
| since | string | Posted on or after this ISO 8601 time. Default: 7 days ago for an index read, 30 days for a question’s answer. |
| medium | string | Only videos, or only slideshows. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"kind": {
"enum": [
"image",
"video",
"audio"
],
"type": "string",
"description": "Only this kind of file."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 40
},
"maxItems": 20,
"minItems": 1,
"description": "Only files carrying every one of these tags."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "How many to return. Defaults to 50."
},
"cursor": {
"type": "string",
"description": "nextCursor from the previous page, for the page after it."
},
"search": {
"type": "string",
"description": "Words in the description or the tags, ignoring case."
},
"purpose": {
"enum": [
"library",
"source"
],
"type": "string",
"description": "library, the default: files to post. source: raw material kept to reuse — generated takes, recordings, sound effects, saved memes."
},
"media_id": {
"type": "string",
"description": "One file by id. Every other argument is ignored."
}
}
}| What the file shows, in your own words, or null to remove the words already there. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"type": "string",
"description": "The file to change. For several, use items instead."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 40
},
"maxItems": 20,
"description": "Labels to filter by, replacing those there. [] removes them all."
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 40
},
"maxItems": 20,
"description": "Labels to filter by, replacing those there. [] removes them all."
},
"purpose": {
"enum": [
"library",
"source"
],
"type": "string",
"description": "library, the default: a file to post. source: raw material kept to find and reuse — a generated take, a recording, a sound effect, a saved meme. A source file is listed only when asked for, and is never posted or picked up by a campaign as it is."
},
"metadata": {
"anyOf": [
{
"type": "object",
"properties": {
"ref": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The creative it was made for, e.g. PB-CR07."
},
"jobId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The provider's id for the job, to find it again there."
},
"model": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The model, as the provider names it."
},
"inputs": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"maxItems": 10,
"description": "Ids of the files it was made from, such as a starting still."
},
"prompt": {
"type": "string",
"maxLength": 8000,
"minLength": 1,
"description": "The prompt it was made from, exactly as sent."
},
"costUsd": {
"type": "number",
"minimum": 0,
"description": "What the job cost or was quoted, in US dollars."
},
"provider": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Who made it: higgsfield, fal, memelord, a phone."
},
"sourceUrl": {
"type": "string",
"format": "uri",
"maxLength": 2000,
"description": "Where a file saved from the web was found."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "How it was made, replacing what is there, or null to remove it."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "What the file shows, in your own words, or null to remove the words already there."
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "Several files at once, each an id and what to change. Only files that have arrived are changed; the rest come back in not_found."
},
"purpose": {
"enum": [
"library",
"source"
],
"type": "string",
"description": "library, the default: a file to post. source: raw material kept to find and reuse — a generated take, a recording, a sound effect, a saved meme. A source file is listed only when asked for, and is never posted or picked up by a campaign as it is."
},
"metadata": {
"anyOf": [
{
"type": "object",
"properties": {
"ref": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The creative it was made for, e.g. PB-CR07."
},
"jobId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The provider's id for the job, to find it again there."
},
"model": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The model, as the provider names it."
},
"inputs": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"maxItems": 10,
"description": "Ids of the files it was made from, such as a starting still."
},
"prompt": {
"type": "string",
"maxLength": 8000,
"minLength": 1,
"description": "The prompt it was made from, exactly as sent."
},
"costUsd": {
"type": "number",
"minimum": 0,
"description": "What the job cost or was quoted, in US dollars."
},
"provider": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Who made it: higgsfield, fal, memelord, a phone."
},
"sourceUrl": {
"type": "string",
"format": "uri",
"maxLength": 2000,
"description": "Where a file saved from the web was found."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "How it was made, replacing what is there, or null to remove it."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "What the file shows, in your own words, or null to remove the words already there."
}
}
}| items | array | Several files at once, each as you would pass one. The answers come back in items, in the same order. |
| sha256 | string | When you hold the file: its SHA-256, as hex. If this workspace already has the file, the answer is its id with existing: true and nothing to upload. Otherwise the PUT must carry the headers the answer gives, and storage refuses bytes that do not match. |
| purpose | string | library, the default: a file to post. source: raw material kept to find and reuse — a generated take, a recording, a sound effect, a saved meme. A source file is listed only when asked for, and is never posted or picked up by a campaign as it is. |
| from_url | string | A file already on the web — a model’s output link, a meme’s direct link. ViewPrinter fetches it itself; there is nothing to PUT. |
| metadata | object | With from_url: how it was made — model, prompt, cost and so on. |
| mime_type | string | The exact Content-Type your PUT will send, e.g. video/mp4. Only with kind, when you hold the file. |
| description | string | With from_url: what the file shows, in your own words. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"kind": {
"enum": [
"image",
"video",
"audio"
],
"type": "string",
"description": "What the file is. With mime_type when you hold the file. With from_url it is optional, and checked against what the link serves."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 40
},
"maxItems": 20,
"description": "With from_url: labels to filter by, e.g. sound-effect."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"enum": [
"image",
"video",
"audio"
],
"type": "string",
"description": "What the file is. With mime_type when you hold the file. With from_url it is optional, and checked against what the link serves."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 40
},
"maxItems": 20,
"description": "With from_url: labels to filter by, e.g. sound-effect."
},
"sha256": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"description": "When you hold the file: its SHA-256, as hex. If this workspace already has the file, the answer is its id with existing: true and nothing to upload. Otherwise the PUT must carry the headers the answer gives, and storage refuses bytes that do not match."
},
"purpose": {
"enum": [
"library",
"source"
],
"type": "string",
"description": "library, the default: a file to post. source: raw material kept to find and reuse — a generated take, a recording, a sound effect, a saved meme. A source file is listed only when asked for, and is never posted or picked up by a campaign as it is."
},
"from_url": {
"type": "string",
"format": "uri",
"description": "A file already on the web — a model’s output link, a meme’s direct link. ViewPrinter fetches it itself; there is nothing to PUT."
},
"metadata": {
"type": "object",
"properties": {
"ref": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The creative it was made for, e.g. PB-CR07."
},
"jobId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The provider's id for the job, to find it again there."
},
"model": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The model, as the provider names it."
},
"inputs": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"maxItems": 10,
"description": "Ids of the files it was made from, such as a starting still."
},
"prompt": {
"type": "string",
"maxLength": 8000,
"minLength": 1,
"description": "The prompt it was made from, exactly as sent."
},
"costUsd": {
"type": "number",
"minimum": 0,
"description": "What the job cost or was quoted, in US dollars."
},
"provider": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Who made it: higgsfield, fal, memelord, a phone."
},
"sourceUrl": {
"type": "string",
"format": "uri",
"maxLength": 2000,
"description": "Where a file saved from the web was found."
}
},
"description": "With from_url: how it was made — model, prompt, cost and so on.",
"additionalProperties": false
},
"mime_type": {
"type": "string",
"description": "The exact Content-Type your PUT will send, e.g. video/mp4. Only with kind, when you hold the file."
},
"description": {
"type": "string",
"maxLength": 8000,
"minLength": 1,
"description": "With from_url: what the file shows, in your own words."
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "Several files at once, each as you would pass one. The answers come back in items, in the same order."
},
"sha256": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"description": "When you hold the file: its SHA-256, as hex. If this workspace already has the file, the answer is its id with existing: true and nothing to upload. Otherwise the PUT must carry the headers the answer gives, and storage refuses bytes that do not match."
},
"purpose": {
"enum": [
"library",
"source"
],
"type": "string",
"description": "library, the default: a file to post. source: raw material kept to find and reuse — a generated take, a recording, a sound effect, a saved meme. A source file is listed only when asked for, and is never posted or picked up by a campaign as it is."
},
"from_url": {
"type": "string",
"format": "uri",
"description": "A file already on the web — a model’s output link, a meme’s direct link. ViewPrinter fetches it itself; there is nothing to PUT."
},
"metadata": {
"type": "object",
"properties": {
"ref": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The creative it was made for, e.g. PB-CR07."
},
"jobId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The provider's id for the job, to find it again there."
},
"model": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The model, as the provider names it."
},
"inputs": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"maxItems": 10,
"description": "Ids of the files it was made from, such as a starting still."
},
"prompt": {
"type": "string",
"maxLength": 8000,
"minLength": 1,
"description": "The prompt it was made from, exactly as sent."
},
"costUsd": {
"type": "number",
"minimum": 0,
"description": "What the job cost or was quoted, in US dollars."
},
"provider": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Who made it: higgsfield, fal, memelord, a phone."
},
"sourceUrl": {
"type": "string",
"format": "uri",
"maxLength": 2000,
"description": "Where a file saved from the web was found."
}
},
"description": "With from_url: how it was made — model, prompt, cost and so on.",
"additionalProperties": false
},
"mime_type": {
"type": "string",
"description": "The exact Content-Type your PUT will send, e.g. video/mp4. Only with kind, when you hold the file."
},
"description": {
"type": "string",
"maxLength": 8000,
"minLength": 1,
"description": "With from_url: what the file shows, in your own words."
}
}
}| to | string | ISO date or date-time. Only posts before this. |
| from | string | ISO date or date-time. Only posts that went out, or are due to, at or after this. |
| group | array | Groups by name, from groups_list: posts to any of their accounts. |
| limit | integer | Posts per page. Defaults to 25. |
| order | string | Defaults to desc. |
| cursor | string | nextCursor from the previous page. |
| period | string | The window each figure's change is measured over. Defaults to 24h. |
| search | string | Text the caption contains, ignoring case. |
| source | array | Where a post came from. external is one made on the platform itself and found afterwards. |
| status | array | published, scheduled, draft, failed or cancelled. A post matches when any of its destinations is in one of these states. |
| post_id | string | One post by id. The other filters are ignored. |
| product | array | Products by name or id: posts to accounts linked to them. |
| rank_by | string | Rank the matching posts by one figure of their best destination instead: any counter (views, likes, …) or insight (reach, avgWatchMs, completionRate, retentionAt3s, retentionAtHalf, …). Answers "which hooks held viewers" or "what is moving now". Ranks up to 500 matching posts; no cursor. |
| sort_by | string | A counter or insight (views, likes, …), "when", "updated" or "account". Defaults to newest first. |
| platform | array |
| account_id | array | Accounts by id, from accounts_list. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"by": {
"enum": [
"value",
"change"
],
"type": "string",
"description": "With rank_by: the running total, or how much it moved over the period. Defaults to the total. Insights rank by value only."
},
"to": {
"type": "string",
"description": "ISO date or date-time. Only posts before this."
},
"from": {
"type": "string",
"description": "ISO date or date-time. Only posts that went out, or are due to, at or after this."
},
"group": {
"type": "array",
"items": {
"type": "string"
},
"description": "Groups by name, from groups_list: posts to any of their accounts."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Posts per page. Defaults to 25."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Defaults to desc."
},
"cursor": {
"type": "string",
"description": "nextCursor from the previous page."
},
"period": {
"enum": [
"24h",
"7d"
],
"type": "string",
"description": "The window each figure's change is measured over. Defaults to 24h."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Text the caption contains, ignoring case."
},
"source": {
"type": "array",
"items": {
"enum": [
"web",
"mcp",
"api",
"campaign",
"external"
],
"type": "string"
},
"description": "Where a post came from. external is one made on the platform itself and found afterwards."
},
"status": {
"type": "array",
"items": {
"enum": [
"published",
"scheduled",
"draft",
"failed",
"cancelled"
],
"type": "string"
},
"description": "published, scheduled, draft, failed or cancelled. A post matches when any of its destinations is in one of these states."
},
"post_id": {
"type": "string",
"description": "One post by id. The other filters are ignored."
},
"product": {
"type": "array",
"items": {
"type": "string"
},
"description": "Products by name or id: posts to accounts linked to them."
},
"rank_by": {
"enum": [
"views",
"likes",
"comments",
"shares",
"saves",
"reach",
"totalWatchMs",
"avgWatchMs",
"replays",
"follows",
"completionRate",
"retentionAt3s",
"retentionAtHalf"
],
"type": "string",
"description": "Rank the matching posts by one figure of their best destination instead: any counter (views, likes, …) or insight (reach, avgWatchMs, completionRate, retentionAt3s, retentionAtHalf, …). Answers \"which hooks held viewers\" or \"what is moving now\". Ranks up to 500 matching posts; no cursor."
},
"sort_by": {
"enum": [
"views",
"likes",
"comments",
"shares",
"saves",
"reach",
"totalWatchMs",
"replays",
"follows",
"when",
"updated",
"account"
],
"type": "string",
"description": "A counter or insight (views, likes, …), \"when\", \"updated\" or \"account\". Defaults to newest first."
},
"platform": {
"type": "array",
"items": {
"enum": [
"tiktok",
"instagram",
"facebook",
"x",
"youtube",
"linkedin"
],
"type": "string"
}
},
"account_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Accounts by id, from accounts_list."
}
}
}| groups | array | Group names from groups_list, expanded to their members and combined with account_ids. Matched without regard to case. |
| content | string | The caption. |
| post_id | string | A post to change or cancel, from posts_list. Omit to create one. |
| media_ids | array | New posts only. Files to attach, in order — the slideshow order. |
| account_ids | array | Accounts to post to, from accounts_list. On a new post, optional when groups is given; naming neither is refused. On an existing post, replaces the destinations — send every account you want. |
| scheduled_at | string | ISO 8601. Omit to send as soon as possible. A time in the past sends as soon as possible. |
| idempotency_key | string | New posts only. Reuse on retry to avoid posting twice; returns the original post. |
| platform_options | object | New posts only. Per-platform settings, keyed by platform. Only the keys shown are accepted — an unknown key is refused rather than ignored. Call platforms_list for what each one does, its default, and which kind of post it applies to. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"draft": {
"type": "boolean",
"description": "True holds the post here: nothing is queued and nothing reaches any platform. On an existing post, false sends a draft and true returns a scheduled post to draft. Unrelated to the per-platform draft option, which uploads to the platform for the creator to finish."
},
"cancel": {
"type": "boolean",
"description": "With post_id: stop the post before it goes out."
},
"groups": {
"type": "array",
"items": {
"type": "string"
},
"description": "Group names from groups_list, expanded to their members and combined with account_ids. Matched without regard to case."
},
"content": {
"type": "string",
"description": "The caption."
},
"post_id": {
"type": "string",
"description": "A post to change or cancel, from posts_list. Omit to create one."
},
"media_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "New posts only. Files to attach, in order — the slideshow order."
},
"account_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Accounts to post to, from accounts_list. On a new post, optional when groups is given; naming neither is refused. On an existing post, replaces the destinations — send every account you want."
},
"scheduled_at": {
"type": "string",
"description": "ISO 8601. Omit to send as soon as possible. A time in the past sends as soon as possible."
},
"idempotency_key": {
"type": "string",
"description": "New posts only. Reuse on retry to avoid posting twice; returns the original post."
},
"platform_options": {
"type": "object",
"properties": {
"x": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"tiktok": {
"type": "object",
"properties": {
"draft": {
"type": "boolean"
},
"title": {
"type": "string",
"maxLength": 90
},
"isAigc": {
"type": "boolean"
},
"disableDuet": {
"type": "boolean"
},
"autoAddMusic": {
"type": "boolean"
},
"privacyLevel": {
"enum": [
"PUBLIC_TO_EVERYONE",
"MUTUAL_FOLLOW_FRIENDS",
"FOLLOWER_OF_CREATOR",
"SELF_ONLY"
],
"type": "string"
},
"disableStitch": {
"type": "boolean"
},
"disableComment": {
"type": "boolean"
},
"photoCoverIndex": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"brandContentToggle": {
"type": "boolean"
},
"brandOrganicToggle": {
"type": "boolean"
},
"videoCoverTimestampMs": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"youtube": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
},
"privacy": {
"enum": [
"public",
"unlisted",
"private"
],
"type": "string"
},
"categoryId": {
"type": "string"
},
"madeForKids": {
"type": "boolean"
},
"containsSyntheticMedia": {
"type": "boolean"
}
},
"additionalProperties": false
},
"facebook": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"instagram": {
"type": "object",
"properties": {
"story": {
"type": "boolean"
},
"coverUrl": {
"type": "string",
"format": "uri"
},
"trialReel": {
"enum": [
"SS_PERFORMANCE",
"MANUAL"
],
"type": "string"
},
"shareToFeed": {
"type": "boolean"
},
"thumbOffset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"isAiGenerated": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"description": "New posts only. Per-platform settings, keyed by platform. Only the keys shown are accepted — an unknown key is refused rather than ignored. Call platforms_list for what each one does, its default, and which kind of post it applies to."
}
}
}| language | string | Only this language, as a two-letter code such as en. Posts whose language the platform could not tell are kept. |
| question | string | What you want to know, in plain words, as you would ask a researcher. Starts a new search for it. Needs product_id. |
| platforms | array | Which platforms to search and answer from: tiktok, instagram, or both. Default both. |
| thread_id | string | A thread from an earlier call. Alone, it returns where that question is, or its answer once ready. With a question, it asks a follow-up on the same thread once the last one is done. |
| product_id | string | The product this is for, from products_list. Required with a question. Without one, narrows the index read to this product. |
| include_ads | boolean | Include posts the platform marks as paid promotion or a paid partnership. Default false. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"fit": {
"enum": [
"relevant",
"in_niche",
"all"
],
"type": "string",
"description": "How closely a post must fit your product. relevant (default) drops posts judged off-topic and keeps ones not judged yet; in_niche keeps only judged in-niche posts; all keeps everything."
},
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "How many posts. Default 10."
},
"since": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"description": "Posted on or after this ISO 8601 time. Default: 7 days ago for an index read, 30 days for a question’s answer."
},
"medium": {
"enum": [
"video",
"slideshow"
],
"type": "string",
"description": "Only videos, or only slideshows."
},
"language": {
"type": "string",
"maxLength": 5,
"minLength": 2,
"description": "Only this language, as a two-letter code such as en. Posts whose language the platform could not tell are kept."
},
"question": {
"type": "string",
"maxLength": 2000,
"description": "What you want to know, in plain words, as you would ask a researcher. Starts a new search for it. Needs product_id."
},
"platforms": {
"type": "array",
"items": {
"enum": [
"tiktok",
"instagram"
],
"type": "string"
},
"minItems": 1,
"description": "Which platforms to search and answer from: tiktok, instagram, or both. Default both."
},
"thread_id": {
"type": "string",
"description": "A thread from an earlier call. Alone, it returns where that question is, or its answer once ready. With a question, it asks a follow-up on the same thread once the last one is done."
},
"product_id": {
"type": "string",
"description": "The product this is for, from products_list. Required with a question. Without one, narrows the index read to this product."
},
"include_ads": {
"type": "boolean",
"description": "Include posts the platform marks as paid promotion or a paid partnership. Default false."
}
}
}