PeerTube

App · 20 actions

Read any PeerTube site, the free and federated video platform: search videos, channels and playlists, list what is new or trending, and get a video's description, chapters, comments, captions and transcript, with download links. Read channels, accounts and playlists, and start a workflow when a channel publishes a new video. No account needed.

Actions

ActionWhat it does
Get a channelGet one channel: its name, description, followers, picture and the account that owns it.
Get a comment threadGet one comment on a video and every reply to it, in reading order, each with its depth in the conversation.
Get a playlistGet one public playlist: its title, description, how many videos it holds, and the account and channel it belongs to.
Get a videoGet one video with its whole description, tags, length, views, likes, category, language, licence, channel and account, plus its streaming address and a download link for each quality.
Get a video's transcriptRead a video's captions as a transcript: the whole text, ready for a summarising or translating step, and every line with its timing.
Get an accountGet one account: its name, description, followers and picture.
Get site infoGet the connected PeerTube site's own details: its name, description, rules, who runs it, its languages and categories, whether anyone can sign up, its PeerTube version, and how many users, videos and channels it has.
List a channel's playlistsList the public playlists shown on a channel, with how many videos each holds.
List a channel's videosList a channel's videos, newest first or by views, likes, comments or length.
List a playlist's videosList the videos in a playlist, in its order.
List a video's captionsList the languages a video has captions in, whether each was transcribed automatically, and the address of each captions file.
List a video's chaptersList the chapters the uploader marked in a video, each with its title and where it starts.
List a video's commentsList the comments on a video, one per thread, as plain text with their author and how many replies each has.
List an account's channelsList the channels an account owns, with their handles and followers.
List an account's playlistsList an account's public playlists, on all of its channels, with how many videos each holds.
List an account's videosList the videos an account published, on all of its channels, newest first or by views, likes, comments or length.
List the site's videosList the videos on the connected PeerTube site: the newest, what is trending or hot, or the most viewed, liked or commented.
Search channelsSearch the connected PeerTube site for channels by name or description, its own and those of the sites it follows.
Search playlistsSearch the connected PeerTube site for public playlists by title, its own and those of the sites it follows.
Search videosSearch the connected PeerTube site for videos, by words in the title, description or tags, then narrow by length, publication date, category, language and licence, or keep to videos uploaded to the site itself.

Get a channel

Get one channel: its name, description, followers, picture and the account that owns it. No account needed.

Inputs

ChannelchanneltextRequired
The channel: its name (as in the address of its page), its handle name@site for a channel from another site, or the address of its page.

Outputs

avatar_urltext
The channel's picture.
banner_urltext
The channel's banner image.
created_attext
When the channel was created, in ISO 8601.
descriptiontext
The channel's description.
display_nametext
The channel's name as shown to viewers.
followersnumber
How many accounts follow the channel.
handletext
The channel's full handle, name@site. Pass it to the other channel actions.
hosttext
The site the channel belongs to.
idnumber
The channel's number on the connected site.
is_localtrue/false
True when the channel belongs to the connected site.
nametext
The channel's name, as in the address of its page.
original_urltext
The channel's page on its own site.
ownerobject
The account that owns the channel.
supporttext
The channel's note on how to support it, if any.
urltext
The channel's page on the connected site.
Example output
{
  "avatar_url": "https://framatube.org/lazy-static/avatars/0e469ff4-7f66-4049-8d1f-bbba685e687c.png",
  "banner_url": null,
  "created_at": "2021-08-09T14:26:09.514Z",
  "description": "Un logiciel libre pour reprendre le contr\u00f4le de vos vid\u00e9os",
  "display_name": "A propos de PeerTube",
  "followers": 312,
  "handle": "joinpeertube@framatube.org",
  "host": "framatube.org",
  "id": 2215,
  "is_local": true,
  "name": "joinpeertube",
  "original_url": "https://framatube.org/video-channels/joinpeertube",
  "owner": {
    "display_name": "Framasoft",
    "handle": "framasoft@framatube.org",
    "name": "framasoft",
    "url": "https://framatube.org/a/framasoft"
  },
  "support": null,
  "url": "https://framatube.org/c/joinpeertube"
}

Get a comment thread

Get one comment on a video and every reply to it, in reading order, each with its depth in the conversation. No account needed.

Inputs

VideovideotextRequired
The video: its address (copy it from the browser), its short ID, its UUID or its number. Search and list results return the short ID.
ThreadthreadtextRequired
The thread's number, which 'List a video's comments' returns, or the address of the comment.

Outputs

