List videos

GET

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/stream

Last modified:2022-12-16 13:48:35

Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.

Request

Path Params

account_identifier

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200List videos response

application/json

Body

result

required

Any of

allOf {2}

array[object (Cloudflare Client API_videos) {22}]

allOf {2}

One of

array[object (Cloudflare Client API_videos) {22}]

object

allowedOrigins

array[string]

allowedOrigins

optional

Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.

Example:

["example.com"]

created

string <date-time>

schemas-created

read-onlyoptional

The date and time the media item was created.

Example:

2014-01-02T02:20:00Z

creator

string

creator

optional

A user-defined identifier for the media creator.

<= 64 characters

Example:

creator-id_abcde12345

duration

integer

schemas-duration

read-onlyoptional

The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.

input

object

input

read-onlyoptional

liveInput

string

liveInput

read-onlyoptional

The live input ID used to upload a video with Stream Live.

<= 32 characters

Example:

fc0a8dc887b16759bfd9ad922230a014

maxDurationSeconds

integer

Cloudflare Client API_maxDurationSeconds

optional

The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.

meta

object

media_metadata

optional

A user modifiable key-value store used to reference other systems of record for managing videos.

Example:

{}

modified

string <date-time>

schemas-modified

read-onlyoptional

The date and time the media item was last modified.

Example:

2014-01-02T02:20:00Z

nft

object

nft

read-onlyoptional

playback

object

playback

read-onlyoptional

preview

string <uri>

preview

read-onlyoptional

The video's preview page URI. This field is omitted until encoding is complete.

Example:

https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch

readyToStream

boolean

readyToStream

read-onlyoptional

Indicates whether the video is ready for viewing.

Example:

true

requireSignedURLs

boolean

requireSignedURLs

read-onlyoptional

Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.

Default:

false

Example:

true

size

number

size

read-onlyoptional

The size of the media item in bytes.

Example:

4190963

status

object

media_status

read-onlyoptional

Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.

thumbnail

string <uri>

thumbnail_url

read-onlyoptional

The media item's thumbnail URI. This field is omitted until encoding is complete.

Example:

https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg

thumbnailTimestampPct

number

thumbnailTimestampPct

optional

The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.

>= 0<= 1

Default:

Example:

0.529241

uid

string

videos_components-schemas-identifier

read-onlyoptional

A Cloudflare-generated unique identifier for a media item.

<= 32 characters

Example:

ea95132c15732412d22c1476fa83f27a

uploadExpiry

string <date-time>

oneTimeUploadExpiry

optional

The date and time when the video upload URL is no longer valid for direct user uploads.

Example:

2014-01-02T02:20:00Z

uploaded

string <date-time>

uploaded

read-onlyoptional

The date and time the media item was uploaded.

Example:

2014-01-02T02:20:00Z

watermark

object

Cloudflare Client API_watermarks

optional

range

integer

read-onlyoptional

The total number of remaining videos based on cursor position.

Example:

1000

total

integer

read-onlyoptional

The total number of videos that match the provided filters.

Example:

35586

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "allowedOrigins": [
                "example.com"
            ],
            "created": "2014-01-02T02:20:00Z",
            "creator": "creator-id_abcde12345",
            "duration": 0,
            "input": {
                "height": 0,
                "width": 0
            },
            "liveInput": "fc0a8dc887b16759bfd9ad922230a014",
            "maxDurationSeconds": 0,
            "meta": {},
            "modified": "2014-01-02T02:20:00Z",
            "nft": {
                "contract": "0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85",
                "token": 0
            },
            "playback": {
                "dash": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd",
                "hls": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8"
            },
            "preview": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch",
            "readyToStream": true,
            "requireSignedURLs": true,
            "size": 4190963,
            "status": {
                "errorReasonCode": "ERR_NON_VIDEO",
                "errorReasonText": "The file was not recognized as a valid video file.",
                "pctComplete": "string",
                "state": "inprogress"
            },
            "thumbnail": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
            "thumbnailTimestampPct": 0.529241,
            "uid": "ea95132c15732412d22c1476fa83f27a",
            "uploadExpiry": "2014-01-02T02:20:00Z",
            "uploaded": "2014-01-02T02:20:00Z",
            "watermark": {
                "created": "2014-01-02T02:20:00Z",
                "downloadedFrom": "https://company.com/logo.png",
                "height": 0,
                "name": "Marketing Videos",
                "opacity": 0.75,
                "padding": 0.1,
                "position": "center",
                "scale": 0.1,
                "size": 29472,
                "uid": "ea95132c15732412d22c1476fa83f27a",
                "width": 0
            }
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    },
    "range": 1000,
    "total": 35586
}

🟢200List videos response failure

Modified at 2022-12-16 13:48:35

Clip videos given a start and end time

Initiate video uploads using TUS