Embed an Image in 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.

GIFGIF
GEThttps://api.spikes.studio/add-image

Required Parameters

Optional Parameters

  • Name
    image_position
    Type
    string
    Description
    The position on the video frame where the image 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
    image_size
    Type
    string
    Description
    The size category for the image to be displayed in the video.
    • Default: "M" (Meduim)
    • Options: "S" (Small), "M" (Medium), "L" (Large)

Response

  • Name
    video_url
    Type
    string
    Description

    A URL of the video with the embedded image.

  • 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-image
  https://api.spikes.studio/add-image?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_image.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

Was this page helpful?