The video object
The Video object is the core concept of the SYNQ API, everything revolves around this JSON representation of a video on our system.
An empty container
The video object is a JSON object that when first created looks like this:
A video object at this point in the lifecycle can be considered an empty container waiting for you to upload a video into it.
Filling the container
After using either of the methods above to upload a video, the video object will evolve into something similar to this:
Note that the “outputs” fields are populated when that output is done transcoding.
Top-level field reference:
- created_at – ISO 8601 timestamp of when the video object was created (this value never changes).
- input – contains metadata about the uploaded file as well as a link to the original file itself.
- outputs – URLs of the transcoded versions of the video file are available here when they are done transcoding.
- player – URLs of the embeddable video player and the automatically generated thumbnail.
- state – the state of the video object (created, uploading, uploaded).
- updated_at – ISO 8601 timestamp of when the video object was last updated (any change that you can see in the JSON object will also be reflected by this field).
- userdata – you can add arbitrary JSON data to this field with /v1/video/update/ or when creating a video object.
- video_id – unique identifier of the video object.