curl -X POST "https://api.submagic.co/v1/projects" \
  -H "x-api-key: sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My Awesome Video",
    "language": "en",
    "videoUrl": "https://example.com/videos/sample.mp4",
    "templateName": "Hormozi 2",
    "items": [
      {
        "type": "user-media",
        "startTime": 5,
        "endTime": 10,
        "userMediaId": "123e4567-e89b-12d3-a456-426614174000",
        "layout": "pip-top-right"
      },
      {
        "type": "ai-broll",
        "startTime": 15,
        "endTime": 21,
        "prompt": "person performing multiple back exercises on gym equipment",
        "layout": "split-50-50"
      }
    ],
    "webhookUrl": "https://yoursite.com/webhook/submagic",
    "dictionary": ["Submagic", "AI-powered", "captions"],
    "magicZooms": true,
    "magicBrolls": true,
    "magicBrollsPercentage": 75,
    "removeSilencePace": "fast",
    "removeBadTakes": true,
    "cleanAudio": true,
    "hookTitle": {
      "text": "Stop scrolling—watch this in 30 seconds",
      "template": "tiktok",
      "top": 45,
      "size": 32
    },
    "music": {
      "userMediaId": "88a08eec-712a-45d0-8d0b-3b631700cb3a",
      "volume": 30,
      "startFromTime": 0,
      "fade": true
    }
  }'

const createProject = async () => {
  const response = await fetch("https://api.submagic.co/v1/projects", {
    method: "POST",
    headers: {
      "x-api-key": "sk-your-api-key-here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      title: "My Awesome Video",
      language: "en",
      videoUrl: "https://example.com/videos/sample.mp4",
      templateName: "Hormozi 2",
      items: [
        {
          type: "user-media",
          startTime: 5,
          endTime: 10,
          userMediaId: "123e4567-e89b-12d3-a456-426614174000",
          layout: "pip-top-right",
        },
        {
          type: "ai-broll",
          startTime: 15,
          endTime: 21,
          prompt:
            "person performing multiple back exercises on gym equipment",
          layout: "split-50-50",
        },
      ],
      webhookUrl: "https://yoursite.com/webhook/submagic",
      dictionary: ["Submagic", "AI-powered", "captions"],
      magicZooms: true,
      magicBrolls: true,
      magicBrollsPercentage: 75,
      removeSilencePace: "fast",
      removeBadTakes: true,
      cleanAudio: true,
      hookTitle: {
        text: "Stop scrolling—watch this in 30 seconds",
        template: "tiktok",
        top: 45,
        size: 32,
      },
      music: {
        userMediaId: "88a08eec-712a-45d0-8d0b-3b631700cb3a",
        volume: 30,
        startFromTime: 0,
        fade: true,
      },
    }),
  });

  const project = await response.json();
  console.log("Project created:", project.id);
  return project;
};

import requests
import json

def create_project():
    url = 'https://api.submagic.co/v1/projects'
    headers = {
        'x-api-key': 'sk-your-api-key-here',
        'Content-Type': 'application/json'
    }
    data = {
        'title': 'My Awesome Video',
        'language': 'en',
        'videoUrl': 'https://example.com/videos/sample.mp4',
        'templateName': 'Hormozi 2',
        'items': [
            {
                'type': 'user-media',
                'startTime': 5,
                'endTime': 10,
                'userMediaId': '123e4567-e89b-12d3-a456-426614174000',
                'layout': 'pip-top-right'
            },
            {
                'type': 'ai-broll',
                'startTime': 15,
                'endTime': 21,
                'prompt': 'person performing multiple back exercises on gym equipment',
                'layout': 'split-50-50'
            }
        ],
        'webhookUrl': 'https://yoursite.com/webhook/submagic',
        'dictionary': ['Submagic', 'AI-powered', 'captions'],
        'magicZooms': True,
        'magicBrolls': True,
        'magicBrollsPercentage': 75,
        'removeSilencePace': 'fast',
        'removeBadTakes': True,
        'cleanAudio': True,
        'hookTitle': {
            'text': 'Stop scrolling—watch this in 30 seconds',
            'template': 'tiktok',
            'top': 45,
            'size': 32
        },
        'music': {
            'userMediaId': '88a08eec-712a-45d0-8d0b-3b631700cb3a',
            'volume': 30,
            'startFromTime': 0,
            'fade': True
        }
    }

    response = requests.post(url, headers=headers, json=data)
    project = response.json()

    print(f"Project created: {project['id']}")
    return project

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My Awesome Video",
  "language": "en",
  "status": "processing",
  "webhookUrl": "https://yoursite.com/webhook/submagic",
  "templateName": "Hormozi 2",
  "magicZooms": true,
  "magicBrolls": true,
  "magicBrollsPercentage": 75,
  "removeSilencePace": "fast",
  "removeBadTakes": true,
  "cleanAudio": true,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

