Contents x
    Create a video
      • Print
      Contents

      Create a video

        • Print
        Article summary

        Post
        /v2/{accessKey}/video


        This API is to upload the video file in the Shoplive media storage and create video resource through the API call.

        When the API call is received by the Shoplive server, a response is returned to the requester after the video file upload is completed. (excluding thumbnail image URL and live/replay URLs)
        When the video upload is complete, ShopLive server proceeds with transcoding for the uploaded video, and you can check the progress through the uploadProgress of the video retrieve/search API response.
        You may also configure the Webhook URL to receive notifications once transcoding finishes. (Please contact the Shoplive account representative to setup Webhook)

        Header parameters
        Authorization
        stringRequired

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        Body parameters
        object
        customerVideoId
        string

        Customer's video ID and must be unique(defined by the customer).

        title
        string

        Title of the video. max. 255 characters. If not specified, default value is original filename.

        description
        string

        Description of the video. max. 65535 characters.

        video
        string (binary) Required

        Video file(mp4,mov) of multipart/form-data type

        image
        string (binary)

        Thumbnail image(screenshot) file of multipart/form-data type. If not specified, Shoplive automatically generates a thumbnail image URL when creating a video.

        tags
        string

        Comma separated tags

        Responses
        200

        200

        Result
        "{\n    \"videoId\": \"100\",\n    \"customerVideoId\": \"SHOPLIVE_VIDEO_1\",\n    \"title\": \"Updated Shoplive Introduction Video\",\n    \"description\": \"Description is updated\",\n    \"tags\" : [\"video1\",\"test\"],\n    \"filename\": \"shoplive_introduction_video.mp4\",\n    \"width\": 1080,\n    \"height\": 1920,\n    \"filesize\": \"38128539\",\n    \"videoSourceUrl\": \"https://resource.shoplive.cloud/videos/vod/archive/{accessKey}/{streamKey}.mp4\",\n    \"thumbnailImageUrl\": \"https://image.shoplive.cloud/{streamKey}.jpg\",\n    \"vodStreamUrl\": null,\n    \"vodStreamUrls\": null,\n    \"duration\": 0,\n    \"uploadProgress\": 0,\n    \"createdAt\": \"2022-12-09T09:17:04Z\",\n    \"updatedAt\": \"2022-12-10T10:11:01z\"  \n}"
        object
        videoId
        string
        Example100
        customerVideoId
        string
        ExampleSHOPLIVE_VIDEO_1
        title
        string
        ExampleUpdated Shoplive Introduction Video
        description
        string
        ExampleDescription is updated
        tags
        Array of string
        string
        Example[ "tag1", "tag2" ]
        filename
        string
        Exampleshoplive_introduction_video.mp4
        width
        integer
        Default0
        Example1080
        height
        integer
        Default0
        Example1920
        filesize
        string
        Example38128539
        videoSourceUrl
        string
        Examplehttps://resource.shoplive.cloud/videos/vod/archive/{accessKey}/{streamKey}.mp4
        thumbnailImageUrl
        string
        Examplehttps://image.shoplive.cloud/{streamKey}.jpg
        vodStreamUrl
        vodStreamUrls
        duration
        integer
        Default0
        Example0
        uploadProgress
        integer
        Default0
        Example0
        createdAt
        string
        Example2022-12-09T09:17:04Z
        updatedAt
        string
        Example2022-12-10T10:11:01z
        4XX

        4XX

        Result
        "{\n    \"_s\": -000,\n    \"_e\": \"Error message\"\n}"
        What's Next