mirror of
https://gitea.invidious.io/iv-org/documentation.git
synced 2024-08-15 00:53:34 +00:00
add missing endpoints
This commit is contained in:
parent
6bc6c505ca
commit
52bed068d3
2 changed files with 108 additions and 0 deletions
44
docs/api.md
44
docs/api.md
|
@ -517,3 +517,47 @@ page: Int32
|
|||
]
|
||||
}
|
||||
```
|
||||
|
||||
##### GET `/api/v1/hashtag/:tag`
|
||||
> Schema:
|
||||
```javascript
|
||||
{
|
||||
results: VideoObject[],
|
||||
}
|
||||
```
|
||||
Parameters:
|
||||
```
|
||||
page: Int32
|
||||
```
|
||||
|
||||
##### GET `/api/v1/resolve_url`
|
||||
> Schema:
|
||||
```javascript
|
||||
{
|
||||
ucid?: String,
|
||||
videoId?: String,
|
||||
playlistId?: String,
|
||||
startTimeSeconds?: String,
|
||||
params?: String,
|
||||
pageType: string
|
||||
}
|
||||
```
|
||||
Parameters:
|
||||
```
|
||||
url: URL
|
||||
```
|
||||
|
||||
##### GET `/api/v1/clips`
|
||||
> Schema:
|
||||
```javascript
|
||||
{
|
||||
startTime: Float64, // in seconds
|
||||
endTime: Float64, // in seconds
|
||||
clipTitle: String,
|
||||
video: VideoObject
|
||||
}
|
||||
```
|
||||
Parameters:
|
||||
```
|
||||
id: string
|
||||
```
|
|
@ -85,6 +85,39 @@ This is the same as requesting `/api/v1/channels/:id/videos` without URL paramet
|
|||
}
|
||||
```
|
||||
|
||||
##### GET `/api/v1/channels/:id/podcasts`
|
||||
|
||||
> URL parameters:
|
||||
|
||||
* `continuation`: A continuation token to get the next chunk of items. The token is provided each time this API is requested.
|
||||
|
||||
> Response:
|
||||
|
||||
```javascript
|
||||
{
|
||||
"playlists": [
|
||||
// One or more PlaylistOject
|
||||
],
|
||||
"continuation": continuation
|
||||
}
|
||||
```
|
||||
|
||||
##### GET `/api/v1/channels/:id/releases`
|
||||
|
||||
> URL parameters:
|
||||
|
||||
* `continuation`: A continuation token to get the next chunk of items. The token is provided each time this API is requested.
|
||||
|
||||
> Response:
|
||||
|
||||
```javascript
|
||||
{
|
||||
"playlists": [
|
||||
// One or more PlaylistOject
|
||||
],
|
||||
"continuation": continuation
|
||||
}
|
||||
```
|
||||
|
||||
##### GET `/api/v1/channels/:id/shorts`
|
||||
|
||||
|
@ -206,3 +239,34 @@ This usually means that parsing support for the attachment type has not yet been
|
|||
"error": String
|
||||
}
|
||||
```
|
||||
|
||||
##### GET `/api/v1/channels/:ucid/search`
|
||||
|
||||
> Url parameters
|
||||
* `q`: The query to search
|
||||
* `page`: The page number of the search (Int32)
|
||||
|
||||
> Response:
|
||||
```javascript
|
||||
[
|
||||
VideoObject,
|
||||
PlaylistObject
|
||||
];
|
||||
```
|
||||
|
||||
##### GET `/api/v1/post/:id`
|
||||
> Url parameters
|
||||
|
||||
* `ucid`: You can optionally provide the channel's id for fetching the post.
|
||||
|
||||
> Response:
|
||||
Same as [`/api/v1/channels/:id/community`](#get-apiv1channelsidcommunity) but only returns one post in the comments array
|
||||
|
||||
|
||||
|
||||
##### GET `/api/v1/post/:id/comments`
|
||||
|
||||
* `ucid`: You can optionally provide the channel's id for fetching the post.
|
||||
|
||||
> Response:
|
||||
Same as [`/api/v1/channels/:id/comments`](../api.md#get-apiv1commentsid) but has a postId instead of a videoId
|
Loading…
Reference in a new issue