Create Clip

curl --request POST \
  --url https://api.cuttr.com/api/platform/v1/clip \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "video_url": "<string>",
  "num_clips": "<string>",
  "style": "<string>",
  "length": "<string>",
  "prompt": "<string>",
  "camera_mode": "<string>",
  "hook_length": "<string>",
  "auto_heading": "<string>",
  "heading": {
    "heading.text": "<string>",
    "heading.style": "<string>",
    "heading.color": "<string>",
    "heading.font": "<string>",
    "heading.position": "<string>",
    "heading.bg_color": "<string>",
    "heading.instructions": "<string>"
  },
  "captions": {
    "captions.enabled": true,
    "captions.color": "<string>",
    "captions.font": "<string>"
  },
  "music_url": "<string>",
  "heading_text": "<string>",
  "heading_style": "<string>",
  "heading_color": "<string>",
  "heading_font": "<string>",
  "heading_position": "<string>",
  "heading_bg_color": "<string>",
  "heading_instructions": "<string>",
  "captions_enabled": "<string>",
  "captions_color": "<string>",
  "captions_font": "<string>"
}
'

import requests

url = "https://api.cuttr.com/api/platform/v1/clip"

payload = {
    "video_url": "<string>",
    "num_clips": "<string>",
    "style": "<string>",
    "length": "<string>",
    "prompt": "<string>",
    "camera_mode": "<string>",
    "hook_length": "<string>",
    "auto_heading": "<string>",
    "heading": {
        "heading.text": "<string>",
        "heading.style": "<string>",
        "heading.color": "<string>",
        "heading.font": "<string>",
        "heading.position": "<string>",
        "heading.bg_color": "<string>",
        "heading.instructions": "<string>"
    },
    "captions": {
        "captions.enabled": True,
        "captions.color": "<string>",
        "captions.font": "<string>"
    },
    "music_url": "<string>",
    "heading_text": "<string>",
    "heading_style": "<string>",
    "heading_color": "<string>",
    "heading_font": "<string>",
    "heading_position": "<string>",
    "heading_bg_color": "<string>",
    "heading_instructions": "<string>",
    "captions_enabled": "<string>",
    "captions_color": "<string>",
    "captions_font": "<string>"
}
headers = {
    "X-API-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    video_url: '<string>',
    num_clips: '<string>',
    style: '<string>',
    length: '<string>',
    prompt: '<string>',
    camera_mode: '<string>',
    hook_length: '<string>',
    auto_heading: '<string>',
    heading: {
      'heading.text': '<string>',
      'heading.style': '<string>',
      'heading.color': '<string>',
      'heading.font': '<string>',
      'heading.position': '<string>',
      'heading.bg_color': '<string>',
      'heading.instructions': '<string>'
    },
    captions: {
      'captions.enabled': true,
      'captions.color': '<string>',
      'captions.font': '<string>'
    },
    music_url: '<string>',
    heading_text: '<string>',
    heading_style: '<string>',
    heading_color: '<string>',
    heading_font: '<string>',
    heading_position: '<string>',
    heading_bg_color: '<string>',
    heading_instructions: '<string>',
    captions_enabled: '<string>',
    captions_color: '<string>',
    captions_font: '<string>'
  })
};

