Get the VOD stream of a video feed

GET/projects/{projectId}/entities/{entityId}/videoFeeds/{videoFeedId}/vod

Base URL: https://api.tinkermode.com

Return the VOD stream data of video feed with the specified ID. In error cases, the response describes details of the error by the status code and the reason value of its body.

404 VOD_DATA_UNAVAILABLE
- The stream source related to the video feed has no VOD data including the specified time.
404 STREAM_SOURCE_NOT_FOUND
- The stream source related to the video feed is not found for some reason, such as the intmod config not being set up correctly.
404 DATA_ROUTE_NOT_FOUND
- The data route related to the video feed is not found for some reason, such as the data route not being set up correctly.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain the key of a user or service account with permissions to read video feeds of the entity or a project API key.

Path parameters

Name	Type	Required	Constraints	Description
`projectId`	integer	Yes		The unique ID for a specified project.
`entityId`	string	Yes		Entity ID (unique within project)
`videoFeedId`	string	Yes		The unique ID for a specified video feed.

Query parameters

Name	Type	Required	Constraints	Description
`begin`	string	Yes		Return entries bound by this timestamp. Format must conform to RFC3339.

Responses

`200` Successfully retrieved the video feed with specified ID.

Content type: application/json

Property	Type	Required	Constraints	Description
`url`	string	Yes	read-only (server-generated)	Returns a stream URL compatible with the HLS protocol. This URL can be used to play the VOD stream in a HLS video player.

Response example

{
  "thumbnailUrl": "https://download.tinkermode.com/download/v1.eyJzIjoic29mdFeFcmUiLCJrIjoiMTI2MC81ZTBlNDljNWZmMWJjMDY0NjE0MWQyMWYvMSIsImYiOiJSRUFETUUubWQifQ==.1577994891.ca8fb42459cdf9df17b0780ad60c7ddfe917b745399c430d3ae7f30a",
  "url": "https://videostream.tinkermode.com/stream/v1.eyJzIjoiZW50aXR5ZmlsZXMiLCJrIjoiQS9lbnRpdGllcy91YXJlaG91c2VfZnJlZXplcl8wMDEvZmlsZXMvM2EwYjFiMmM1ZDRlNWY2YTBhMWIyYzNhIiwiZiI6ImluY2lkZW50Lm1wNCJ9.1702687298.91445ff477f6ca1568569bce48b077febaf78d1a5f584dfdaa894013"
}

`401` Authorization is required to access this resource.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`404` The requested vod does not exist or is not accessible.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.