Add A Permanent Watermark
api.video gives you the ability to add permanent watermarks to your videos.
Watermarks provide benefits in various contexts. Watermarks can protect your intellectual property, prevent fraud, and promote branding. Here are some of the key benefits of using watermarks:
- Deter unauthorized use
- Prevent copyright infringement
- Brand promotion
- Establish authenticity
Overall, watermarks can be an effective way to protect intellectual property, establish authenticity, and promote branding, among other benefits.
How watermarks work
Watermarks are uploaded separately from videos. You will need to upload the watermarks you want to utilize beforehand, after the watermark is uploaded it is attached to a video object, and eventually as soon as the video is uploaded to the object, the watermark is embedded in the video
- You can only add watermarks when creating a new video object.
- You cannot delete or edit watermarks after you add them to a video.
Supported Image formats
You can upload watermarks either in jpeg
or png
format, however it is highly recommended to use png
due to the fact that png
supports alpha channel.
Format | Supported |
---|---|
png | Yes (Recommended) |
jpeg | Yes |
Create an account
Before you can start uploading your first video, you need to create an api.video account.
Once you are logged in to the Dashboard, select the environment of your choice (sandbox or production) and copy your API key.
Installation & Usage
The clients offered by api.video include:
To install your selected client, do the following:
go get github.com/apivideo/api.video-go-client
Upload a watermark
First step, would be to upload a watermark. It is recommended to use images that are in jpeg
or png
format. Once the watermark has been uploaded, you can proceed in embedding it in a video.
When the upload is complete, the response from the watermark endpoint will be the watermark id. You can either store it on your end or you can consume it from the list of watermarks.
api.video will only store the watermark id and the time and date it was uploaded. If you would like to reference the watermark to a specific image name, you would have to do that on your end.
More information can be found on the API reference page
curl --request POST \
--url https://ws.api.video/watermarks \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NDI4MDUyNzEuOTEyODMsIm5iZiI6MTY0MjgwNTI3MS45MTI4MywiZXhwIjoxNjQyODA4ODcxLjkxMjgzLCJwcm9qZWN0SWQiOiJwclJ6SUpKQTdCTHNxSGpTNDVLVnBCMSJ9.jTiB29R_sg5dqCDBU8wrnz7GRJsCzfVeLVTX-XSctS024B9OmGsuY139s2ua1HzrT63sqkBB1QshrjZbkDLVxSrs0-gt-FaM2bgvCC0lqK1HzEUL4vN2OqPPuM8R2pruj0UdGVaifGqmyfehKcHxuNr0ijGmGIMwSXkabECbXCxm7LraRCgmlobHepuXcUPeUKzKxN5LwPSO1onD684S0FtUUYbVMq9Ik7V8UznbpOjmFaknIZowKKlCkTmgKcyLSq7IaPJd7UuDJVXJDiC49oImEInrjx1xuFbyoBz_wkZlwcgk9GjksTeSz4xzBLcyzVgCwGP2hs8_BtdslXXOrA' \
--header 'Content-Type: multipart/form-data' \
--form file=@pic.jpg
List all watermarks
You can list all of the watermarks that you have uploaded, while also sorting by date or id.
curl --request GET \
--url https://ws.api.video/watermarks \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NDI4MDk2MzIuNTQ2MDg5LCJuYmYiOjE2NDI4MDk2MzIuNTQ2MDg5LCJleHAiOjE2NDI4MTMyMzIuNTQ2MDg5LCJwcm9qZWN0SWQiOiJwclJ6SUpKQTdCTHNxSGpTNDVLVnBCMSJ9.J0cMjE7DNwTGvu3cprGpg5R5IHVDHip80ruWaCN57e9jDoJ4FK51Zkk2ynxhb1SqvutYi-hpnmOzqbPUFPjspLjTVbn0sUskKvGRst2gO2vNllHtIzNTlKKLMA_Sa_zi7hK5_XfuNod-B0SqeH106oAqe1FWkZjc7PMuqOzKS3dIqih0PczsbBQWWgQ3Fh-LtHxVVmdY_egq9i-t1fD5JCD812CHAK1HsxpAkpcAmpJptomORbq72tmEmgFfFUEJ8lalROM2_7ZDLvCdHxDYpA6_j5Z6k1y6Z_OjOsLg_mmiFymAT-DpUib2oOQyj2efIMo-OvdfNJhQRAcUMAUZyw'
More information about the endpoint can be found here
Add a watermark to a video using a watermark ID
Once the watermark is uploaded, you can use the watermark id in order to attach the watermark to a video object.
The watermark property in the video object creation payload is an object, that contains the following fields:
Field | Type | Description |
---|---|---|
id | string | id of the watermark |
top | string | Distance expressed in px or % between the top-border of the video and the watermark-image. |
left | string | Distance expressed in px or % between the left-border of the video and the watermark-image. |
bottom | string | Distance expressed in px or % between the bottom-border of the video and the watermark-image. |
right | string | Distance expressed in px or % between the right-border of the video and the watermark-image. |
width | string | Width of the watermark-image relative to the video if expressed in %. Otherwise a fixed width. NOTE: To keep the watermark aspect ratio use the initial image width |
height | string | Height of the watermark-image relative to the video if expressed in %. Otherwise a fixed height. NOTE: To keep the watermark aspect ratio use the initial image height |
opacity | string | Opacity expressed in % only to specify the degree of the watermark-image transparency with the video. |
curl --request POST \
--url https://ws.api.video/videos \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NDI4MDk2MzIuNTQ2MDg5LCJuYmYiOjE2NDI4MDk2MzIuNTQ2MDg5LCJleHAiOjE2NDI4MTMyMzIuNTQ2MDg5LCJwcm9qZWN0SWQiOiJwclJ6SUpKQTdCTHNxSGpTNDVLVnBCMSJ9.J0cMjE7DNwTGvu3cprGpg5R5IHVDHip80ruWaCN57e9jDoJ4FK51Zkk2ynxhb1SqvutYi-hpnmOzqbPUFPjspLjTVbn0sUskKvGRst2gO2vNllHtIzNTlKKLMA_Sa_zi7hK5_XfuNod-B0SqeH106oAqe1FWkZjc7PMuqOzKS3dIqih0PczsbBQWWgQ3Fh-LtHxVVmdY_egq9i-t1fD5JCD812CHAK1HsxpAkpcAmpJptomORbq72tmEmgFfFUEJ8lalROM2_7ZDLvCdHxDYpA6_j5Z6k1y6Z_OjOsLg_mmiFymAT-DpUib2oOQyj2efIMo-OvdfNJhQRAcUMAUZyw' \
--header 'Content-Type: application/json' \
--data '
{
"public": true,
"panoramic": false,
"mp4Support": true,
"watermark": {
"id": "watermark_1Bhes1otLhmPPNenUDyvHV",
"opacity": "70%",
"height": "20%",
"right": "15px",
},
"source": "https://cdn.api.video/vod/vi2qyv9Ma7UFyTOexm3JSmD2/mp4/1080/source.mp4",
"title": "Video with a watermark"
}
'
Delete a watermark
To delete a watermark, send the unique watermark ID to the watermarks endpoint. Deletion is permanent, you will not be able to retrieve the watermark after completing this request.
curl --request DELETE \
--url https://ws.api.video/watermarks/watermark_1BhfLVwM8eEdaN9XFSnxCS \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NDI4MDk2MzIuNTQ2MDg5LCJuYmYiOjE2NDI4MDk2MzIuNTQ2MDg5LCJleHAiOjE2NDI4MTMyMzIuNTQ2MDg5LCJwcm9qZWN0SWQiOiJwclJ6SUpKQTdCTHNxSGpTNDVLVnBCMSJ9.J0cMjE7DNwTGvu3cprGpg5R5IHVDHip80ruWaCN57e9jDoJ4FK51Zkk2ynxhb1SqvutYi-hpnmOzqbPUFPjspLjTVbn0sUskKvGRst2gO2vNllHtIzNTlKKLMA_Sa_zi7hK5_XfuNod-B0SqeH106oAqe1FWkZjc7PMuqOzKS3dIqih0PczsbBQWWgQ3Fh-LtHxVVmdY_egq9i-t1fD5JCD812CHAK1HsxpAkpcAmpJptomORbq72tmEmgFfFUEJ8lalROM2_7ZDLvCdHxDYpA6_j5Z6k1y6Z_OjOsLg_mmiFymAT-DpUib2oOQyj2efIMo-OvdfNJhQRAcUMAUZyw'