GET Video Assets by VideoId

Overview

---

The following table contains information about the GET method in regards to receiving the assets of a video.

GET Video Assets
Method	GET
URL or Endpoint	/api/projects/projectId/videos/assets/videoId
Headers	Authorization
Parameters	videoId, projectId
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project
videoId	Yes	string	Unique id of the video

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "filmStrip": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxhxq/thumbnails/filmstrip0.jpg",
    "thumbnail": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxhxq/thumbnails/retina.jpg",
    "streamResponse": {
      "streams": [
        {
          "streamType": "hls",
          "root": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxhxq/hls/master_file.m3u8",
          "qualityTypes": [
            {
              "qualityType": "270p",
              "streamUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxhxq/hls/270p/index.m3u8",
              "statusDescription": "Complete"
            }
          ]
        },
        {
          "streamType": "mp4",
          "root": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxhxq/mp4/master_file.gjp4",
          "qualityTypes": [
            {
              "qualityType": "270p",
              "streamUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxhxq/mp4/270p.mp4",
              "statusDescription": "Complete"
            }
          ]
        }
      ]
    }
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	array[Object]	Returns the response object
filmstrip	string	URL of the filmstrip.
thumbnail	string	URL of the thumbnail.
streamResponse	array[Object]	Returns the stream response as an array of objects.
streams	array[Object]	Returns the streams as an array of objects.
streamType	string	Indicates the file type of the video.
root	string	The URL of the root.
qualityTypes	array[string]	Returns the quality types as an array of strings.
qualityType	string	The quality of the video.
streamUrl	string	The URL of the stream.
statusDescription	string	Status description of the stream.
resultInfo	string	Returns extra information about the result
statusCode	integer($int32)	Returns the HTTP Status Code

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed