PeerTube

Search playlists

Live Test Server (live data - latest nightly version)

https://peertube2.cpy.re/api/v1

GET

/search/video-playlists

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://peertube2.cpy.re/api/v1/search/video-playlists?search='

Response Example

200 - Example 1

{
    "data": [
        {
            "createdAt": "2019-08-24T14:15:22Z",
            "description": "string",
            "displayName": "string",
            "id": 42,
            "isLocal": true,
            "ownerAccount": {
                "avatar": {
                    "createdAt": "2019-08-24T14:15:22Z",
                    "path": "string",
                    "updatedAt": "2019-08-24T14:15:22Z"
                },
                "displayName": "string",
                "host": "example.com",
                "id": 0,
                "name": "string",
                "url": "string"
            },
            "privacy": {
                "id": 1,
                "label": "string"
            },
            "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
            "thumbnailPath": "string",
            "type": {
                "id": 1,
                "label": "string"
            },
            "updatedAt": "2019-08-24T14:15:22Z",
            "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
            "videoChannel": {
                "avatar": {
                    "createdAt": "2019-08-24T14:15:22Z",
                    "path": "string",
                    "updatedAt": "2019-08-24T14:15:22Z"
                },
                "displayName": "string",
                "host": "example.com",
                "id": 42,
                "name": "string",
                "url": "string"
            },
            "videoLength": 0
        }
    ],
    "total": 1
}

Request

Query Params

string

required

String to search. If the user can make a remote URI search, and the string is an URI then the PeerTube instance will fetch the remote object and add it to its database. Then, you can use the REST API to fetch the complete playlist information and interact with it.

start

integer

optional

Offset used to paginate results

count

integer

optional

Number of items to return

searchTarget

string

optional

If the administrator enabled search index support, you can override the default search target.

Warning: If you choose to make an index search, PeerTube will get results from a third party service. It means the instance may not yet know the objects you fetched. If you want to load video/channel information:

If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
After that, you can use the classic REST API endpoints to fetch the complete object or interact with it

If the current user doesn't have the ability to make a remote URI search, then redirect the user on the origin instance or fetch
the data from the origin instance API

sort

string

optional

Sort column

Responses

🟢200successful operation

application/json

Body

data

array[object (VideoPlaylist) {14}]

optional

createdAt

string <date-time>

optional

description

string

optional

>= 3 characters<= 1000 characters

displayName

string

optional

>= 1 characters<= 120 characters

integer

optional

>= 1

Example:

isLocal

boolean

optional

ownerAccount

object (AccountSummary)

optional

privacy

object (VideoPlaylistPrivacyConstant)

optional

shortUUID

string

optional

translation of a uuid v4 with a bigger alphabet to have a shorter uuid

Example:

2y84q2MQUMWPbiEcxNXMgC

thumbnailPath

string

optional

type

object (VideoPlaylistTypeConstant)

optional

updatedAt

string <date-time>

optional

uuid

string <uuid>

optional

>= 36 characters<= 36 characters

Example:

9c9de5e8-0a1e-484a-b099-e80766180a6d

Match pattern:

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

videoChannel

object (VideoChannelSummary)

optional

videoLength

integer

optional

>= 0

total

integer

optional

Example:

🔴500search index unavailable

Modified at 2022-09-10 22:29:49

Search channels

Search videos