fetch('https://api.cuttr.com/api/platform/v1/clip', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cuttr.com/api/platform/v1/clip",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'video_url' => '<string>',
    'num_clips' => '<string>',
    'style' => '<string>',
    'length' => '<string>',
    'prompt' => '<string>',
    'camera_mode' => '<string>',
    'hook_length' => '<string>',
    'auto_heading' => '<string>',
    'heading' => [
        'heading.text' => '<string>',
        'heading.style' => '<string>',
        'heading.color' => '<string>',
        'heading.font' => '<string>',
        'heading.position' => '<string>',
        'heading.bg_color' => '<string>',
        'heading.instructions' => '<string>'
    ],
    'captions' => [
        'captions.enabled' => true,
        'captions.color' => '<string>',
        'captions.font' => '<string>'
    ],
    'music_url' => '<string>',
    'heading_text' => '<string>',
    'heading_style' => '<string>',
    'heading_color' => '<string>',
    'heading_font' => '<string>',
    'heading_position' => '<string>',
    'heading_bg_color' => '<string>',
    'heading_instructions' => '<string>',
    'captions_enabled' => '<string>',
    'captions_color' => '<string>',
    'captions_font' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cuttr.com/api/platform/v1/clip"

	payload := strings.NewReader("{\n  \"video_url\": \"<string>\",\n  \"num_clips\": \"<string>\",\n  \"style\": \"<string>\",\n  \"length\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"camera_mode\": \"<string>\",\n  \"hook_length\": \"<string>\",\n  \"auto_heading\": \"<string>\",\n  \"heading\": {\n    \"heading.text\": \"<string>\",\n    \"heading.style\": \"<string>\",\n    \"heading.color\": \"<string>\",\n    \"heading.font\": \"<string>\",\n    \"heading.position\": \"<string>\",\n    \"heading.bg_color\": \"<string>\",\n    \"heading.instructions\": \"<string>\"\n  },\n  \"captions\": {\n    \"captions.enabled\": true,\n    \"captions.color\": \"<string>\",\n    \"captions.font\": \"<string>\"\n  },\n  \"music_url\": \"<string>\",\n  \"heading_text\": \"<string>\",\n  \"heading_style\": \"<string>\",\n  \"heading_color\": \"<string>\",\n  \"heading_font\": \"<string>\",\n  \"heading_position\": \"<string>\",\n  \"heading_bg_color\": \"<string>\",\n  \"heading_instructions\": \"<string>\",\n  \"captions_enabled\": \"<string>\",\n  \"captions_color\": \"<string>\",\n  \"captions_font\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cuttr.com/api/platform/v1/clip")
  .header("X-API-Key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video_url\": \"<string>\",\n  \"num_clips\": \"<string>\",\n  \"style\": \"<string>\",\n  \"length\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"camera_mode\": \"<string>\",\n  \"hook_length\": \"<string>\",\n  \"auto_heading\": \"<string>\",\n  \"heading\": {\n    \"heading.text\": \"<string>\",\n    \"heading.style\": \"<string>\",\n    \"heading.color\": \"<string>\",\n    \"heading.font\": \"<string>\",\n    \"heading.position\": \"<string>\",\n    \"heading.bg_color\": \"<string>\",\n    \"heading.instructions\": \"<string>\"\n  },\n  \"captions\": {\n    \"captions.enabled\": true,\n    \"captions.color\": \"<string>\",\n    \"captions.font\": \"<string>\"\n  },\n  \"music_url\": \"<string>\",\n  \"heading_text\": \"<string>\",\n  \"heading_style\": \"<string>\",\n  \"heading_color\": \"<string>\",\n  \"heading_font\": \"<string>\",\n  \"heading_position\": \"<string>\",\n  \"heading_bg_color\": \"<string>\",\n  \"heading_instructions\": \"<string>\",\n  \"captions_enabled\": \"<string>\",\n  \"captions_color\": \"<string>\",\n  \"captions_font\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cuttr.com/api/platform/v1/clip")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"video_url\": \"<string>\",\n  \"num_clips\": \"<string>\",\n  \"style\": \"<string>\",\n  \"length\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"camera_mode\": \"<string>\",\n  \"hook_length\": \"<string>\",\n  \"auto_heading\": \"<string>\",\n  \"heading\": {\n    \"heading.text\": \"<string>\",\n    \"heading.style\": \"<string>\",\n    \"heading.color\": \"<string>\",\n    \"heading.font\": \"<string>\",\n    \"heading.position\": \"<string>\",\n    \"heading.bg_color\": \"<string>\",\n    \"heading.instructions\": \"<string>\"\n  },\n  \"captions\": {\n    \"captions.enabled\": true,\n    \"captions.color\": \"<string>\",\n    \"captions.font\": \"<string>\"\n  },\n  \"music_url\": \"<string>\",\n  \"heading_text\": \"<string>\",\n  \"heading_style\": \"<string>\",\n  \"heading_color\": \"<string>\",\n  \"heading_font\": \"<string>\",\n  \"heading_position\": \"<string>\",\n  \"heading_bg_color\": \"<string>\",\n  \"heading_instructions\": \"<string>\",\n  \"captions_enabled\": \"<string>\",\n  \"captions_color\": \"<string>\",\n  \"captions_font\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "num_clips": 3,
  "cost_cents": 450,
  "status": "processing"
}