commentobject
The comment that starts the thread.
replieslist
Every reply, in reading order, each with its depth.
replies_not_shownnumber
Replies the site left out because they are too deep in the thread or too many under one comment.
reply_countnumber
How many replies are returned.
videoobject
The video.
Example output
{
  "comment": {
    "author": {
      "display_name": "formminecraftfiretoblenderfire",
      "handle": "formminecraftfiretoblenderfire@mastodon.social",
      "name": "formminecraftfiretoblenderfire",
      "url": "https://framatube.org/a/formminecraftfiretoblenderfire@mastodon.social"
    },
    "created_at": "2026-01-13T15:14:39.000Z",
    "depth": 0,
    "id": 43386,
    "in_reply_to_id": null,
    "is_deleted": false,
    "original_url": "https://mastodon.social/ap/users/115888383712211379/statuses/115888441227391124",
    "reply_count": 2,
    "text": "@framasoft PeerTube is open source, which means it can be upgraded by the owner or admin.",
    "thread_id": 43386,
    "updated_at": "2026-06-09T08:39:45.495Z",
    "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv;threadId=43386"
  },
  "replies": [
    {
      "author": {
        "display_name": "covjek",
        "handle": "covjek@mastodon.social",
        "name": "covjek",
        "url": "https://framatube.org/a/covjek@mastodon.social"
      },
      "created_at": "2026-06-01T10:00:00.000Z",
      "depth": 1,
      "id": 44304,
      "in_reply_to_id": 43386,
      "is_deleted": false,
      "original_url": "https://mastodon.social/@covjek/116000000000000000",
      "reply_count": 0,
      "text": "@formminecraftfiretoblenderfire Good point.",
      "thread_id": 43386,
      "updated_at": "2026-06-01T10:00:00.000Z",
      "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv;threadId=43386"
    }
  ],
  "replies_not_shown": 0,
  "reply_count": 1,
  "video": {
    "id": 1717,
    "name": "What is PeerTube?",
    "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
    "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv"
  }
}

Get a playlist

Get one public playlist: its title, description, how many videos it holds, and the account and channel it belongs to. No account needed.

Inputs

PlaylistplaylisttextRequired
The playlist: its address (copy it from the browser), its short ID, its UUID or its number. Playlist searches and lists return the short ID.

Outputs

channelobject
The channel the playlist is shown on, if any.
created_attext
When it was created, in ISO 8601.
descriptiontext
The playlist's description.
idnumber
The playlist's number on the connected site.
is_localtrue/false
True when the playlist belongs to the connected site.
nametext
The playlist's title.
original_urltext
The playlist's page on its own site.
ownerobject
The account that made the playlist.
privacytext
Public or Unlisted.
short_uuidtext
The playlist's short ID, the code at the end of its address. Pass it to the other playlist actions.
thumbnail_urltext
The playlist's preview image.
typetext
Regular, or Watch later for an account's own list.
updated_attext
When it last changed, in ISO 8601.
urltext
The playlist's page on the connected site.
uuidtext
The playlist's UUID, the same on every PeerTube site.
video_countnumber
How many videos it holds.
Example output
{
  "channel": {
    "display_name": "MOOC-CHATONS#1 - Internet, reprendre le contr\u00f4le",
    "handle": "mooc.chatons.1@framatube.org",
    "name": "mooc.chatons.1",
    "url": "https://framatube.org/c/mooc.chatons.1"
  },
  "created_at": "2020-02-24T17:00:37.914Z",
  "description": "Retrouvez ici les vid\u00e9os courtes des interview r\u00e9alis\u00e9es pour le MOOC-CHATONS#1",
  "id": 310,
  "is_local": true,
  "name": "Interviews courtes du MOOC CHATONS",
  "original_url": "https://framatube.org/video-playlists/d8ca79f9-e4c7-4269-8183-d78ed269c909",
  "owner": {
    "display_name": "Framasoft",
    "handle": "framasoft@framatube.org",
    "name": "framasoft",
    "url": "https://framatube.org/a/framasoft"
  },
  "privacy": "Public",
  "short_uuid": "sLFbqXsw7sPR3AfvqQSBZB",
  "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/playlist-d8ca79f9-e4c7-4269-8183-d78ed269c909.jpg",
  "type": "Regular",
  "updated_at": "2020-02-25T09:26:48.531Z",
  "url": "https://framatube.org/w/p/sLFbqXsw7sPR3AfvqQSBZB",
  "uuid": "d8ca79f9-e4c7-4269-8183-d78ed269c909",
  "video_count": 12
}

Get a video

Get one video with its whole description, tags, length, views, likes, category, language, licence, channel and account, plus its streaming address and a download link for each quality. Give its address, short ID, UUID or number. No account needed.

Inputs

VideovideotextRequired
The video: its address (copy it from the browser), its short ID, its UUID or its number. Search and list results return the short ID.

Outputs

