api.video
  1. Videos
api.video
  • Account
    • Show account
      GET
  • Analytics
    • List live stream player sessions
      GET
    • List player session events
      GET
    • List video player sessions
      GET
  • Authentication
    • Authenticate
      POST
    • Refresh token
      POST
  • Live
    • List all live streams
      GET
    • Create live stream
      POST
    • Delete a live stream
      DELETE
    • Show live stream
      GET
    • Update a live stream
      PATCH
    • Delete a thumbnail
      DELETE
    • Upload a thumbnail
      POST
  • Players
    • List all players
      GET
    • Create a player
      POST
    • Delete a player
      DELETE
    • Show a player
      GET
    • Update a player
      PATCH
    • Delete logo
      DELETE
    • Upload a logo
      POST
  • Videos - Delegated upload
    • Upload with an upload token
    • List all active upload tokens.
    • Generate an upload token
    • Delete an upload token
    • Show upload token
  • Videos
    • List all videos
      GET
    • Create a video
      POST
    • Delete a video
      DELETE
    • Show a video
      GET
    • Update a video
      PATCH
    • Upload a video
      POST
    • Show video status
      GET
    • Pick a thumbnail
      PATCH
    • Upload a thumbnail
      POST
  • Captions
    • List video captions
    • Delete a caption
    • Show a caption
    • Update caption
    • Upload a caption
  • Chapters
    • List video chapters
    • Delete a chapter
    • Show a chapter
    • Upload a chapter
  • Webhooks
    • List all webhooks
    • Create Webhook
    • Delete a Webhook
    • Show Webhook details
  1. Videos

List all videos

GET
/videos
Requests to this endpoint return a list of your videos (with all their details). With no parameters added to this query, the API returns all videos. You can filter what videos the API returns using the parameters described below. We have several tutorials that demonstrate this endpoint.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ws.api.video/videos'
Response Response Example
200 - response
{
    "data": [
        {
            "assets": {
                "hls": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/hls/manifest.m3u8",
                "iframe": "<iframe src=\"//embed.api.video/c188ed58-3403-46a2-b91b-44603d10b2c9?token=831a9bd9-9f50-464c-a369-8e9d914371ae\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"\"></iframe>",
                "mp4": "https://cdn.api.video/vod/vi4k0jvEUuaTdRAEjQ4Jfrgz/token/8fd70443-d9f0-45d2-b01c-12c8cfc707c9/mp4/720/source.mp4",
                "player": "https://embed.api.video/c188ed58-3403-46a2-b91b-44603d10b2c9?token=831a9bd9-9f50-464c-a369-8e9d914371ae",
                "thumbnail": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/thumbnail.jpg"
            },
            "description": "An amazing video explaining the string theory",
            "metadata": [
                {
                    "key": "Author",
                    "value": "John Doe"
                },
                {
                    "key": "Format",
                    "value": "Tutorial"
                }
            ],
            "mp4Support": true,
            "panoramic": false,
            "playerId": "pl45KFKdlddgk654dspkze",
            "public": false,
            "publishedAt": "2019-12-16T08:25:51.000Z",
            "source": {
                "uri": "/videos/c188ed58-3403-46a2-b91b-44603d10b2c9/source"
            },
            "tags": [
                "maths",
                "string theory",
                "video"
            ],
            "title": "Maths video",
            "updateddAt": "2019-12-16T08:48:49.000Z",
            "videoId": "vi4k0jvEUuaTdRAEjQ4Prklg"
        },
        {
            "assets": {
                "hls": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/hls/manifest.m3u8",
                "iframe": "<iframe src=\"//embed.api.video/1b9d6ae8-8f57-4b6d-8552-d636926b4f5f?token=831a9bd9-9f50-464c-a369-8e9d914371ae\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"\"></iframe>",
                "player": "https://embed.api.video/1b9d6ae8-8f57-4b6d-8552-d636926b4f5f?token=831a9bd9-9f50-464c-a369-8e9d914371ae",
                "thumbnail": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/thumbnail.jpg"
            },
            "description": "A description for your video.",
            "metadata": [
                {
                    "key": "Author",
                    "value": "John Doe"
                },
                {
                    "key": "Science Fiction",
                    "value": "Cyberpunk"
                },
                {
                    "key": "Technology",
                    "value": "Computers"
                }
            ],
            "mp4Support": true,
            "panoramic": false,
            "public": false,
            "publishedAt": "2019-12-16T08:25:51.000Z",
            "source": {
                "uri": "/videos/1b9d6ae8-8f57-4b6d-8552-d636926b4f5f/source"
            },
            "tags": [
                "books",
                "short stories"
            ],
            "title": "Video Title",
            "updateddAt": "2019-12-16T08:48:49.000Z",
            "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz"
        },
        {
            "assets": {
                "hls": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/hls/manifest.m3u8",
                "iframe": "<iframe src=\"//embed.api.video/73129412-e320-4b93-99f6-59a85e3cedcd?token=831a9bd9-9f50-464c-a369-8e9d914371ae\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"\"></iframe>",
                "player": "https://embed.api.video/73129412-e320-4b93-99f6-59a85e3cedcd?token=831a9bd9-9f50-464c-a369-8e9d914371ae",
                "thumbnail": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/thumbnail.jpg"
            },
            "description": "A brief description of the video.",
            "metadata": [
                {
                    "key": "Length",
                    "value": "Short"
                }
            ],
            "mp4Support": true,
            "panoramic": false,
            "playerId": "pl45KFKdlddgk654dspkze",
            "public": false,
            "publishedAt": "2019-12-16T08:25:51.000Z",
            "source": {
                "uri": "/videos/73129412-e320-4b93-99f6-59a85e3cedcd/source"
            },
            "tags": [
                "General",
                "Videos"
            ],
            "title": "My Video Title",
            "updateddAt": "2019-12-16T08:48:49.000Z",
            "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz"
        }
    ],
    "pagination": {
        "currentPage": 1,
        "currentPageItems": 11,
        "itemsTotal": 11,
        "links": [
            {
                "rel": "self",
                "uri": "https://ws.api.video/videos?currentPage=1"
            },
            {
                "rel": "first",
                "uri": "https://ws.api.video/videos?currentPage=1"
            },
            {
                "rel": "last",
                "uri": "https://ws.api.video/videos?currentPage=1"
            }
        ],
        "pageSize": 25,
        "pagesTotal": 1
    }
}

Request

Query Params

Responses

🟢200Success
application/json
Body

🟠400Bad Request
Modified at 2023-08-15 05:52:15
Previous
Show upload token
Next
Create a video
Built with