{ "opencollection": "1.0.0", "info": { "name": "PeerTube Abuses Search API", "version": "8.1.0" }, "items": [ { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Search videos", "type": "http" }, "http": { "method": "GET", "url": "https://peertube2.cpy.re/api/v1/search/videos", "params": [ { "name": "search", "value": "", "type": "query", "description": "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 video information and interact with it.\n" }, { "name": "uuids", "value": "", "type": "query", "description": "Find elements with specific UUIDs" }, { "name": "searchTarget", "value": "", "type": "query", "description": "If the administrator enabled search index support, you can override the default search target.\n\n**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:\n * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),\n then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.\n After that, you can use the classic REST API endpoints to fetch the complete object or interact with it\n * 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\n the data from the origin instance API\n" }, { "name": "start", "value": "", "type": "query", "description": "Offset used to paginate results" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to return" }, { "name": "skipCount", "value": "", "type": "query", "description": "if you don't need the `total` in the response" }, { "name": "sort", "value": "", "type": "query" }, { "name": "nsfw", "value": "", "type": "query", "description": "whether to include nsfw videos, if any" }, { "name": "nsfwFlagsIncluded", "value": "", "type": "query" }, { "name": "nsfwFlagsExcluded", "value": "", "type": "query" }, { "name": "isLive", "value": "", "type": "query", "description": "whether or not the video is a live" }, { "name": "includeScheduledLive", "value": "", "type": "query", "description": "whether or not include live that are scheduled for later" }, { "name": "categoryOneOf", "value": "", "type": "query", "description": "category id of the video (see [/videos/categories](#operation/getCategories))" }, { "name": "licenceOneOf", "value": "", "type": "query", "description": "licence id of the video (see [/videos/licences](#operation/getLicences))" }, { "name": "languageOneOf", "value": "", "type": "query", "description": "language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language" }, { "name": "tagsOneOf", "value": "", "type": "query", "description": "tag(s) of the video" }, { "name": "tagsAllOf", "value": "", "type": "query", "description": "tag(s) of the video, where all should be present in the video" }, { "name": "isLocal", "value": "", "type": "query", "description": "**PeerTube >= 4.0** Display only local or remote objects" }, { "name": "include", "value": "", "type": "query", "description": "**Only administrators and moderators can use this parameter**\n\nInclude additional videos in results (can be combined using bitwise or operator)\n- `0` NONE\n- `1` NOT_PUBLISHED_STATE\n- `2` BLACKLISTED\n- `4` BLOCKED_OWNER\n- `8` FILES\n- `16` CAPTIONS\n- `32` VIDEO SOURCE\n" }, { "name": "hasHLSFiles", "value": "", "type": "query", "description": "**PeerTube >= 4.0** Display only videos that have HLS files" }, { "name": "hasWebVideoFiles", "value": "", "type": "query", "description": "**PeerTube >= 6.0** Display only videos that have Web Video files" }, { "name": "host", "value": "", "type": "query", "description": "Find elements owned by this host" }, { "name": "autoTagOneOf", "value": "", "type": "query", "description": "**PeerTube >= 6.2** **Admins and moderators only** filter on videos that contain one of these automatic tags" }, { "name": "stateOneOf", "value": "", "type": "query", "description": "**PeerTube >= 8.2** **Admins and moderators only** filter on videos that have one of these states" }, { "name": "privacyOneOf", "value": "", "type": "query", "description": "**PeerTube >= 4.0** Display only videos in this specific privacy/privacies" }, { "name": "excludeAlreadyWatched", "value": "", "type": "query", "description": "Whether or not to exclude videos that are in the user's video history" }, { "name": "startDate", "value": "", "type": "query", "description": "Get videos that are published after this date" }, { "name": "endDate", "value": "", "type": "query", "description": "Get videos that are published before this date" }, { "name": "originallyPublishedStartDate", "value": "", "type": "query", "description": "Get videos that are originally published after this date" }, { "name": "originallyPublishedEndDate", "value": "", "type": "query", "description": "Get videos that are originally published before this date" }, { "name": "durationMin", "value": "", "type": "query", "description": "Get videos that have this minimum duration" }, { "name": "durationMax", "value": "", "type": "query", "description": "Get videos that have this maximum duration" } ] }, "docs": "Search videos" }, { "info": { "name": "Search channels", "type": "http" }, "http": { "method": "GET", "url": "https://peertube2.cpy.re/api/v1/search/video-channels", "params": [ { "name": "search", "value": "", "type": "query", "description": "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 channel information and interact with it.\n" }, { "name": "start", "value": "", "type": "query", "description": "Offset used to paginate results" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to return" }, { "name": "searchTarget", "value": "", "type": "query", "description": "If the administrator enabled search index support, you can override the default search target.\n\n**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:\n * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),\n then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.\n After that, you can use the classic REST API endpoints to fetch the complete object or interact with it\n * 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\n the data from the origin instance API\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort column" }, { "name": "host", "value": "", "type": "query", "description": "Find elements owned by this host" }, { "name": "handles", "value": "", "type": "query", "description": "Find elements with these handles" } ] }, "docs": "Search channels" }, { "info": { "name": "Search playlists", "type": "http" }, "http": { "method": "GET", "url": "https://peertube2.cpy.re/api/v1/search/video-playlists", "params": [ { "name": "search", "value": "", "type": "query", "description": "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.\n" }, { "name": "start", "value": "", "type": "query", "description": "Offset used to paginate results" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to return" }, { "name": "searchTarget", "value": "", "type": "query", "description": "If the administrator enabled search index support, you can override the default search target.\n\n**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:\n * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),\n then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.\n After that, you can use the classic REST API endpoints to fetch the complete object or interact with it\n * 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\n the data from the origin instance API\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort column" }, { "name": "host", "value": "", "type": "query", "description": "Find elements owned by this host" }, { "name": "uuids", "value": "", "type": "query", "description": "Find elements with specific UUIDs" } ] }, "docs": "Search playlists" } ] } ], "bundled": true }