APIs.io Engineering Platform Stream Videos API
The Stream Videos API from APIs.io Engineering Platform — 7 operation(s) for stream videos.
This API exposes 10 operations across 7 paths, and defines 64 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
10 operations
7 paths
64 schemas
1 DELETE4 GET5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Stream Videos API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 10
Across 7 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Stream Videos 10
GET
/accounts/{account_id}/stream
APIs.io Engineering Platform List videos
POST
/accounts/{account_id}/stream
APIs.io Engineering Platform Initiate video uploads using TUS
DELETE
/accounts/{account_id}/stream/{identifier}
APIs.io Engineering Platform Delete video
GET
/accounts/{account_id}/stream/{identifier}
APIs.io Engineering Platform Retrieve video details
POST
/accounts/{account_id}/stream/{identifier}
APIs.io Engineering Platform Edit video details
GET
/accounts/{account_id}/stream/{identifier}/embed
APIs.io Engineering Platform Retrieve embed Code HTML
POST
/accounts/{account_id}/stream/{identifier}/token
APIs.io Engineering Platform Create signed URL tokens for videos
POST
/accounts/{account_id}/stream/copy
APIs.io Engineering Platform Upload videos from a URL
POST
/accounts/{account_id}/stream/direct_upload
APIs.io Engineering Platform Upload videos via direct upload URLs
GET
/accounts/{account_id}/stream/storage-usage
APIs.io Engineering Platform Storage use
Schemas 64
The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are stream_videos (23 properties), stream_watermarks (11 properties), stream_direct_upload_request (9 properties), stream_video_copy_request (8 properties). Each schema is shown below with its type and property counts.
stream_asc
boolean
Lists videos in ascending order of creation.
stream_pctComplete
string
Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
stream_watermark_size
number
The size of the image in bytes.
stream_playback
object
2 properties
stream_type
string
Specifies whether the video is vod or live.
stream_errorReasonCode
string
Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.
stream_search
string
Searches over the name key in the meta field. This field can be set with or after the upload request.
stream_api-response-common
object
3 properties
3 required
stream_messages
array
stream_preview
string
The video's preview page URI. This field is omitted until encoding is complete.
stream_allowedOrigins
array
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 vi…
stream_identifier
string
A Cloudflare-generated unique identifier for a media item.
stream_creator
string
A user-defined identifier for the media creator.
stream_tus_resumable
string
Specifies the TUS protocol version. This value must be included in every upload request. Notes: The only supported version of TUS protocol is 1.0.0.
stream_video_copy_request
object
8 properties
1 required
stream_video_response_collection
stream_padding
number
The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video…
stream_scheduledDeletion
string
Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing schedu…
stream_upload_length
integer
Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
stream_errorReasonText
string
Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.
stream_position
string
The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.
stream_readyToStreamAt
string
Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
stream_signed_token_response
stream_width
integer
The width of the image in pixels.
stream_storage_use_response
stream_maxDurationSeconds
integer
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 du…
stream_api-response-single
object
stream_media_metadata
object
A user modifiable key-value store used to reference other systems of record for managing videos.
stream_size
number
The size of the media item in bytes.
stream_accessRules
object
Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user informat…
4 properties
stream_thumbnailTimestampPct
number
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 t…
stream_account_identifier
string
The account identifier tag.
stream_duration
number
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 read…
stream_name
string
A short description of the watermark profile.
stream_watermark_created
string
The date and a time a watermark profile was created.
stream_opacity
number
The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is alre…
stream_modified
string
The date and time the media item was last modified.
stream_api-response-common-failure
object
4 properties
4 required
stream_uploaded
string
The date and time the media item was uploaded.
stream_media_status
object
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, pctCompl…
4 properties
stream_watermarks
object
11 properties
stream_start
string
Lists videos created after the specified date.
stream_signed_token_request
object
6 properties
stream_video_update
object
8 properties
stream_created
string
The date and time the media item was created.
stream_watermark_at_upload
object
1 property
stream_oneTimeUploadExpiry
string
The date and time when the video upload URL is no longer valid for direct user uploads.
stream_downloadedFrom
string
The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
stream_requireSignedURLs
boolean
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.
stream_include_counts
boolean
Includes the total number of videos associated with the submitted query parameters.
stream_readyToStream
boolean
Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
stream_direct_upload_request
object
9 properties
1 required
stream_scale
number
The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no sc…
stream_upload_metadata
string
Comma-separated key-value pairs following the TUS protocol specification. Values are Base-64 encoded. Supported keys: name, requiresignedurls, allowedorigins,…
stream_input
object
2 properties
stream_watermark_identifier
string
The unique identifier for a watermark profile.
stream_media_state
string
Specifies the processing status for all quality levels for a video.
stream_video_response_single
stream_liveInput
string
The live input ID used to upload a video with Stream Live.
stream_end
string
Lists videos created before the specified date.
stream_direct_upload_response
stream_height
integer
The height of the image in pixels.
stream_videos
object
23 properties
stream_thumbnail_url
string
The media item's thumbnail URI. This field is omitted until encoding is complete.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Stream Videos