POST

projects

curl -X POST "https://api.submagic.co/v1/projects" \
  -H "x-api-key: sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My Awesome Video",
    "language": "en",
    "videoUrl": "https://example.com/videos/sample.mp4",
    "templateName": "Hormozi 2",
    "items": [
      {
        "type": "user-media",
        "startTime": 5,
        "endTime": 10,
        "userMediaId": "123e4567-e89b-12d3-a456-426614174000",
        "layout": "pip-top-right"
      },
      {
        "type": "ai-broll",
        "startTime": 15,
        "endTime": 21,
        "prompt": "person performing multiple back exercises on gym equipment",
        "layout": "split-50-50"
      }
    ],
    "webhookUrl": "https://yoursite.com/webhook/submagic",
    "dictionary": ["Submagic", "AI-powered", "captions"],
    "magicZooms": true,
    "magicBrolls": true,
    "magicBrollsPercentage": 75,
    "removeSilencePace": "fast",
    "removeBadTakes": true,
    "cleanAudio": true,
    "hookTitle": {
      "text": "Stop scrolling—watch this in 30 seconds",
      "template": "tiktok",
      "top": 45,
      "size": 32
    },
    "music": {
      "userMediaId": "88a08eec-712a-45d0-8d0b-3b631700cb3a",
      "volume": 30,
      "startFromTime": 0,
      "fade": true
    }
  }'

const createProject = async () => {
  const response = await fetch("https://api.submagic.co/v1/projects", {
    method: "POST",
    headers: {
      "x-api-key": "sk-your-api-key-here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      title: "My Awesome Video",
      language: "en",
      videoUrl: "https://example.com/videos/sample.mp4",
      templateName: "Hormozi 2",
      items: [
        {
          type: "user-media",
          startTime: 5,
          endTime: 10,
          userMediaId: "123e4567-e89b-12d3-a456-426614174000",
          layout: "pip-top-right",
        },
        {
          type: "ai-broll",
          startTime: 15,
          endTime: 21,
          prompt:
            "person performing multiple back exercises on gym equipment",
          layout: "split-50-50",
        },
      ],
      webhookUrl: "https://yoursite.com/webhook/submagic",
      dictionary: ["Submagic", "AI-powered", "captions"],
      magicZooms: true,
      magicBrolls: true,
      magicBrollsPercentage: 75,
      removeSilencePace: "fast",
      removeBadTakes: true,
      cleanAudio: true,
      hookTitle: {
        text: "Stop scrolling—watch this in 30 seconds",
        template: "tiktok",
        top: 45,
        size: 32,
      },
      music: {
        userMediaId: "88a08eec-712a-45d0-8d0b-3b631700cb3a",
        volume: 30,
        startFromTime: 0,
        fade: true,
      },
    }),
  });

  const project = await response.json();
  console.log("Project created:", project.id);
  return project;
};

import requests
import json

def create_project():
    url = 'https://api.submagic.co/v1/projects'
    headers = {
        'x-api-key': 'sk-your-api-key-here',
        'Content-Type': 'application/json'
    }
    data = {
        'title': 'My Awesome Video',
        'language': 'en',
        'videoUrl': 'https://example.com/videos/sample.mp4',
        'templateName': 'Hormozi 2',
        'items': [
            {
                'type': 'user-media',
                'startTime': 5,
                'endTime': 10,
                'userMediaId': '123e4567-e89b-12d3-a456-426614174000',
                'layout': 'pip-top-right'
            },
            {
                'type': 'ai-broll',
                'startTime': 15,
                'endTime': 21,
                'prompt': 'person performing multiple back exercises on gym equipment',
                'layout': 'split-50-50'
            }
        ],
        'webhookUrl': 'https://yoursite.com/webhook/submagic',
        'dictionary': ['Submagic', 'AI-powered', 'captions'],
        'magicZooms': True,
        'magicBrolls': True,
        'magicBrollsPercentage': 75,
        'removeSilencePace': 'fast',
        'removeBadTakes': True,
        'cleanAudio': True,
        'hookTitle': {
            'text': 'Stop scrolling—watch this in 30 seconds',
            'template': 'tiktok',
            'top': 45,
            'size': 32
        },
        'music': {
            'userMediaId': '88a08eec-712a-45d0-8d0b-3b631700cb3a',
            'volume': 30,
            'startFromTime': 0,
            'fade': True
        }
    }

    response = requests.post(url, headers=headers, json=data)
    project = response.json()

    print(f"Project created: {project['id']}")
    return project

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My Awesome Video",
  "language": "en",
  "status": "processing",
  "webhookUrl": "https://yoursite.com/webhook/submagic",
  "templateName": "Hormozi 2",
  "magicZooms": true,
  "magicBrolls": true,
  "magicBrollsPercentage": 75,
  "removeSilencePace": "fast",
  "removeBadTakes": true,
  "cleanAudio": true,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Create Project

Create a new video project by providing a video URL. This endpoint will download the video, transcribe the audio, and apply the specified template with AI-generated captions and effects.

This endpoint requires authentication and has a rate limit of 500 requests per hour.

Authentication

string

required

Your Submagic API key starting with sk-

Request Body

string

required

A descriptive title for your video project (1-100 characters)

string

required

Language code for transcription (e.g., “en”, “es”, “fr”). Use the languages endpoint to get available options.

string

required

Public URL to your video file. Must be accessible without authentication and in a supported format.

string

Name of an AI edit template to apply. AI edit templates automatically apply AI-powered scene splitting, B-roll, music, and styling to your video. Available templates: "kelly" (minimal, design), "karl" (effective, modern), "ella" (dynamic, bold).When aiEditTemplate is provided, the only other fields you can pass alongside it are title, language, videoUrl, webhookUrl, and dictionary. All other fields will be ignored or rejected.

string

ID of a saved preset to apply to the project. A preset is a snapshot of your project settings — including captions style, hook title, music, effects, and more. When provided, all preset settings are automatically applied after transcription completes. To get your preset ID, go to the Presets page in the app, open the dropdown menu on any preset card, and click “Copy ID”.Cannot be combined with templateName, userThemeId, hookTitle, music, items, magicZooms, magicBrolls, magicBrollsPercentage, removeSilencePace, removeBadTakes, captionPositionY, or captionPositionX — the preset already controls these settings.

string

Template to apply for styling. Use the templates endpoint to get available options. Defaults to “Sara” if not specified. Cannot be used together with userThemeId.

string

ID of a custom user theme to apply for styling. Must be a valid UUID of a theme that belongs to you or your team. Cannot be used together with templateName. You can find the id of your custom theme by opening a project, selecting the theme, pressing the pen icon to edit it. You’ll see the id of the theme under theme’s name.

number

Vertical caption position as a percentage from the top of the frame (0-80). Overrides the position of the selected template or theme. Cannot be combined with presetId or aiEditTemplate.

number

Horizontal caption position as a percentage (0-100, 50 = centered). Overrides the position of the selected template or theme. Cannot be combined with presetId or aiEditTemplate.

boolean | object

Adds an animated opening caption (hook) to the video. Set to true to let AI generate using the default style or pass an object to customize the appearance:

text (optional): Custom hook, 1-100 characters
template (optional): Hook title template name. Defaults to "tiktok". Use the hook title templates endpoint to retrieve valid options.
top (optional): Vertical position (0-80). Defaults to 50.
size (optional): Font size (0-80). Defaults to 30.

string

URL to receive webhook notifications when processing is complete. Must be a valid HTTPS URL.

array

Array of custom words or phrases to improve transcription accuracy (max 100 items, 50 characters each). Terms are saved to your account and applied to all your future projects; your account keeps the 1,000 most recently added terms.

array

Optional array of items to insert into the video. Each item must include a type field to specify whether it’s user media from your library or AI-generated content.

