Skip to main content
GET
/
api
/
video
/
streams
List video streams
curl --request GET \
  --url https://convertly.sh/api/video/streams \
  --header 'Authorization: Bearer <token>'
{
  "streams": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "playbackId": "<string>",
      "profile": "<string>",
      "duration": 123,
      "width": 123,
      "height": 123,
      "manifestUrl": "<string>",
      "posterUrl": "<string>",
      "renditions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "width": 123,
          "height": 123,
          "bitrate": 123,
          "averageBitrate": 123,
          "codec": "h264",
          "audioCodec": "aac",
          "segmentCount": 123
        }
      ],
      "error": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "readyAt": "2023-11-07T05:31:56Z",
      "packageFormats": [],
      "hlsManifestUrl": "<string>",
      "dashManifestUrl": "<string>",
      "tokenTtlSeconds": 123,
      "allowedDomains": [
        "<string>"
      ],
      "captions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "label": "<string>",
          "language": "<string>",
          "url": "<string>"
        }
      ],
      "analytics": {
        "events": 123,
        "plays": 123
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
status
enum<string>
Available options:
pending,
processing,
ready,
failed,
deleted

Response

Video streams

streams
object[]
pagination
object