accountobject
The account that published it.
categorytext
Its category, such as Science & Technology.
channelobject
The channel it was published on.
commentsnumber
How many comments it has.
comments_policytext
Whether comments are Enabled, Disabled or need approval.
created_attext
When it was uploaded, in ISO 8601.
descriptiontext
The video's whole description, in Markdown.
dislikesnumber
How many dislikes it has.
downloads_enabledtrue/false
True when the uploader allows downloading the video.
durationtext
How long the video is, such as 1:53 or 1:02:03.
duration_secondsnumber
How long the video is, in seconds.
embed_urltext
An address for embedding the player in a web page.
fileslist
The video's files, best quality first.
hosttext
The site it was uploaded to, such as framatube.org.
idnumber
The video's number on the connected site.
is_livetrue/false
True for a live stream.
is_localtrue/false
True when it was uploaded to the connected site itself.
is_sensitivetrue/false
True when it is marked as sensitive content.
languagetext
The language spoken in it, such as English.
language_codetext
That language's code, such as en.
licencetext
Its licence, such as Attribution - Share Alike.
likesnumber
How many likes it has.
nametext
The video's title.
original_urltext
The video's page on the site it was uploaded to.
originally_published_attext
When it was first published elsewhere, if the uploader gave a date.
privacytext
Public or Unlisted.
published_attext
When it was published, in ISO 8601.
short_uuidtext
The video's short ID, the code at the end of its address. Pass it to the other video actions.
statetext
Published, or where it is in processing.
stream_urltext
The video's HLS streaming playlist (.m3u8).
supporttext
The uploader's note on how to support them, if any.
tagslist
The video's tags.
thumbnail_urltext
The video's preview image.
updated_attext
When it last changed, in ISO 8601.
urltext
The video's page on the connected site.
uuidtext
The video's UUID, the same on every PeerTube site.
viewsnumber
How many times it has been viewed.
Example output
{
  "account": {
    "display_name": "Framasoft",
    "handle": "framasoft@framatube.org",
    "name": "framasoft",
    "url": "https://framatube.org/a/framasoft"
  },
  "category": "Science & Technology",
  "channel": {
    "display_name": "A propos de PeerTube",
    "handle": "joinpeertube@framatube.org",
    "name": "joinpeertube",
    "url": "https://framatube.org/c/joinpeertube"
  },
  "comments": 13,
  "comments_policy": "Enabled",
  "created_at": "2018-09-28T13:43:34.834Z",
  "description": "**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on free/libre software!*",
  "dislikes": 0,
  "downloads_enabled": true,
  "duration": "1:53",
  "duration_seconds": 113,
  "embed_url": "https://framatube.org/videos/embed/kkGMgK9ZtnKfYAgnEtQxbv",
  "files": [
    {
      "download_url": "https://framatube.org/download/streaming-playlists/hls/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d-1080-fragmented.mp4",
      "height": 1080,
      "quality": "1080p",
      "size_bytes": 16815344
    }
  ],
  "host": "framatube.org",
  "id": 1717,
  "is_live": false,
  "is_local": true,
  "is_sensitive": false,
  "language": "English",
  "language_code": "en",
  "licence": "Attribution - Share Alike",
  "likes": 35,
  "name": "What is PeerTube?",
  "original_url": "https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d",
  "originally_published_at": null,
  "privacy": "Public",
  "published_at": "2018-10-01T10:52:46.396Z",
  "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
  "state": "Published",
  "stream_url": "https://framatube.org/static/streaming-playlists/hls/9c9de5e8-0a1e-484a-b099-e80766180a6d/c28d0633-b88d-44c0-a236-e5f40f7e2d35-master.m3u8",
  "support": null,
  "tags": [
    "framasoft",
    "peertube"
  ],
  "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/294e3020-218a-4af6-b1e9-b755102a5c5a.jpg",
  "updated_at": "2026-10-21T05:10:38.479Z",
  "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv",
  "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
  "views": 148842
}

Get a video's transcript

Read a video's captions as a transcript: the whole text, ready for a summarising or translating step, and every line with its timing. Pick a language, or get the one spoken in the video. A video without captions comes back with 'found' set to false rather than failing the step. No account needed.

Inputs

VideovideotextRequired
The video: its address (copy it from the browser), its short ID, its UUID or its number. Search and list results return the short ID.
Languagelanguagetext
Which captions to read. Leave empty for the language spoken in the video, or the first captions it has.

Outputs

auto_generatedtrue/false
True when the captions were transcribed automatically.
available_languageslist
Every language the video has captions in, as codes.
file_urltext
The captions file that was read.
foundtrue/false
True when the video has captions. False means it has none, and the text is empty.
languagetext
The language of the captions read, such as English.
language_codetext
The language code of the captions read, such as en.
segment_countnumber
How many caption lines it has.
segmentslist
Every caption line with its timing.
texttext
The whole transcript, one caption line per line.
videoobject
The video.
Example output
{
  "auto_generated": false,
  "available_languages": [
    "en",
    "fr"
  ],
  "file_url": "https://framatube.org/lazy-static/video-captions/423f7e0c-01c5-40ba-92c1-bbe35f4c30ba-en.vtt",
  "found": true,
  "language": "English",
  "language_code": "en",
  "segment_count": 2,
  "segments": [
    {
      "end_seconds": 1.872,
      "start": "0:00",
      "start_seconds": 0.0,
      "text": "What is PeerTube?"
    },
    {
      "end_seconds": 4.153,
      "start": "0:01",
      "start_seconds": 1.872,
      "text": "Peertube is an open-source video platform."
    }
  ],
  "text": "What is PeerTube?\nPeertube is an open-source video platform.",
  "video": {
    "id": 1717,
    "name": "What is PeerTube?",
    "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
    "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv"
  }
}

Get an account

Get one account: its name, description, followers and picture. An account owns channels and publishes videos on them. No account needed.

Inputs

AccountaccounttextRequired
The account: its name (as in the address of its page), its handle name@site for an account from another site, or the address of its page.

Outputs

avatar_urltext
The account's picture.
created_attext
When the account was created, in ISO 8601.
descriptiontext
The account's description.
display_nametext
The account's name as shown to viewers.
followersnumber
How many accounts follow it.
followingnumber
How many accounts and channels it follows.
handletext
The account's full handle, name@site. Pass it to the other account actions.
hosttext
The site the account belongs to.
idnumber
The account's number on the connected site.
is_localtrue/false
True when the account belongs to the connected site.
nametext
The account's name, as in the address of its page.
original_urltext
The account's page on its own site.
urltext
The account's page on the connected site.
Example output
{
  "avatar_url": "https://framatube.org/lazy-static/avatars/5bcda318-5274-4682-9220-307f378f4382.png",
  "created_at": "2018-03-01T15:16:17.118Z",
  "description": null,
  "display_name": "Framasoft",
  "followers": 1050,
  "following": 0,
  "handle": "framasoft@framatube.org",
  "host": "framatube.org",
  "id": 3,
  "is_local": true,
  "name": "framasoft",
  "original_url": "https://framatube.org/accounts/framasoft",
  "url": "https://framatube.org/a/framasoft"
}

Get site info

Get the connected PeerTube site's own details: its name, description, rules, who runs it, its languages and categories, whether anyone can sign up, its PeerTube version, and how many users, videos and channels it has. No account needed.

Inputs

None.

Outputs

administratortext
Who runs the site.
avatar_urltext
The site's logo.
banner_urltext
The site's banner image.
business_modeltext
How the site is paid for.
categorieslist
The categories the site's videos are mostly in.
code_of_conducttext
The site's code of conduct.
creation_reasontext
Why the site was created.
descriptiontext
The site's description, in Markdown.
hosttext
The site's domain.
is_sensitive_sitetrue/false
True when the site is dedicated to sensitive content.
languageslist
The languages the site's videos are mostly in.
maintenance_lifetimetext
How long the site means to stay up.
moderation_informationtext
How the site is moderated.
nametext
The site's name.
sensitive_videostext
What the site does with sensitive videos by default: Hidden, Blurred, Shown with a warning or Shown.
short_descriptiontext
The site's one-line description.
signup_needs_approvaltrue/false
True when new accounts must be approved.
signup_opentrue/false
True when anyone can create an account.
statsobject
The site's public statistics; empty where it keeps them private.
termstext
The site's terms of use.
urltext
The site's address.
versiontext
The PeerTube version it runs.
Example output
{
  "administrator": "Framatube is run by Framasoft.",
  "avatar_url": "https://framatube.org/lazy-static/avatars/59e98d0f-7b0f-4ab5-bbe7-e4454b4c68f1.png",
  "banner_url": "https://framatube.org/lazy-static/banners/da35148a-0956-45ed-816d-dec82a737704.png",
  "business_model": "Framatube is financed by Framasoft donations.",
  "categories": [
    "Science & Technology",
    "Education"
  ],
  "code_of_conduct": "Please see https://framasoft.org/fr/moderation/",
  "creation_reason": "Framatube is a repository of videos about Framasoft.",
  "description": "[Framasoft](https://framasoft.org/) PeerTube platform.",
  "host": "framatube.org",
  "is_sensitive_site": false,
  "languages": [
    "English",
    "French"
  ],
  "maintenance_lifetime": "As long as possible.",
  "moderation_information": "Please see https://framasoft.org/fr/moderation/",
  "name": "Framatube",
  "sensitive_videos": "Hidden",
  "short_description": "PeerTube platform dedicated to Framasoft's videos.",
  "signup_needs_approval": true,
  "signup_open": false,
  "stats": {
    "all_videos": 24330,
    "comments": 6686,
    "followers": 195,
    "following": 29,
    "local_channels": 28,
    "local_playlists": 13,
    "local_video_views": 1008077,
    "local_videos": 932,
    "users": 9
  },
  "terms": "Please see: https://framasoft.org/fr/legals/",
  "url": "https://framatube.org",
  "version": "8.3.1"
}

List a channel's playlists

List the public playlists shown on a channel, with how many videos each holds. No account needed.

Inputs

ChannelchanneltextRequired
The channel: its name (as in the address of its page), its handle name@site for a channel from another site, or the address of its page.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

channeltext
The channel that was read.
countnumber
How many playlists are returned here.
more_availabletrue/false
True when more playlists match than were returned; raise the limit to read more.
playlistslist
The playlists.
totalnumber
How many playlists match in all.
Example output
{
  "channel": "mooc.chatons.1",
  "count": 1,
  "more_available": false,
  "playlists": [
    {
      "channel": {
        "display_name": "MOOC-CHATONS#1 - Internet, reprendre le contr\u00f4le",
        "handle": "mooc.chatons.1@framatube.org",
        "name": "mooc.chatons.1",
        "url": "https://framatube.org/c/mooc.chatons.1"
      },
      "created_at": "2020-02-24T17:00:37.914Z",
      "description": "Retrouvez ici les vid\u00e9os courtes des interview r\u00e9alis\u00e9es pour le MOOC-CHATONS#1",
      "id": 310,
      "is_local": true,
      "name": "Interviews courtes du MOOC CHATONS",
      "original_url": "https://framatube.org/video-playlists/d8ca79f9-e4c7-4269-8183-d78ed269c909",
      "owner": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "privacy": "Public",
      "short_uuid": "sLFbqXsw7sPR3AfvqQSBZB",
      "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/playlist-d8ca79f9-e4c7-4269-8183-d78ed269c909.jpg",
      "type": "Regular",
      "updated_at": "2020-02-25T09:26:48.531Z",
      "url": "https://framatube.org/w/p/sLFbqXsw7sPR3AfvqQSBZB",
      "uuid": "d8ca79f9-e4c7-4269-8183-d78ed269c909",
      "video_count": 12
    }
  ],
  "total": 1
}

List a channel's videos

List a channel's videos, newest first or by views, likes, comments or length. No account needed.

Inputs

ChannelchanneltextRequired
The channel: its name (as in the address of its page), its handle name@site for a channel from another site, or the address of its page.
Orderordertext
Which videos come first. Newest first by default.One of: newest (Newest first), oldest (Oldest first), most_viewed (Most viewed), most_liked (Most liked), most_commented (Most commented), longest (Longest first). Default: newest.
Sensitive videossensitivetext
What to do with videos marked as sensitive content. They are left out unless you choose otherwise, as the site does for visitors.One of: hide (Leave sensitive videos out), include (Include sensitive videos), only (Only sensitive videos). Default: hide.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