Hide User Media Item

string

required

Must be set to "user-media"

number

required

Start time in seconds where the media should begin (must be ≥ 0)

number

required

End time in seconds where the media should end (must be greater than startTime)

string

required

UUID of the user media from your library. You can find this ID in the editor’s ‘B-roll’ tab → ‘My videos’ section under each video.

string

Layout mode for the inserted media. Available values depend on the media type:Video media: "cover", "contain", "rounded", "square", "split-50-50", "split-35-65", "split-50-50-bordered", "split-35-65-bordered", "pip-top-right", "pip-bottom-right"Image media: "cover", "contain", "rounded", "square"

Hide AI B-roll Item

string

required

Must be set to "ai-broll"

number

required

Start timestamp in seconds (must be ≥ 0)

number

required

End timestamp in seconds. Must be greater than startTime and no more than 12 seconds later.

string

required

Describes what the AI B-roll should depict (1-2500 characters)

string

Layout mode for the AI B-roll. Allowed values: "cover", "contain", "rounded", "square", "split-50-50", "split-35-65", "split-50-50-bordered", "split-35-65-bordered", "pip-top-right", "pip-bottom-right"

Important: Each item must have a type field. Items cannot overlap with each other in time. Requests that include invalid durations, overlapping ranges, or prompts outside the allowed length will be rejected.

boolean

Enable automatic zoom effects on the video to enhance visual engagement. Optional, defaults to false.

boolean

Enable automatic B-roll insertion to enhance video content with relevant supplementary footage. Optional, defaults to false.

number

Percentage of automatic B-rolls to include in the video (0-100). Only effective when magicBrolls is enabled. Optional, defaults to 50.

string

Automatically remove silence from the video at the specified pace. Optional. Allowed values: natural, fast, extra-fast. - extra-fast: 0.1-0.2 seconds of silence removal - fast: 0.2-0.6 seconds of silence removal - natural: 0.6+ seconds of silence removal

boolean

Automatically detect and remove bad takes and silence from the video using AI analysis. Optional, defaults to false.

boolean

Enable AI-powered audio cleanup that removes background noises from the video. Optional, defaults to false.

boolean

Hide captions from the exported video. Optional, defaults to false.

boolean

Whether to automatically render the final video once transcription completes. Optional, defaults to true.Set to false to keep the project editable: after transcription the project stays in completed status without a rendered video, and the completed webhook fires so you know it’s ready. You can then fetch the transcript with Get Project, edit the captions with Update Project (the words field), and trigger the render yourself with Export Project.

object

Optional background music track that spans the full project duration.

Hide Music Object

string

required

UUID of the music track. Accepts either an AUDIO file from your media library (use List User Media) or a Trendy Music track ID (copied from the editor’s Edit Audio → Trendy Music tab).

number

required

Playback volume (1-100)

number

Start offset within the audio file in seconds. Defaults to 0.

boolean

Apply a fade-in/fade-out effect to the music track. Defaults to true.

Supported Formats & Limits

Supported Formats

MP4 (.mp4) - MOV (.mov)

File Limits

Max size: 2GB - Max duration: 2 hours

Response

string

Unique identifier for the created project (UUID format)

string

The title you provided for the project

string

Language code used for transcription

string

Current processing status: processing, transcribing, exporting, completed, or failed

string

Webhook URL if provided in the request

string

Template name applied to the project

string

User theme ID applied to the project

string

Preset ID applied to the project

string

AI edit template applied to the project (if any): kelly, karl, or ella

boolean

Whether automatic zoom effects are enabled for the video

boolean

Whether automatic B-roll insertion is enabled for the video

number

Percentage of automatic B-rolls to include in the video (0-100)

string

Pace setting for automatic silence removal: natural, fast, or extra-fast

boolean

Whether automatic bad takes and silence removal is enabled

boolean

Whether AI-powered audio cleanup is enabled

number

Vertical caption position override (0-80), echoed back when provided

number

Horizontal caption position override (0-100), echoed back when provided

string

ISO 8601 timestamp when the project was created

string

ISO 8601 timestamp when the project was last updated

