Open navigation

Video library API

This API allows your users to access their recorded videos available in their Hippo Video library right from your app. Now, to run the video library API, you need to have API Key.

Note: For each request, 20 videos will be listed to your users.

URL

GET -> api/v1/me/videos/list

Params

email - email of the user

authentication_token - Auth_token of the user (If you don't have one, click here on how to get one)

page - page no of the list (each page contains 20 videos)

category_id - id of the category/folder (optional)

video_type -  type of video - e.g. ‘library’(default) or ‘testimonial’   


Response

{

    "code": 200,

    "videos": [

        {

            "id": 998,

            "title": "Bumblebee",

            "created_at": "07 Jan 2019 - 12:57PM",

            "thumbnail": "https://hippolms-dev-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/2gy_hbSMC6fVXS-phrbl_Q.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJEGJ4ELDMREUIE3A%2F20190110%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190110T021736Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=06cd71cd9b210503501f70176e281f1532c092a19bc03f2254c021bbd2a6230a",

            "share_thumbnail": "https://hippolms-dev-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/2gy_hbSMC6fVXS-phrbl_Q_play.jpg",

            "share_url": "https://www.hippovideo.io/video/play/ImPT2ob1FTUY0gqbwEHE8g",

            "token": "ImPT2ob1FTUY0gqbwEHE8g",

            "embed_url": "https://www.hippovideo.io/video/embed/ImPT2ob1FTUY0gqbwEHE8g",

            "duration": "00m:00s",

            "category_id": 109,

            "form_values": {

                "name": "Bumblebee"

            },

            "category_name": "First Testimonial Campaign",

            "category_link": "https://www.hippovideo.io/video/testimonial/record/EuAjAo5HH3EgDCHgB_MEHrNo3xnqKNvDrsfKsCZIYJA"

        },

        {

            "id": 995,

            "title": "Harry",

            "created_at": "07 Jan 2019 - 12:54PM",

            "thumbnail": "https://hippolms-dev-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/VNBa-5vp8ubGK_SpwPctwQ.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJEGJ4ELDMREUIE3A%2F20190110%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190110T021736Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=12a6c0062c216e07ac33b7b22be7963848b0d9abe94beb93e22b532bacf1364c",

            "share_thumbnail": "https://hippolms-dev-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/VNBa-5vp8ubGK_SpwPctwQ_play.jpg",

            "share_url": "https://www.hippovideo.io/video/play/i33-Y1cEtJVWRXnjlMH0-g",

            "token": "i33-Y1cEtJVWRXnjlMH0-g",

            "embed_url": "https://www.hippovideo.io/video/embed/i33-Y1cEtJVWRXnjlMH0-g",

            "duration": "00m:00s",

            "category_id": 109,

            "form_values": {

                "name": "Harry"

            },

            "category_name": "First Testimonial Campaign",

            "category_link": "https://www.hippovideo.io/video/testimonial/record/EuAjAo5HH3EgDCHgB_MEHrNo3xnqKNvDrsfKsCZIYJA"

        }

    ],

    "has_next_page": false,

    "page": 1

}

 

id - Video ID

title - Video title

created_at - Video create date

thumbnail - Thumbnail of the video

share_thumbnail - Thumbnail of the video with a play icon (you can share the thumbnail linking it to your video).

share_url - Shareable video link.

embed_url - Link to embed the video.

category_name - Title of the category/folder.

category_link - Link to the category/folder where the recorded videos have to be stored.


The above responses are success cases. In case, any errors occur you’ll see an error response.


To check out other articles related to this topic.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.