channeltext
The channel that was read.
countnumber
How many videos are returned here.
more_availabletrue/false
True when more videos match than were returned; raise the limit to read more.
totalnumber
How many videos match in all.
videoslist
The videos.
Example output
{
  "channel": "joinpeertube",
  "count": 1,
  "more_available": false,
  "total": 1,
  "videos": [
    {
      "account": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "category": "Science & Technology",
      "channel": {
        "display_name": "A propos de PeerTube",
        "handle": "joinpeertube@framatube.org",
        "name": "joinpeertube",
        "url": "https://framatube.org/c/joinpeertube"
      },
      "comments": 13,
      "description_preview": "**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**...",
      "dislikes": 0,
      "duration": "1:53",
      "duration_seconds": 113,
      "embed_url": "https://framatube.org/videos/embed/kkGMgK9ZtnKfYAgnEtQxbv",
      "host": "framatube.org",
      "id": 1717,
      "is_live": false,
      "is_local": true,
      "is_sensitive": false,
      "language": "English",
      "language_code": "en",
      "licence": "Attribution - Share Alike",
      "likes": 35,
      "name": "What is PeerTube?",
      "original_url": "https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "originally_published_at": null,
      "published_at": "2018-10-01T10:52:46.396Z",
      "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
      "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/294e3020-218a-4af6-b1e9-b755102a5c5a.jpg",
      "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv",
      "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "views": 148842
    }
  ]
}

List a playlist's videos

List the videos in a playlist, in its order. A video that was deleted or made private keeps its place, marked as no longer available. No account needed.

Inputs

PlaylistplaylisttextRequired
The playlist: its address (copy it from the browser), its short ID, its UUID or its number. Playlist searches and lists return the short ID.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

countnumber
How many videos are returned here.
entrieslist
The videos.
more_availabletrue/false
True when more videos match than were returned; raise the limit to read more.
playlisttext
The playlist that was read.
totalnumber
How many videos match in all.
Example output
{
  "count": 2,
  "entries": [
    {
      "position": 1,
      "start_seconds": null,
      "status": "Available",
      "stop_seconds": null,
      "video": {
        "account": {
          "display_name": "Framasoft",
          "handle": "framasoft@framatube.org",
          "name": "framasoft",
          "url": "https://framatube.org/a/framasoft"
        },
        "category": "Science & Technology",
        "channel": {
          "display_name": "A propos de PeerTube",
          "handle": "joinpeertube@framatube.org",
          "name": "joinpeertube",
          "url": "https://framatube.org/c/joinpeertube"
        },
        "comments": 13,
        "description_preview": "**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**...",
        "dislikes": 0,
        "duration": "1:53",
        "duration_seconds": 113,
        "embed_url": "https://framatube.org/videos/embed/kkGMgK9ZtnKfYAgnEtQxbv",
        "host": "framatube.org",
        "id": 1717,
        "is_live": false,
        "is_local": true,
        "is_sensitive": false,
        "language": "English",
        "language_code": "en",
        "licence": "Attribution - Share Alike",
        "likes": 35,
        "name": "What is PeerTube?",
        "original_url": "https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d",
        "originally_published_at": null,
        "published_at": "2018-10-01T10:52:46.396Z",
        "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
        "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/294e3020-218a-4af6-b1e9-b755102a5c5a.jpg",
        "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv",
        "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
        "views": 148842
      }
    },
    {
      "position": 2,
      "start_seconds": null,
      "status": "Private",
      "stop_seconds": null,
      "video": null
    }
  ],
  "more_available": false,
  "playlist": "sLFbqXsw7sPR3AfvqQSBZB",
  "total": 2
}

List a video's captions

List the languages a video has captions in, whether each was transcribed automatically, and the address of each captions file. No account needed.

Inputs

VideovideotextRequired
The video: its address (copy it from the browser), its short ID, its UUID or its number. Search and list results return the short ID.

Outputs

captionslist
The captions, one set per language.
countnumber
How many languages it has captions in.
videoobject
The video.
Example output
{
  "captions": [
    {
      "auto_generated": false,
      "file_url": "https://framatube.org/lazy-static/video-captions/423f7e0c-01c5-40ba-92c1-bbe35f4c30ba-en.vtt",
      "language": "English",
      "language_code": "en",
      "updated_at": "2022-05-10T12:51:17.000Z"
    }
  ],
  "count": 1,
  "video": {
    "id": 1717,
    "name": "What is PeerTube?",
    "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
    "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv"
  }
}

List a video's chapters

List the chapters the uploader marked in a video, each with its title and where it starts. A video without chapters returns an empty list. No account needed.

Inputs

VideovideotextRequired
The video: its address (copy it from the browser), its short ID, its UUID or its number. Search and list results return the short ID.

Outputs

chapterslist
The chapters, in order.
countnumber
How many chapters it has.
videoobject
The video.
Example output
{
  "chapters": [
    {
      "start": "0:00",
      "start_seconds": 0,
      "title": "Introduction"
    },
    {
      "start": "2:17",
      "start_seconds": 137,
      "title": "Who are you, anyway?"
    }
  ],
  "count": 2,
  "video": {
    "id": 1717,
    "name": "What is PeerTube?",
    "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
    "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv"
  }
}

List a video's comments

List the comments on a video, one per thread, as plain text with their author and how many replies each has. Many come from Mastodon and other sites that follow the video. Pass a thread number to 'Get a comment thread' to read its replies. No account needed.

Inputs