curl -X POST "https://api.submagic.co/v1/projects" \
  -H "x-api-key: sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My Awesome Video",
    "language": "en",
    "videoUrl": "https://example.com/videos/sample.mp4",
    "templateName": "Hormozi 2",
    "items": [
      {
        "type": "user-media",
        "startTime": 5,
        "endTime": 10,
        "userMediaId": "123e4567-e89b-12d3-a456-426614174000",
        "layout": "pip-top-right"
      },
      {
        "type": "ai-broll",
        "startTime": 15,
        "endTime": 21,
        "prompt": "person performing multiple back exercises on gym equipment",
        "layout": "split-50-50"
      }
    ],
    "webhookUrl": "https://yoursite.com/webhook/submagic",
    "dictionary": ["Submagic", "AI-powered", "captions"],
    "magicZooms": true,
    "magicBrolls": true,
    "magicBrollsPercentage": 75,
    "removeSilencePace": "fast",
    "removeBadTakes": true,
    "cleanAudio": true,
    "hookTitle": {
      "text": "Stop scrolling—watch this in 30 seconds",
      "template": "tiktok",
      "top": 45,
      "size": 32
    },
    "music": {
      "userMediaId": "88a08eec-712a-45d0-8d0b-3b631700cb3a",
      "volume": 30,
      "startFromTime": 0,
      "fade": true
    }
  }'

const createProject = async () => {
  const response = await fetch("https://api.submagic.co/v1/projects", {
    method: "POST",
    headers: {
      "x-api-key": "sk-your-api-key-here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      title: "My Awesome Video",
      language: "en",
      videoUrl: "https://example.com/videos/sample.mp4",
      templateName: "Hormozi 2",
      items: [
        {
          type: "user-media",
          startTime: 5,
          endTime: 10,
          userMediaId: "123e4567-e89b-12d3-a456-426614174000",
          layout: "pip-top-right",
        },
        {
          type: "ai-broll",
          startTime: 15,
          endTime: 21,
          prompt:
            "person performing multiple back exercises on gym equipment",
          layout: "split-50-50",
        },
      ],
      webhookUrl: "https://yoursite.com/webhook/submagic",
      dictionary: ["Submagic", "AI-powered", "captions"],
      magicZooms: true,
      magicBrolls: true,
      magicBrollsPercentage: 75,
      removeSilencePace: "fast",
      removeBadTakes: true,
      cleanAudio: true,
      hookTitle: {
        text: "Stop scrolling—watch this in 30 seconds",
        template: "tiktok",
        top: 45,
        size: 32,
      },
      music: {
        userMediaId: "88a08eec-712a-45d0-8d0b-3b631700cb3a",
        volume: 30,
        startFromTime: 0,
        fade: true,
      },
    }),
  });

  const project = await response.json();
  console.log("Project created:", project.id);
  return project;
};

import requests
import json

def create_project():
    url = 'https://api.submagic.co/v1/projects'
    headers = {
        'x-api-key': 'sk-your-api-key-here',
        'Content-Type': 'application/json'
    }
    data = {
        'title': 'My Awesome Video',
        'language': 'en',
        'videoUrl': 'https://example.com/videos/sample.mp4',
        'templateName': 'Hormozi 2',
        'items': [
            {
                'type': 'user-media',
                'startTime': 5,
                'endTime': 10,
                'userMediaId': '123e4567-e89b-12d3-a456-426614174000',
                'layout': 'pip-top-right'
            },
            {
                'type': 'ai-broll',
                'startTime': 15,
                'endTime': 21,
                'prompt': 'person performing multiple back exercises on gym equipment',
                'layout': 'split-50-50'
            }
        ],
        'webhookUrl': 'https://yoursite.com/webhook/submagic',
        'dictionary': ['Submagic', 'AI-powered', 'captions'],
        'magicZooms': True,
        'magicBrolls': True,
        'magicBrollsPercentage': 75,
        'removeSilencePace': 'fast',
        'removeBadTakes': True,
        'cleanAudio': True,
        'hookTitle': {
            'text': 'Stop scrolling—watch this in 30 seconds',
            'template': 'tiktok',
            'top': 45,
            'size': 32
        },
        'music': {
            'userMediaId': '88a08eec-712a-45d0-8d0b-3b631700cb3a',
            'volume': 30,
            'startFromTime': 0,
            'fade': True
        }
    }

    response = requests.post(url, headers=headers, json=data)
    project = response.json()

    print(f"Project created: {project['id']}")
    return project

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My Awesome Video",
  "language": "en",
  "status": "processing",
  "webhookUrl": "https://yoursite.com/webhook/submagic",
  "templateName": "Hormozi 2",
  "magicZooms": true,
  "magicBrolls": true,
  "magicBrollsPercentage": 75,
  "removeSilencePace": "fast",
  "removeBadTakes": true,
  "cleanAudio": true,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Custom Dictionary

