mirrors/cobalt
1
0
Fork 0
mirror of https://github.com/imputnet/cobalt.git synced 2025-07-18 11:18:28 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs/api: Add /api/best_audio route information

Browse Source
This commit is contained in:
SmilerRyan 2024-09-02 05:06:16 +01:00 committed by GitHub
parent 57c628378d
commit c98b0eb120
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api.md
View File

@ -53,6 +53,13 @@ item type: `object`
| `url` | `string` | direct link to a file or a link to cobalt's live render | | | `url` | `string` | direct link to a file or a link to cobalt's live render | |
| `thumb` | `string` | item thumbnail that's displayed in the picker | used for `video` and `gif` types | | `thumb` | `string` | item thumbnail that's displayed in the picker | used for `video` and `gif` types |
## GET: `/api/best_audio`
cobalt's best audio endpoint. this endpoint purely fetches the best audio available in any format without re-encoding, and redirects you to the download URL for the audio file. The query paramater `url` is required.
```
⚠️ Ensure that the `url` parameter is properly encoded before making the request.
```
## GET: `/api/stream` ## GET: `/api/stream`
cobalt's live render (or stream) endpoint. usually, you will receive a url to this endpoint cobalt's live render (or stream) endpoint. usually, you will receive a url to this endpoint
from a successful call to `/api/json`. however, the parameters passed to it are **opaque** from a successful call to `/api/json`. however, the parameters passed to it are **opaque**