{
  "error": "Insufficient wallet balance",
  "required_cents": 450,
  "balance_cents": 200
}

POST

api

platform

clip

Create Clip

curl --request POST \
  --url https://api.cuttr.com/api/platform/v1/clip \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "video_url": "<string>",
  "num_clips": "<string>",
  "style": "<string>",
  "length": "<string>",
  "prompt": "<string>",
  "camera_mode": "<string>",
  "hook_length": "<string>",
  "auto_heading": "<string>",
  "heading": {
    "heading.text": "<string>",
    "heading.style": "<string>",
    "heading.color": "<string>",
    "heading.font": "<string>",
    "heading.position": "<string>",
    "heading.bg_color": "<string>",
    "heading.instructions": "<string>"
  },
  "captions": {
    "captions.enabled": true,
    "captions.color": "<string>",
    "captions.font": "<string>"
  },
  "music_url": "<string>",
  "heading_text": "<string>",
  "heading_style": "<string>",
  "heading_color": "<string>",
  "heading_font": "<string>",
  "heading_position": "<string>",
  "heading_bg_color": "<string>",
  "heading_instructions": "<string>",
  "captions_enabled": "<string>",
  "captions_color": "<string>",
  "captions_font": "<string>"
}
'

import requests

url = "https://api.cuttr.com/api/platform/v1/clip"

payload = {
    "video_url": "<string>",
    "num_clips": "<string>",
    "style": "<string>",
    "length": "<string>",
    "prompt": "<string>",
    "camera_mode": "<string>",
    "hook_length": "<string>",
    "auto_heading": "<string>",
    "heading": {
        "heading.text": "<string>",
        "heading.style": "<string>",
        "heading.color": "<string>",
        "heading.font": "<string>",
        "heading.position": "<string>",
        "heading.bg_color": "<string>",
        "heading.instructions": "<string>"
    },
    "captions": {
        "captions.enabled": True,
        "captions.color": "<string>",
        "captions.font": "<string>"
    },
    "music_url": "<string>",
    "heading_text": "<string>",
    "heading_style": "<string>",
    "heading_color": "<string>",
    "heading_font": "<string>",
    "heading_position": "<string>",
    "heading_bg_color": "<string>",
    "heading_instructions": "<string>",
    "captions_enabled": "<string>",
    "captions_color": "<string>",
    "captions_font": "<string>"
}
headers = {
    "X-API-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    video_url: '<string>',
    num_clips: '<string>',
    style: '<string>',
    length: '<string>',
    prompt: '<string>',
    camera_mode: '<string>',
    hook_length: '<string>',
    auto_heading: '<string>',
    heading: {
      'heading.text': '<string>',
      'heading.style': '<string>',
      'heading.color': '<string>',
      'heading.font': '<string>',
      'heading.position': '<string>',
      'heading.bg_color': '<string>',
      'heading.instructions': '<string>'
    },
    captions: {
      'captions.enabled': true,
      'captions.color': '<string>',
      'captions.font': '<string>'
    },
    music_url: '<string>',
    heading_text: '<string>',
    heading_style: '<string>',
    heading_color: '<string>',
    heading_font: '<string>',
    heading_position: '<string>',
    heading_bg_color: '<string>',
    heading_instructions: '<string>',
    captions_enabled: '<string>',
    captions_color: '<string>',
    captions_font: '<string>'
  })
};