VideovideotextRequired
The video: its address (copy it from the browser), its short ID, its UUID or its number. Search and list results return the short ID.
Orderordertext
Which comments come first. Newest first by default.One of: newest (Newest first), oldest (Oldest first), most_replies (Most replies first). Default: newest.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

commentslist
The comment threads.
countnumber
How many comment threads are returned here.
more_availabletrue/false
True when more comment threads match than were returned; raise the limit to read more.
totalnumber
How many comment threads match in all.
videoobject
The video.
Example output
{
  "comments": [
    {
      "author": {
        "display_name": "formminecraftfiretoblenderfire",
        "handle": "formminecraftfiretoblenderfire@mastodon.social",
        "name": "formminecraftfiretoblenderfire",
        "url": "https://framatube.org/a/formminecraftfiretoblenderfire@mastodon.social"
      },
      "created_at": "2026-01-13T15:14:39.000Z",
      "depth": 0,
      "id": 43386,
      "in_reply_to_id": null,
      "is_deleted": false,
      "original_url": "https://mastodon.social/ap/users/115888383712211379/statuses/115888441227391124",
      "reply_count": 2,
      "text": "@framasoft PeerTube is open source, which means it can be upgraded by the owner or admin.",
      "thread_id": 43386,
      "updated_at": "2026-06-09T08:39:45.495Z",
      "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv;threadId=43386"
    }
  ],
  "count": 1,
  "more_available": false,
  "total": 1,
  "video": {
    "id": 1717,
    "name": "What is PeerTube?",
    "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
    "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv"
  }
}

List an account's channels

List the channels an account owns, with their handles and followers. No account needed.

Inputs

AccountaccounttextRequired
The account: its name (as in the address of its page), its handle name@site for an account from another site, or the address of its page.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

accounttext
The account that was read.
channelslist
The channels.
countnumber
How many channels are returned here.
more_availabletrue/false
True when more channels match than were returned; raise the limit to read more.
totalnumber
How many channels match in all.
Example output
{
  "account": "framasoft",
  "channels": [
    {
      "avatar_url": "https://framatube.org/lazy-static/avatars/0e469ff4-7f66-4049-8d1f-bbba685e687c.png",
      "banner_url": null,
      "created_at": "2021-08-09T14:26:09.514Z",
      "description": "Un logiciel libre pour reprendre le contr\u00f4le de vos vid\u00e9os",
      "display_name": "A propos de PeerTube",
      "followers": 312,
      "handle": "joinpeertube@framatube.org",
      "host": "framatube.org",
      "id": 2215,
      "is_local": true,
      "name": "joinpeertube",
      "original_url": "https://framatube.org/video-channels/joinpeertube",
      "owner": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "support": null,
      "url": "https://framatube.org/c/joinpeertube"
    }
  ],
  "count": 1,
  "more_available": false,
  "total": 1
}

List an account's playlists

List an account's public playlists, on all of its channels, with how many videos each holds. No account needed.

Inputs

AccountaccounttextRequired
The account: its name (as in the address of its page), its handle name@site for an account from another site, or the address of its page.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

accounttext
The account that was read.
countnumber
How many playlists are returned here.
more_availabletrue/false
True when more playlists match than were returned; raise the limit to read more.
playlistslist
The playlists.
totalnumber
How many playlists match in all.
Example output
{
  "account": "framasoft",
  "count": 1,
  "more_available": false,
  "playlists": [
    {
      "channel": {
        "display_name": "MOOC-CHATONS#1 - Internet, reprendre le contr\u00f4le",
        "handle": "mooc.chatons.1@framatube.org",
        "name": "mooc.chatons.1",
        "url": "https://framatube.org/c/mooc.chatons.1"
      },
      "created_at": "2020-02-24T17:00:37.914Z",
      "description": "Retrouvez ici les vid\u00e9os courtes des interview r\u00e9alis\u00e9es pour le MOOC-CHATONS#1",
      "id": 310,
      "is_local": true,
      "name": "Interviews courtes du MOOC CHATONS",
      "original_url": "https://framatube.org/video-playlists/d8ca79f9-e4c7-4269-8183-d78ed269c909",
      "owner": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "privacy": "Public",
      "short_uuid": "sLFbqXsw7sPR3AfvqQSBZB",
      "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/playlist-d8ca79f9-e4c7-4269-8183-d78ed269c909.jpg",
      "type": "Regular",
      "updated_at": "2020-02-25T09:26:48.531Z",
      "url": "https://framatube.org/w/p/sLFbqXsw7sPR3AfvqQSBZB",
      "uuid": "d8ca79f9-e4c7-4269-8183-d78ed269c909",
      "video_count": 12
    }
  ],
  "total": 1
}

List an account's videos

List the videos an account published, on all of its channels, newest first or by views, likes, comments or length. No account needed.

Inputs

AccountaccounttextRequired
The account: its name (as in the address of its page), its handle name@site for an account from another site, or the address of its page.
Orderordertext
Which videos come first. Newest first by default.One of: newest (Newest first), oldest (Oldest first), most_viewed (Most viewed), most_liked (Most liked), most_commented (Most commented), longest (Longest first). Default: newest.
Sensitive videossensitivetext
What to do with videos marked as sensitive content. They are left out unless you choose otherwise, as the site does for visitors.One of: hide (Leave sensitive videos out), include (Include sensitive videos), only (Only sensitive videos). Default: hide.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

