Create Auto Edited Clips

This Endpoint processes a long-form video, extracting key moments and converting them into separate viral short clips. Each clip is optimized with the right framing and captions, enhancing its engagement potential on social media platforms.

Pricing: 10 credits per video minute input.

POSThttps://api.spikes.studio/api/v1/api/project

Required Parameters

Name
url
Type
string
Description
The URL of the video for which captions are to be generated.
- Supported Formats: Youtube link, Google Drive share link, download link of video and audio in supported formats (MP4, MOV, AVI, WMV)

Optional Parameters

Name
is_add_captions_mode
Type
boolean
Description
Indicator if the project’s goal is to find the best moments, or to treat the entire input video as one clip and create assets for it. When this parameter is True, the entire video will be treated as one clip. When False or when parameter is not sent, the project’s goal is the former.
- Default: False
- Limitations: up to 5 minutes.
Name
style_properties
Type
json
Description
Users have the option of not passing these parameters and having all fields to be default, If you will pass only some of the fields the rest will be set as default.
Name
alignItems
Type
string
Description
Determines the location of the captions on the screen.
Default: "bottom"
Options: bottom / middle / top
Name
background
Type
string
Description
The color of the stroke around the text.
Default: #000000
Options: any hex color
Name
captions_animation_type
Type
string
Description
Determines if the captions should appear with an animation.
Default: none
Options: wword/karaoke/bounce/blossom/sunshine/emerald/slide-left/none
Name
color
Type
string
Description
The color of the text.
Default: #FFFFFF
Options: any hex color
Name
fontFamily
Type
string
Description
Specifies the style of font for the captions.
Default: Impact
Options: Arial/Georgia/Times New Roman/Roboto/Poppins/Montserrat/Roboto Condensed/Open Sans/Impact/Belanosima/Caprasimo/Red Hat Display/Work Sans/Kanit/Oswald.
Name
fontSize
Type
string
Description
The font size of the text.
Default: big
Options: huge/big/medium/small
Name
fontWeight
Type
string
Description
Determines if the text will be in Bold or not.
Default: normal
Options: normal/bold
Name
textShadow
Type
string
Description
Default: heavy
Options: heavy/medium/light/none
Name
textTransform
Type
string
Description
Determines if the text will be in Uppercase or Lowercase.
Default: uppercase
Options: uppercase/normal
Name
wordLevel
Type
boolean
Description
Determines if the text will be shown one word per level or a group.
Default: true
Name
title
Type
string
Description
Project’s name. Only relevant for projects that are from download URLs. For other platforms the project name will be set automatically.
- Default: "My Project"
Name
upload_media_type
Type
string
Description
Needed if uploading an audio file via a download url.
- Default: video
- Options: video/audio
Name
clip_length_request
Type
string
Description
The system will attempt to make as many clips as possible as close as possible to the length request (seconds). Requests that are not between 5 and 180 seconds will be blocked.
- Default: no clip length request. The system will have no guidelines for clip length. Clips will of course be of reasonable length.
- Options: all integers between 5 and 180

Response

Name
project
Type
string
Description
Unique ID for the project. Will be used to get project assets and metadata using the get project API.

Request

POST

https://api.spikes.studio/api/v1/api/project

  {
      "url" : "https://www.youtube.com/watch?v=S28SAhhA4XU&ab_channel=ABCNews",
      "style_properties": {
          "alignItems": "middle",
          "background": "#000000",
          "captions_animation_type": "none",
          "color": "#FFFFFF",
          "fontFamily": "Impact",
          "fontSize": "big",
          "fontWeight": "normal",
          "textShadow": "heavy",
          "textTransform": "uppercase",
          "wordLevel": true
      },
      "clip_length_request": 34
  }

Response

  {
      "project": "163067f1-cafc-4c24-bca8-bfd77cc7de5b"
  }

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