fetch('https://api.cuttr.com/api/platform/v1/clip', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cuttr.com/api/platform/v1/clip",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'video_url' => '<string>',
    'num_clips' => '<string>',
    'style' => '<string>',
    'length' => '<string>',
    'prompt' => '<string>',
    'camera_mode' => '<string>',
    'hook_length' => '<string>',
    'auto_heading' => '<string>',
    'heading' => [
        'heading.text' => '<string>',
        'heading.style' => '<string>',
        'heading.color' => '<string>',
        'heading.font' => '<string>',
        'heading.position' => '<string>',
        'heading.bg_color' => '<string>',
        'heading.instructions' => '<string>'
    ],
    'captions' => [
        'captions.enabled' => true,
        'captions.color' => '<string>',
        'captions.font' => '<string>'
    ],
    'music_url' => '<string>',
    'heading_text' => '<string>',
    'heading_style' => '<string>',
    'heading_color' => '<string>',
    'heading_font' => '<string>',
    'heading_position' => '<string>',
    'heading_bg_color' => '<string>',
    'heading_instructions' => '<string>',
    'captions_enabled' => '<string>',
    'captions_color' => '<string>',
    'captions_font' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cuttr.com/api/platform/v1/clip"

	payload := strings.NewReader("{\n  \"video_url\": \"<string>\",\n  \"num_clips\": \"<string>\",\n  \"style\": \"<string>\",\n  \"length\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"camera_mode\": \"<string>\",\n  \"hook_length\": \"<string>\",\n  \"auto_heading\": \"<string>\",\n  \"heading\": {\n    \"heading.text\": \"<string>\",\n    \"heading.style\": \"<string>\",\n    \"heading.color\": \"<string>\",\n    \"heading.font\": \"<string>\",\n    \"heading.position\": \"<string>\",\n    \"heading.bg_color\": \"<string>\",\n    \"heading.instructions\": \"<string>\"\n  },\n  \"captions\": {\n    \"captions.enabled\": true,\n    \"captions.color\": \"<string>\",\n    \"captions.font\": \"<string>\"\n  },\n  \"music_url\": \"<string>\",\n  \"heading_text\": \"<string>\",\n  \"heading_style\": \"<string>\",\n  \"heading_color\": \"<string>\",\n  \"heading_font\": \"<string>\",\n  \"heading_position\": \"<string>\",\n  \"heading_bg_color\": \"<string>\",\n  \"heading_instructions\": \"<string>\",\n  \"captions_enabled\": \"<string>\",\n  \"captions_color\": \"<string>\",\n  \"captions_font\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cuttr.com/api/platform/v1/clip")
  .header("X-API-Key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video_url\": \"<string>\",\n  \"num_clips\": \"<string>\",\n  \"style\": \"<string>\",\n  \"length\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"camera_mode\": \"<string>\",\n  \"hook_length\": \"<string>\",\n  \"auto_heading\": \"<string>\",\n  \"heading\": {\n    \"heading.text\": \"<string>\",\n    \"heading.style\": \"<string>\",\n    \"heading.color\": \"<string>\",\n    \"heading.font\": \"<string>\",\n    \"heading.position\": \"<string>\",\n    \"heading.bg_color\": \"<string>\",\n    \"heading.instructions\": \"<string>\"\n  },\n  \"captions\": {\n    \"captions.enabled\": true,\n    \"captions.color\": \"<string>\",\n    \"captions.font\": \"<string>\"\n  },\n  \"music_url\": \"<string>\",\n  \"heading_text\": \"<string>\",\n  \"heading_style\": \"<string>\",\n  \"heading_color\": \"<string>\",\n  \"heading_font\": \"<string>\",\n  \"heading_position\": \"<string>\",\n  \"heading_bg_color\": \"<string>\",\n  \"heading_instructions\": \"<string>\",\n  \"captions_enabled\": \"<string>\",\n  \"captions_color\": \"<string>\",\n  \"captions_font\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cuttr.com/api/platform/v1/clip")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"video_url\": \"<string>\",\n  \"num_clips\": \"<string>\",\n  \"style\": \"<string>\",\n  \"length\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"camera_mode\": \"<string>\",\n  \"hook_length\": \"<string>\",\n  \"auto_heading\": \"<string>\",\n  \"heading\": {\n    \"heading.text\": \"<string>\",\n    \"heading.style\": \"<string>\",\n    \"heading.color\": \"<string>\",\n    \"heading.font\": \"<string>\",\n    \"heading.position\": \"<string>\",\n    \"heading.bg_color\": \"<string>\",\n    \"heading.instructions\": \"<string>\"\n  },\n  \"captions\": {\n    \"captions.enabled\": true,\n    \"captions.color\": \"<string>\",\n    \"captions.font\": \"<string>\"\n  },\n  \"music_url\": \"<string>\",\n  \"heading_text\": \"<string>\",\n  \"heading_style\": \"<string>\",\n  \"heading_color\": \"<string>\",\n  \"heading_font\": \"<string>\",\n  \"heading_position\": \"<string>\",\n  \"heading_bg_color\": \"<string>\",\n  \"heading_instructions\": \"<string>\",\n  \"captions_enabled\": \"<string>\",\n  \"captions_color\": \"<string>\",\n  \"captions_font\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "num_clips": 3,
  "cost_cents": 450,
  "status": "processing"
}

