API Reference

Getting your Videos

List the videos in your catalog

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Video Encoding Status Overview

SafeStream provides 1 of 4 values for the status field on each result. This describes the state of the video:

  • PENDING - Video encoding has not completed. The video cannot be watermarked while in this state.
  • INGESTED - Video encoding has completed without any errors. The video is ready to be watermarked.
  • FAILED_ENCODING - Video has failed encoding and is not usable. The video must be re-uploaded.
  • FAILED_DIGITAL_PROFILING - Video has failed digital profiling and cannot be forensically watermarked. This only applies for forensic enabled videos. The video can still be watermarked visually. Some content is not suitable for forensic watermarking, if it is too small, short, or doesn't contain enough motion. If your video is failing digital profiling and seems like it should be suitable, please try re-uploading your content, or contact support.
Path Params
string
required

The ID of the video to get

Query Params
int32
Defaults to 50

The number of results that will be returned from the total result set

int32
Defaults to 1

The page index to return from the result set

string
Defaults to DESC

Sets the sort order for the query

string
Defaults to key

Sets the field to sort by

string

Get a video by a key

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json