Embed Text into a Video

This endpoint enriches the content of a video by allowing users to add custom text overlays. Users can specify the position, size, and content of the text, enhancing the video's storytelling or providing supplementary information.

GEThttps://api.spikes.studio/add-text

Required Parameters

Name
video_url
Type
string
Description
The URL of the video for which the text will be added.
- Supported Formats: MP4, MOV, AVI, WMV
- Example: "https://example.com/video.mp4"

Optional Parameters

Name
text_position
Type
string
Description
The position on the video frame where the text will be placed.
- Default: "TL" (Top Left)
- Options: "TL" (Top Left), "TM" (Top Middle), "TR" (Top Right), "ML" (Middle Left), "MC" (Middle Center), "MR" (Middle Right), "BL" (Bottom Left), "BM" (Bottom Middle), "BR" (Bottom Right).
Name
text_size
Type
string
Description
The font size of the text overlay.
- Default: "M" (Meduim)
- Options: "S" (Small), "M" (Medium), "L" (Large)
Name
text_color
Type
string
Description
The color of the text overlay.
- Default: "White"
- Options: Any valid color value (e.g., "Red", "#FF0000", "RGB(255, 0, 0)")
Name
stroke_size
Type
string
Description
The size of the stroke around the text.
- Default: "M" (Meduim)
- Options: "S" (Small), "M" (Medium), "L" (Large)
Name
stroke_color
Type
string
Description
The color of the stroke around the text.
- Default: "Black"
- Options: Any valid color value (e.g., "Red", "#FF0000", "RGB(255, 0, 0)")

Response

Name
video_url
Type
string
Description
A URL of the video with the embedded text overlay.
Name
video_information
Type
array
Description
An array of video information:
Name
id
Type
string
Description
The unique identifier of the video.
Name
video_length
Type
number
Description
The length of the video.
Name
date
Type
timestamp
Description
The date the video was created.

Request

GET

https://api.spikes.studio/add-text

https://api.spikes.studio/add-text?video_url=https://example.com/video.mp4&logo=https://example.com/logo.png&position=TR&size=M

Response

  {
    "video_url": "https://example.com/video_with_text.mp4",
    "video_information": [
      {
        "id": "123456",
        "video_length": "00:05:23",
        "date": "2022-04-15"
      }
    ]
  }

Errors

Name
400 Bad Request
Description
The request was malformed or missing required parameters.
Name
401 Unauthorized
Description
The API key provided was invalid or missing.
Name
404 Not Found
Description
The requested resource was not found.
Name
500 Internal Server Error
Description
500 Internal Server Error