{
  "error": "Insufficient wallet balance",
  "required_cents": 450,
  "balance_cents": 200
}

Submit a video to generate AI-powered short-form clips. You can provide either a public URL or upload the file directly. Each clip costs $1.50 and is deducted from your wallet upfront. The response returns a job_id that you can poll with Get Job Status.

Both modes respond immediately. Whether you provide a URL or upload a file, the response comes back right away while the video is processed in the background. Use the returned job_id to poll for status.

Option 1: JSON with video URL

curl -X POST https://api.cuttr.com/api/platform/v1/clip \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://example.com/video.mp4",
    "num_clips": 3,
    "style": "viral",
    "prompt": "focus on the product demo moments",
    "camera_mode": "speaker-zoom",
    "auto_heading": true,
    "heading": { "style": "instagram", "bg_color": "black", "font": "Proxima Nova" },
    "captions": { "enabled": true, "color": "yellow", "font": "Luckiest Guy" }
  }'

Option 2: File upload via form data

curl -X POST https://api.cuttr.com/api/platform/v1/clip \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "video=@/path/to/video.mp4" \
  -F "num_clips=3" \
  -F "style=viral" \
  -F "camera_mode=speaker-zoom" \
  -F "auto_heading=true" \
  -F "heading_style=instagram" \
  -F "heading_bg_color=black" \
  -F "heading_font=Proxima Nova" \
  -F "captions_enabled=true" \
  -F "captions_color=yellow" \
  -F "captions_font=Luckiest Guy"

Headers

string

required

Your API key. Create one from the dashboard.

Body parameters (JSON)

string

A URL to the source video. Supports YouTube, Twitch, Kick, TikTok, Instagram, Vimeo, and 1000+ other platforms — as well as direct links to video files. Required if not uploading a file.

integer

default:"1"

Number of clips to generate (1-10).

string

default:"viral"

Clipping style. One of viral, business, general, or gaming.

integer

Target clip duration in seconds (10-180). Omit to let the AI decide.

string

Custom AI instructions for clip selection (e.g. “focus on product demos” or “find the funniest moments”).

string

default:"standard"

Controls how the video is framed for vertical (9:16) output. One of:

standard — blurred background with centered video
facecam — detects facecam overlay and separates gameplay + facecam
speaker-zoom — zooms into the speaker’s face
center-crop — crops the center of the video
active-speaker — tracks and zooms into the active speaker (multi-person)

integer

Hook duration in seconds (2-15). The hook is the attention-grabbing opening of each clip. Omit to let the AI decide.

boolean

default:"true"

Automatically generate a short viral heading overlay for each clip using AI.

object

Heading style customization. Applies to both auto-generated and custom headings.

Show properties

string

Custom heading text. When provided, overrides auto_heading.

string

default:"stroke"

Heading visual style. Determines which color options are available:

stroke — bold outlined text with no background. Use heading.color to set the text color. heading.bg_color is ignored.
instagram — text on a rounded pill-shaped background. Use heading.bg_color to set the pill color (black or white). Text color is automatically set to contrast (black bg → white text, white bg → black text). heading.color is ignored.