Improve transcription accuracy by providing custom terms:

{
  "dictionary": [
    "Submagic",
    "API endpoint",
    "captions",
    "transcription",
    "AI-powered",
    "webhook notification"
  ]
}

Best practices for dictionary terms:

Include brand names, product names, or technical terms
Add words that are frequently mispronounced or misunderstood
Send only the terms that need help, not the full script
Send plain strings ("Submagic"), not JSON-encoded ones ("\"Submagic\"")
Keep terms under 50 characters each
Limit to 100 terms per request
Terms are saved to your account and reused on every future project; the 1,000 most recently added terms are kept

Webhook Integration

Receive notifications when your project is complete:

{
  "webhookUrl": "https://yoursite.com/webhook/submagic"
}

Your webhook endpoint will receive a POST request:

{
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "downloadUrl": "https://app.submagic.co/api/file/download?path=3c6cd7cd-3f5e-4def-b662-69c48a7fc8ce/e568c322-7fa5-497a-8fb0-3ba32e9e67d2/364fe092-b68d-468a-9558-bfca7c4d130e-download.mp4&newFileName=ProMotion%20Display%20Breakthrough.mp4",
  "directUrl": "https://dqu1p08d61fh.cloudfront.net/api/9cc52d00-43d7-442f-9a22-050312bkm24f/1ddee5b4-101f-4c1e-a74a-b6b3bcfe206c/video.mp4-download.mp4",
  "timestamp": "2024-01-15T10:45:00.000Z"
}

Error Responses

object

{
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "field": "videoUrl",
      "message": "Must be a valid URL",
      "value": "invalid-url"
    }
  ]
}

object

{
  "error": "VALIDATION_ERROR",
  "message": "presetId cannot be combined with templateName, userThemeId, aiEditTemplate, magicZooms, magicBrolls, magicBrollsPercentage, removeBadTakes, removeSilencePace, items, hookTitle, music, captionPositionY, or captionPositionX. The preset controls these settings."
}

object

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid template name"
}

{
  "error": "VALIDATION_ERROR",
  "message": "URLs from social media platforms are not supported. Please use a direct download link."
}

object

Returned when videoUrl is a Google Drive folder or other Drive link that doesn’t point to a single file. Share a direct file link with access set to “Anyone with the link”.

{
  "error": "VALIDATION_ERROR",
  "message": "This looks like a Google Drive folder or an unsupported Drive link. Please share a direct link to a single file (e.g. https://drive.google.com/file/d/FILE_ID/view) with access set to \"Anyone with the link\"."
}

object

Returned when videoUrl can’t be reached or serves a web page instead of a media file (e.g. a broken link, a login wall, or a share page rather than a direct download).

{
  "error": "VALIDATION_ERROR",
  "message": "The provided URL does not point to a downloadable media file. Please provide a direct download link to a video, audio, or image file."
}

object

{
  "error": "UNAUTHORIZED",
  "message": "Invalid or missing API key"
}

object

{
  "error": "RATE_LIMIT_EXCEEDED",
  "message": "Too many requests",
  "retryAfter": 30
}

object

{
  "error": "INTERNAL_SERVER_ERROR", 
  "message": "An unexpected error occurred"
}

Get Started

Guides

API Reference

Create Project

Create Project

Authentication

Request Body

Supported Formats & Limits

Supported Formats

File Limits

Response

Custom Dictionary

Webhook Integration

Error Responses

​Create Project

​Authentication

​Request Body

​Supported Formats & Limits

Supported Formats

File Limits

​Response

​Custom Dictionary

​Webhook Integration

​Error Responses

Create Project

Authentication

Request Body

Supported Formats & Limits

Response

Custom Dictionary

Webhook Integration

Error Responses