Tools
The tools are in six groups. Each tool returns a short JSON reply. No tool posts a slideshow to TikTok.
Slideshows
| Tool | What it does |
|---|---|
account_list | Lists your accounts with their exact handles and slideshow templates. |
slideshow_batch | Saves a full set of posts from one copy file. It returns one app link for each draft. |
slideshow_create | Saves one slideshow draft from exact content: slides, text, photos, caption, and hashtags. The draft takes the next free slot of the account on the calendar. |
slideshow_update | Changes the title, caption, hashtags, or slides of a draft, such as the position of one text box. To change the slides of a draft that was made or changed in the app, it needs keepAppSettings. |
slideshow_get | Shows a slideshow in the same form that slideshow_create accepts. |
slideshow_list | Lists slideshows. It can show only the drafts that are not on the calendar. |
slideshow_preview | Shows all the slides of a draft on one image. It does not change the draft. |
slideshow_export | Writes the full-size PNG slides, the caption, and a list of the files into a folder. |
slideshow_duplicate | Copies a slideshow to a new draft with the same slides and caption. The copy can go to another account. |
For a full set of posts,
slideshow_batch is the fast method. Refer to Copy in, drafts out.Cleanup
| Tool | What it does |
|---|---|
slideshow_discard | Removes slideshows that you do not need, such as old drafts. It keeps the slides, so you can restore them. It accepts one ID or a list of IDs. |
slideshow_restore | Brings discarded slideshows back as drafts. |
slideshow_delete | Permanently deletes discarded slideshows. You cannot undo this. It operates only on discarded slideshows. |
Discard does not change a slideshow that is scheduled, sent to the TikTok inbox, or posted. To discard a scheduled slideshow, first cancel its delivery in the app.
slideshow_list shows discarded slideshows only when you ask for the status discarded.Pictures
| Tool | What it does |
|---|---|
image_search | Finds photos in your library by what they show, such as "a woman on a couch". It can search only some packs. It can also ignore the photos that your account uses. |
image_import | Adds a public image URL to your library with an optional pack and name. |
image_upload | Adds a PNG, JPG, or WebP photo from your computer to your library. |
image_view | Shows up to 24 photos on one sheet, each with a number and a name. |
image_pack_list | Lists your photo packs, with the number of photos in each. |
image_list | Lists the photos of one pack, with the number of slideshows that show each photo. |
image_pack_create | Makes an empty pack. If a pack with that name exists, it returns that pack. |
image_move | Moves photos to another pack. To keep photos out of new drafts, move them out of the template pack. |
image_delete | Permanently deletes photos. You cannot undo this. It does not delete a photo that a slideshow shows, unless you ask for it. |
Review queue
| Tool | What it does |
|---|---|
review_list | Lists the posts in the review queue. |
review_show | Shows one post in the review queue. |
review_edit | Changes the slide text and the caption of a post in the review queue. |
review_mark | Records your decision on a post: approved or sent back. Approval needs the review.approve capability. |
Calendar
| Tool | What it does |
|---|---|
calendar_list | Shows the slots of an account for up to 31 days. Each slot is free or shows the slideshow in it. |
slideshow_schedule | Puts a draft in a slot, at an exact time or in the next free slot. It can also remove a draft from the calendar. It does not approve the draft. |
Playbook
The Playbook keeps the rules of each content format. It has one entry for each format. You can also edit the Playbook on its page in the app.
| Tool | What it does |
|---|---|
playbook_list | Lists the entries, each with its type, its accounts, and one line about it. It can show only the formats of one account. |
playbook_get | Shows one entry: first the example lines of its active voice, then reference posts, voice rules, look rules, ideas, reference photos, and used lines. |
playbook_create | Adds an entry for a new format, with its type and accounts. |
playbook_edit | Changes one section of an entry and records the reason for the change. It also sets the type and the accounts of an entry. |
playbook_add_used_lines | Records each cover line and headline that a set used. Thus no line occurs two times. |
playbook_voice_list | Lists the writing voices that an entry keeps, and shows which one is active. |
playbook_voice_save | Keeps a writing voice: real example lines and their copy rules. It can also change a voice. |
playbook_voice_activate | Makes a kept voice the active voice of an entry, and records the reason. |