accounttext
The account that was read.
countnumber
How many videos are returned here.
more_availabletrue/false
True when more videos match than were returned; raise the limit to read more.
totalnumber
How many videos match in all.
videoslist
The videos.
Example output
{
  "account": "framasoft",
  "count": 1,
  "more_available": false,
  "total": 1,
  "videos": [
    {
      "account": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "category": "Science & Technology",
      "channel": {
        "display_name": "A propos de PeerTube",
        "handle": "joinpeertube@framatube.org",
        "name": "joinpeertube",
        "url": "https://framatube.org/c/joinpeertube"
      },
      "comments": 13,
      "description_preview": "**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**...",
      "dislikes": 0,
      "duration": "1:53",
      "duration_seconds": 113,
      "embed_url": "https://framatube.org/videos/embed/kkGMgK9ZtnKfYAgnEtQxbv",
      "host": "framatube.org",
      "id": 1717,
      "is_live": false,
      "is_local": true,
      "is_sensitive": false,
      "language": "English",
      "language_code": "en",
      "licence": "Attribution - Share Alike",
      "likes": 35,
      "name": "What is PeerTube?",
      "original_url": "https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "originally_published_at": null,
      "published_at": "2018-10-01T10:52:46.396Z",
      "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
      "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/294e3020-218a-4af6-b1e9-b755102a5c5a.jpg",
      "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv",
      "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "views": 148842
    }
  ]
}

List the site's videos

List the videos on the connected PeerTube site: the newest, what is trending or hot, or the most viewed, liked or commented. Keep to videos uploaded to the site itself, or narrow by category and language. No account needed.

Inputs

Orderordertext
Which videos come first. Newest first by default.One of: newest (Newest first), trending (Trending (most viewed lately)), hot (Hot (recent and much liked or discussed)), most_viewed (Most viewed of all time), most_liked (Most liked), most_commented (Most commented), oldest (Oldest first). Default: newest.
Only videos uploaded herelocal_onlytrue/false
Keep to videos uploaded to the connected site, leaving out those it shows from the sites it follows.Default: false.
Categoriescategorieslist
Only videos in any of these categories. Leave empty for all.
Languageslanguageslist
Only videos spoken in, or captioned in, any of these languages. Leave empty for all.
Sensitive videossensitivetext
What to do with videos marked as sensitive content. They are left out unless you choose otherwise, as the site does for visitors.One of: hide (Leave sensitive videos out), include (Include sensitive videos), only (Only sensitive videos). Default: hide.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

countnumber
How many videos are returned here.
more_availabletrue/false
True when more videos match than were returned; raise the limit to read more.
sitetext
The PeerTube site that was read.
totalnumber
How many videos match in all.
videoslist
The videos.
Example output
{
  "count": 1,
  "more_available": false,
  "site": "https://framatube.org",
  "total": 1,
  "videos": [
    {
      "account": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "category": "Science & Technology",
      "channel": {
        "display_name": "A propos de PeerTube",
        "handle": "joinpeertube@framatube.org",
        "name": "joinpeertube",
        "url": "https://framatube.org/c/joinpeertube"
      },
      "comments": 13,
      "description_preview": "**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**...",
      "dislikes": 0,
      "duration": "1:53",
      "duration_seconds": 113,
      "embed_url": "https://framatube.org/videos/embed/kkGMgK9ZtnKfYAgnEtQxbv",
      "host": "framatube.org",
      "id": 1717,
      "is_live": false,
      "is_local": true,
      "is_sensitive": false,
      "language": "English",
      "language_code": "en",
      "licence": "Attribution - Share Alike",
      "likes": 35,
      "name": "What is PeerTube?",
      "original_url": "https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "originally_published_at": null,
      "published_at": "2018-10-01T10:52:46.396Z",
      "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
      "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/294e3020-218a-4af6-b1e9-b755102a5c5a.jpg",
      "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv",
      "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "views": 148842
    }
  ]
}

Search channels

Search the connected PeerTube site for channels by name or description, its own and those of the sites it follows. Each result comes with its handle, ready for 'List a channel's videos'. No account needed.

Inputs

Search forsearchtextRequired
The words to look for.
Only channels on this sitelocal_onlytrue/false
Keep to channels that belong to the connected site.Default: false.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

channelslist
The channels.
countnumber
How many channels are returned here.
more_availabletrue/false
True when more channels match than were returned; raise the limit to read more.
searchtext
The words searched for.
sitetext
The PeerTube site that was searched.
totalnumber
How many channels match in all.
Example output
{
  "channels": [
    {
      "avatar_url": "https://framatube.org/lazy-static/avatars/0e469ff4-7f66-4049-8d1f-bbba685e687c.png",
      "banner_url": null,
      "created_at": "2021-08-09T14:26:09.514Z",
      "description": "Un logiciel libre pour reprendre le contr\u00f4le de vos vid\u00e9os",
      "display_name": "A propos de PeerTube",
      "followers": 312,
      "handle": "joinpeertube@framatube.org",
      "host": "framatube.org",
      "id": 2215,
      "is_local": true,
      "name": "joinpeertube",
      "original_url": "https://framatube.org/video-channels/joinpeertube",
      "owner": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "support": null,
      "url": "https://framatube.org/c/joinpeertube"
    }
  ],
  "count": 1,
  "more_available": false,
  "search": "peertube",
  "site": "https://framatube.org",
  "total": 1
}

Search playlists

Search the connected PeerTube site for public playlists by title, its own and those of the sites it follows. Each result comes with its short ID and how many videos it holds. No account needed.

Inputs