string

default:"white"

Text color. One of white, black, red, orange, yellow, green, teal, blue, purple, pink. Only used with stroke style — ignored when style is instagram.

string

default:"Montserrat"

Heading font. One of Proxima Nova, Montserrat, Luckiest Guy, Everlasting, Komika, Burbank, Bebas Neue, Anton. Tip: Proxima Nova works well with the instagram style.

string

default:"top"

Heading vertical position. One of top, middle, bottom.

string

default:"black"

Background pill color. One of black, white. Text color auto-adjusts for contrast. Only used with instagram style — ignored when style is stroke.

string

Optional instructions to guide AI heading generation (e.g. “focus on product benefits”, “use question-style headings”). Only applies when auto_heading is true and no custom text is provided. Max 1500 characters.

object

Caption settings.

Show properties

boolean

default:"false"

Whether to burn captions into the clip.

string

default:"white"

Caption highlight color. One of white, black, red, orange, yellow, green, teal, blue, purple, pink.

string

default:"Montserrat"

Caption font. One of Proxima Nova, Montserrat, Luckiest Guy, Everlasting, Komika, Burbank, Bebas Neue, Anton.

string

URL to a background music file (MP3, WAV, AAC). The music will be mixed into all generated clips at 30% volume.

Form data fields (multipart upload)

file

Video file (mp4, mov, avi, mkv, webm). Required if not providing video_url.

string

default:"1"

Number of clips to generate (1-10).

string

default:"viral"

Clipping style. One of viral, business, general, or gaming.

string

Target clip duration in seconds (10-180). Omit to let the AI decide.

string

Custom AI instructions for clip selection.

string

default:"standard"

How the video is framed. One of standard, facecam, speaker-zoom, center-crop, active-speaker.

string

Hook duration in seconds (2-15). Omit to let the AI decide.

file

Background music file (MP3, WAV, AAC). Will be mixed into all clips at 30% volume.

string

default:"true"

"true" or "false" — auto-generate a viral heading per clip.

string

Custom heading text. Overrides auto-generated heading.

string

default:"stroke"

stroke (bold outlined text, no background) or instagram (text on rounded pill background). Determines which color fields apply — see heading_color and heading_bg_color.

string

default:"white"

Heading text color. One of white, black, red, orange, yellow, green, teal, blue, purple, pink. Only used with stroke style — ignored when style is instagram.

string

default:"Montserrat"

Heading font. One of Proxima Nova, Montserrat, Luckiest Guy, Everlasting, Komika, Burbank, Bebas Neue, Anton.

string

default:"top"

Heading vertical position. One of top, middle, bottom.

string

default:"black"

Background pill color. One of black, white. Text color auto-adjusts for contrast. Only used with instagram style — ignored when style is stroke.

string

Instructions to guide AI heading generation. Max 1500 characters.

string

default:"false"

"true" or "false" — whether to burn captions.

string

default:"white"

Caption highlight color. One of white, black, red, orange, yellow, green, teal, blue, purple, pink.

string

default:"Montserrat"

Caption font. One of Proxima Nova, Montserrat, Luckiest Guy, Everlasting, Komika, Burbank, Bebas Neue, Anton.

Response

string

Job ID (UUID) to poll for results via Get Job Status.

integer

Number of clips being generated.

integer

Total amount charged in cents ($1.50 per clip).

string

Always "processing" on success.

{
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "num_clips": 3,
  "cost_cents": 450,
  "status": "processing"
}

{
  "error": "Insufficient wallet balance",
  "required_cents": 450,
  "balance_cents": 200
}

Overview

Endpoints

Create Clip

Option 1: JSON with video URL

Option 2: File upload via form data

Headers

Body parameters (JSON)

Form data fields (multipart upload)

Response

​Option 1: JSON with video URL

​Option 2: File upload via form data

​Headers

​Body parameters (JSON)

​Form data fields (multipart upload)

​Response

Option 1: JSON with video URL

Option 2: File upload via form data

Headers

Body parameters (JSON)

Form data fields (multipart upload)

Response