Search forsearchtextRequired
The words to look for.
Only playlists on this sitelocal_onlytrue/false
Keep to playlists that belong to the connected site.Default: false.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

countnumber
How many playlists are returned here.
more_availabletrue/false
True when more playlists match than were returned; raise the limit to read more.
playlistslist
The playlists.
searchtext
The words searched for.
sitetext
The PeerTube site that was searched.
totalnumber
How many playlists match in all.
Example output
{
  "count": 1,
  "more_available": false,
  "playlists": [
    {
      "channel": {
        "display_name": "MOOC-CHATONS#1 - Internet, reprendre le contr\u00f4le",
        "handle": "mooc.chatons.1@framatube.org",
        "name": "mooc.chatons.1",
        "url": "https://framatube.org/c/mooc.chatons.1"
      },
      "created_at": "2020-02-24T17:00:37.914Z",
      "description": "Retrouvez ici les vid\u00e9os courtes des interview r\u00e9alis\u00e9es pour le MOOC-CHATONS#1",
      "id": 310,
      "is_local": true,
      "name": "Interviews courtes du MOOC CHATONS",
      "original_url": "https://framatube.org/video-playlists/d8ca79f9-e4c7-4269-8183-d78ed269c909",
      "owner": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "privacy": "Public",
      "short_uuid": "sLFbqXsw7sPR3AfvqQSBZB",
      "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/playlist-d8ca79f9-e4c7-4269-8183-d78ed269c909.jpg",
      "type": "Regular",
      "updated_at": "2020-02-25T09:26:48.531Z",
      "url": "https://framatube.org/w/p/sLFbqXsw7sPR3AfvqQSBZB",
      "uuid": "d8ca79f9-e4c7-4269-8183-d78ed269c909",
      "video_count": 12
    }
  ],
  "search": "mooc",
  "site": "https://framatube.org",
  "total": 1
}

Search videos

Search the connected PeerTube site for videos, by words in the title, description or tags, then narrow by length, publication date, category, language and licence, or keep to videos uploaded to the site itself. A site searches its own videos and those of the sites it follows. Each result comes with its short ID, channel and address, ready for the next step. No account needed.

Inputs

Search forsearchtextRequired
The words to look for.
Sort bysorttext
Which results come first. Best match by default.One of: relevance (Best match), newest (Newest first), oldest (Oldest first), most_viewed (Most viewed), most_liked (Most liked), longest (Longest first). Default: relevance.
Lengthdurationtext
Only short, medium or long videos. Leave empty for any length.One of: short (Short (under 4 minutes)), medium (Medium (4 to 10 minutes)), long (Long (over 10 minutes)).
Published on or afterpublished_afterdate
Only videos published on or after this day.
Published on or beforepublished_beforedate
Only videos published on or before this day.
Categoriescategorieslist
Only videos in any of these categories. Leave empty for all.
Languageslanguageslist
Only videos spoken in, or captioned in, any of these languages. Leave empty for all.
Licenceslicenceslist
Only videos under any of these licences, such as the Creative Commons ones that allow reuse. Leave empty for all.
Sensitive videossensitivetext
What to do with videos marked as sensitive content. They are left out unless you choose otherwise, as the site does for visitors.One of: hide (Leave sensitive videos out), include (Include sensitive videos), only (Only sensitive videos). Default: hide.
Only videos uploaded herelocal_onlytrue/false
Keep to videos uploaded to the connected site, leaving out those it shows from the sites it follows.Default: false.
How many to returnlimitnumber
How many to return, from 1 to 500. PeerTube hands back 100 at a time, so more than that takes a few requests.From 1 to 500. Default: 25.

Outputs

countnumber
How many videos are returned here.
more_availabletrue/false
True when more videos match than were returned; raise the limit to read more.
searchtext
The words searched for.
sitetext
The PeerTube site that was searched.
totalnumber
How many videos match in all.
videoslist
The videos.
Example output
{
  "count": 1,
  "more_available": false,
  "search": "peertube",
  "site": "https://framatube.org",
  "total": 1,
  "videos": [
    {
      "account": {
        "display_name": "Framasoft",
        "handle": "framasoft@framatube.org",
        "name": "framasoft",
        "url": "https://framatube.org/a/framasoft"
      },
      "category": "Science & Technology",
      "channel": {
        "display_name": "A propos de PeerTube",
        "handle": "joinpeertube@framatube.org",
        "name": "joinpeertube",
        "url": "https://framatube.org/c/joinpeertube"
      },
      "comments": 13,
      "description_preview": "**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**...",
      "dislikes": 0,
      "duration": "1:53",
      "duration_seconds": 113,
      "embed_url": "https://framatube.org/videos/embed/kkGMgK9ZtnKfYAgnEtQxbv",
      "host": "framatube.org",
      "id": 1717,
      "is_live": false,
      "is_local": true,
      "is_sensitive": false,
      "language": "English",
      "language_code": "en",
      "licence": "Attribution - Share Alike",
      "likes": 35,
      "name": "What is PeerTube?",
      "original_url": "https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "originally_published_at": null,
      "published_at": "2018-10-01T10:52:46.396Z",
      "short_uuid": "kkGMgK9ZtnKfYAgnEtQxbv",
      "thumbnail_url": "https://framatube.org/lazy-static/thumbnails/294e3020-218a-4af6-b1e9-b755102a5c5a.jpg",
      "url": "https://framatube.org/w/kkGMgK9ZtnKfYAgnEtQxbv",
      "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "views": 148842
    }
  ]
}

On this page