Submagic API

https://docs.submagic.co/
Admin
The Submagic API allows you to programmatically generate AI-powered captions for your videos and...
Tokens:46,214
Snippets:736
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Response Example: Transcribing

Source: https://docs.submagic.co/api-reference/get-project

Example JSON response when a project is in the 'transcribing' state.

```json
{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "My Awesome Video",
    "description": "AI description of the project",
    "language": "en",
    "status": "transcribing",
    "webhookUrl": "https://yoursite.com/webhook/submagic",
    "templateName": "Hormozi 2",
    "transcriptionStatus": "PROCESSING",
    "magicZooms": true,
    "magicBrolls": true,
    "magicBrollsPercentage": 75,
    "removeSilencePace": "fast",
    "removeBadTakes": true,
    "videoMetaData": {
      "width": 1920,
      "height": 1080,
      "duration": 185.2,
      "fps": 30
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:32:15.000Z"
  }
```

--------------------------------

### Get Project Details

Source: https://docs.submagic.co/llms-full.txt

Example of how to retrieve project details using the Submagic API.

```bash
curl -X GET "https://api.submagic.co/v1/projects/550e8400-e29b-41d4-a716-446655440000" \
    -H "x-api-key: sk-your-api-key-here"
```

```javascript
const getProject = async (projectId) => {
    const response = await fetch(
      `https://api.submagic.co/v1/projects/${projectId}`,
      {
        method: "GET",
        headers: {
          "x-api-key": "sk-your-api-key-here",
        },
      }
    );

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

  // Usage
  const project = await getProject("550e8400-e29b-41d4-a716-446655440000");
```

```python
import requests

def get_project(project_id):
    url = f'https://api.submagic.co/v1/projects/{project_id}'
    headers = {
        'x-api-key': 'sk-your-api-key-here'
    }

    response = requests.get(url, headers=headers)
    project = response.json()

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

# Usage
project = get_project('550e8400-e29b-41d4-a716-446655440000')
```

--------------------------------

### API Key Format Example

Source: https://docs.submagic.co/llms-full.txt

Example of the expected API key format.

```text
sk-[64-character-hex-string]
```

--------------------------------

### Project Response Example

Source: https://docs.submagic.co/api-reference/get-project

An example of the JSON response when retrieving project details.

```json
{
    "id": "e568c322-7fa5-497a-8fb0-3ba32e9e67d2",
    "title": "Fusion Camera Technology",
    "duration": 120.5,
    "viralityScores": {
      "total": 95,
      "shareability": 25,
      "hook_strength": 25,
      "story_quality": 20,
      "emotional_impact": 25
    },
    "status": "completed",
    "previewUrl": "https://app.submagic.co/view/e568c322-7fa5-497a-8fb0-3ba32e9e67d2",
    "downloadUrl": "https://api.submagic.co/api/file/download?path=3c6cd7cd-3f5e-4def-b662-69c48a7fc8ce/e568c322-7fa5-497a-8fb0-3ba32e9e67d2/5c26f199-08dd-4fac-911f-5378c23cc103-download.mp4&newFileName=Fusion%20Camera%20Technology.mp4",
    "directUrl": "https://dqu1p08d61fh.cloudfront.net/api/9cc52d00-43d7-442f-9a22-050312bkm24f/1ddee5b4-101f-4c1e-a74a-b6b3bcfe206c/video.mp4-download.mp4"
  },
  {
    "id": "364fe092-b68d-468a-9558-bfca7c4d190e",
    "title": "ProMotion Display Breakthrough",
    "duration": 21.04,
    "viralityScores": {
      "total": 89,
      "shareability": 23,
      "hook_strength": 22,
      "story_quality": 21,
      "emotional_impact": 23
    },
    "status": "completed",
    "previewUrl": "https://app.submagic.co/view/364fe092-b68d-468a-9558-bfca7c4d190g",
    "downloadUrl": "https://api.submagic.co/api/file/download?path=3c6cd7cd-3f5e-4def-b662-69c48a7fc8ce/e568c322-7fa5-497a-8fb0-3ba32e9e67d2/364fe092-b68d-468a-9558-bfca7c4d189c-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"
  }
],
    "createdAt": "2025-09-24T12:55:56.989Z",
    "updatedAt": "2025-09-24T12:59:24.880Z"
  }
```

--------------------------------

### Python Request Example

Source: https://docs.submagic.co/llms-full.txt

Example of how to create user media using Python.

```python
import requests

def create_user_media(media_url):
    url = 'https://api.submagic.co/v1/user-media'
    headers = {
        'x-api-key': 'sk-your-api-key-here',
        'Content-Type': 'application/json'
    }
    data = {
        'url': media_url
    }

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

    print(f"User media created: {result['userMediaId']}")
    return result

# Usage
media = create_user_media('https://example.com/media/sample-video.mp4')

```

--------------------------------

### Response Example

Source: https://docs.submagic.co/api-reference/templates

Example response showing available template names.

```json
{
    "templates": [
        "Matt",
        "Jess",
        "Jack",
        "Nick",
        "Laura",
        "Kelly 2",
        "Caleb",
        "Kendrick",
        "Lewis",
        "Doug",
        "Carlos",
        "Luke",
        "Leila",
        "Mark",
        "Sara",
        "Daniel",
        "Dan 2",
        "Hormozi 4",
        "Dan",
        "Devin",
        "Tayo",
        "Ella",
        "Tracy",
        "Hormozi 1",
        "Hormozi 2",
        "Hormozi 3",
        "Hormozi 5",
        "Jason",
        "William",
        "Leon",
        "Ali",
        "Beast",
        "Maya",
        "Karl",
        "Iman",
        "Umi",
        "David",
        "Noah",
        "Gstaad",
        "Malta",
        "Nema",
        "seth"
    ]
}
```

--------------------------------

### .env File Example

Source: https://docs.submagic.co/llms-full.txt

Example of storing the API key in a .env file.

```dotenv
SUBMAGIC_API_KEY=sk-your-api-key-here
```

--------------------------------

### JavaScript Request Example

Source: https://docs.submagic.co/llms-full.txt

Example of how to create user media using JavaScript.

```javascript
const createUserMedia = async (mediaUrl) => {
  const response = await fetch("https://api.submagic.co/v1/user-media", {
    method: "POST",
    headers: {
      "x-api-key": "sk-your-api-key-here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      url: mediaUrl,
    }),
  });

  const data = await response.json();
  console.log("User media created:", data.userMediaId);
  return data;
};

// Usage
const media = await createUserMedia(
  "https://example.com/media/sample-video.mp4"
);

```

--------------------------------

### Response Example

Source: https://docs.submagic.co/api-reference/create-project

Example of a successful response when creating a project.

```json
{
  "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"
}
```

--------------------------------

### API Key Example

Source: https://docs.submagic.co/llms-full.txt

An example of a generated API key.

```text
sk-a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456
```

--------------------------------

### Get Project (cURL)

Source: https://docs.submagic.co/api-reference/get-project

Example of how to fetch project details using cURL.

```bash
curl -X GET "https://api.submagic.co/v1/projects/550e8400-e29b-41d4-a716-446655440000" \
    -H "x-api-key: sk-your-api-key-here"
```

--------------------------------

### Response Example: Transcribing

Source: https://docs.submagic.co/llms-full.txt

Example JSON response when a project is in the 'transcribing' state.

```json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My Awesome Video",
  "description": "AI description of the project",
  "language": "en",
  "status": "transcribing",
  "webhookUrl": "https://yoursite.com/webhook/submagic",
  "templateName": "Hormozi 2",
  "transcriptionStatus": "PROCESSING",
  "magicZooms": true,
  "magicBrolls": true,
  "magicBrollsPercentage": 75,
  "removeSilencePace": "fast",
  "removeBadTakes": true,
  "videoMetaData": {
    "width": 1920,
    "height": 1080,
    "duration": 185.2,
    "fps": 30
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:32:15.000Z"
}
```

--------------------------------

### cURL Request Example

Source: https://docs.submagic.co/llms-full.txt

Example of how to create user media using cURL.

```bash
curl -X POST "https://api.submagic.co/v1/user-media" \
  -H "x-api-key: sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/media/sample-video.mp4"
  }'
```

--------------------------------

### Get Project (JavaScript)

Source: https://docs.submagic.co/api-reference/get-project

Example of how to fetch project details using JavaScript's fetch API.

```javascript
const getProject = async (projectId) => {
    const response = await fetch(
      `https://api.submagic.co/v1/projects/${projectId}`,
      {
        method: "GET",
        headers: {
          "x-api-key": "sk-your-api-key-here",
        },
      }
    );

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

  // Usage
  const project = await getProject("550e8400-e29b-41d4-a716-446655440000");
```

--------------------------------

### Response Example: Processing with Transcription Complete

Source: https://docs.submagic.co/api-reference/get-project

Example JSON response when a project is processing and transcription is complete.

```json
{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "My Awesome Video",
    "description": "AI description of the project",
    "language": "en",
    "status": "processing",
    "webhookUrl": "https://yoursite.com/webhook/submagic",
    "templateName": "Hormozi 2",
    "transcriptionStatus": "COMPLETED",
    "magicZooms": true,
    "magicBrolls": true,
    "magicBrollsPercentage": 75,
    "removeSilencePace": "fast",
    "removeBadTakes": true,
    "videoMetaData": {
      "width": 1920,
      "height": 1080,
      "duration": 185.2,
      "fps": 30
    },
    "words": [
      {
        "id": "silence_f9164d70-ac39-41cc-ae31-5b9de3093a2f",
        "text": "",
        "type": "silence",
        "startTime": 0,
        "endTime": 0.08
      },
      {
        "id": "w1EydrN5",
        "text": "Do",
        "type": "word",
        "startTime": 0.08,
        "endTime": 0.16
      },
      {
        "id": "8VUdYfGN",
        "text": "you",
        "type": "word",
        "startTime": 0.16,
        "endTime": 0.24
      },
      {
        "id": "eZBH24RB",
        "text": "mind",
        "type": "word",
        "startTime": 0.24,
        "endTime": 0.32
      },
      {
        "id": "RFLElgda",
        "text": "if",
        "type": "word",
        "startTime": 0.32,
        "endTime": 0.4
      },
      {
        "id": "iTWC5pc9",
        "text": "we",
        "type": "word",

```

--------------------------------

### Python Example

Source: https://docs.submagic.co/api-reference/create-project

Example of how to create a project using the Submagic API in Python.

```python
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

```

--------------------------------

### Python Example with Environment Variable

Source: https://docs.submagic.co/llms-full.txt

Example of accessing the API key from an environment variable in Python.

```python
import os
api_key = os.getenv('SUBMAGIC_API_KEY')
```

--------------------------------

### Webhook Integration Example

Source: https://docs.submagic.co/api-reference/create-project

Example of a webhook URL to receive notifications.

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

--------------------------------

### JavaScript Example

Source: https://docs.submagic.co/api-reference/create-project

Example of how to create a project using the Submagic API in JavaScript.

```javascript
async function createProject() {
    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;
  };
```

--------------------------------

### Node.js Example with Environment Variable

Source: https://docs.submagic.co/llms-full.txt

Example of accessing the API key from an environment variable in Node.js.

```javascript
const apiKey = process.env.SUBMAGIC_API_KEY;
```

--------------------------------

### Upload Project Request Example

Source: https://docs.submagic.co/llms-full.txt

Example of how to upload a project to the Submagic API.

```python
import requests
import json

def upload_project(video_path):
    url = "https://api.submagic.co/v1/projects"
    headers = {
        "X-Api-Key": "YOUR_API_KEY"
    }
    files = {
        'file': (video_path, open(video_path, 'rb'))
    }
    data = {
        'cleanAudio': 'true',
        'hookTitle': json.dumps({
            'text': 'Stop scrolling—watch this in 30 seconds',
            'template': 'tiktok',
            'top': 45,
            'size': 32
        }),
        'music': json.dumps({
            'userMediaId': '88a08eec-712a-45d0-8d0b-3b631700cb3a',
            'volume': 30,
            'startFromTime': 0,
            'fade': True
        })
    }

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

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

# Usage
project = upload_project('./video.mp4')
```

--------------------------------

### Response Example

Source: https://docs.submagic.co/llms-full.txt

Example of a successful response after creating a Magic Clips project.

```json
{
  "id": "e568c322-7fa5-497a-8fb0-3ba32e9e67d2",
  "title": "My Magic Clips Upload",
  "language": "en",
  "status": "processing",
  "webhookUrl": "https://yoursite.com/webhook/submagic",
  "templateName": "Hormozi 2",
  "userThemeId": null,
  "createdAt": "2025-09-24T12:55:56.989Z"
}
```

--------------------------------

### Example Requests

Source: https://docs.submagic.co/authentication

Examples of how to authenticate requests using cURL, JavaScript, and Python.

```bash
curl -X GET "https://api.submagic.co/v1/languages" \
  -H "x-api-key: sk-your-api-key-here"
```

```javascript
const response = await fetch("https://api.submagic.co/v1/languages", {
  headers: {
    "x-api-key": "sk-your-api-key-here",
  },
});
```

```python
import requests

headers = {
    'x-api-key': 'sk-your-api-key-here'
}

response = requests.get('https://api.submagic.co/v1/languages', headers=headers)
```

--------------------------------

### Get Languages Endpoint

Source: https://docs.submagic.co/llms-full.txt

Example of how to retrieve a list of all supported languages for video transcription using cURL.

```bash
GET https://api.submagic.co/v1/languages
```

--------------------------------

### cURL Request Example

Source: https://docs.submagic.co/api-reference/list-user-media

Example of how to list user media using cURL.

```bash
curl -X GET "https://api.submagic.co/v1/user-media?type=AUDIO&limit=10" \
    -H "x-api-key: sk-your-api-key-here"
```

--------------------------------

### Response Example

Source: https://docs.submagic.co/api-reference/user-media

Example of a successful response when creating user media.

```json
{
  "userMediaId": "88a08eec-712a-45d0-8d0b-3b631700cb3a"
}
```

--------------------------------

### JavaScript Example Request

Source: https://docs.submagic.co/llms-full.txt

Example of making a request to the /v1/languages endpoint using JavaScript.

```javascript
const response = await fetch("https://api.submagic.co/v1/languages", {
  headers: {
    "x-api-key": "sk-your-api-key-here",
  },
});
```

--------------------------------

### Python Example Request

Source: https://docs.submagic.co/llms-full.txt

Example of making a request to the /v1/languages endpoint using Python.

```python
import requests

headers = {
    'x-api-key': 'sk-your-api-key-here'
}

response = requests.get('https://api.submagic.co/v1/languages', headers=headers)
```

--------------------------------

### cURL Request Example

Source: https://docs.submagic.co/api-reference/user-media-upload

Example of uploading user media using cURL.

```bash
curl -X POST "https://api.submagic.co/v1/user-media/upload" \
    -H "x-api-key: sk-your-api-key-here" \
    -F "file=@./my-video.mp4"
```

--------------------------------

### Response Example: Processing with Transcription Complete

Source: https://docs.submagic.co/llms-full.txt

Example JSON response when a project is processing and transcription is complete.

```json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My Awesome Video",
  "description": "AI description of the project",
  "language": "en",
  "status": "processing",
  "webhookUrl": "https://yoursite.com/webhook/submagic",
  "templateName": "Hormozi 2",
  "transcriptionStatus": "COMPLETED",
  "magicZooms": true,
  "magicBrolls": true,
  "magicBrollsPercentage": 75,
  "removeSilencePace": "fast",
  "removeBadTakes": true,
  "videoMetaData": {
    "width": 1920,
    "height": 1080,
    "duration": 185.2,
    "fps": 30
  },
  "words": [
    {
      "id": "silence_f9164d70-ac39-41cc-ae31-5b9de3093a2f",
      "text": "",
      "type": "silence",
      "startTime": 0,
      "endTime": 0.08
    },
    {
      "id": "w1EydrN5",
      "text": "Do",
      "type": "word",
      "startTime": 0.08,
      "endTime": 0.16
    },
    {
      "id": "8VUdYfGN",
      "text": "you",
      "type": "word",
      "startTime": 0.16,
      "endTime": 0.24
    },
    {
      "id": "eZBH24RB",
      "text": "mind",
      "type": "word",
      "startTime": 0.24,
      "endTime": 0.32
    },
    {
      "id": "RFLElgda",
      "text": "if",
      "type": "word",
      "startTime": 0.32,
      "endTime": 0.4
    },
    {
      "id": "iTWC5pc9",
      "text": "we",
      "type": "word",
      "startTime": 0.4,

```

--------------------------------

### Empty Response Example

Source: https://docs.submagic.co/api-reference/list-user-media

Example of an empty response when no media is found.

```json
{
  "items": [],
  "hasMore": false
}
```

--------------------------------

### cURL Example Request

Source: https://docs.submagic.co/llms-full.txt

Example of making a request to the /v1/languages endpoint using cURL.

```bash
curl -X GET "https://api.submagic.co/v1/languages" \
  -H "x-api-key: sk-your-api-key-here"
```

--------------------------------

### Successful Response Example

Source: https://docs.submagic.co/api-reference/list-user-media

Example of a successful response when listing user media.

```json
{
  "items": [
    {
      "id": "88a08eec-712a-45d0-8d0b-3b631700cb3a",
      "type": "AUDIO",
      "fileName": "background-music.mp3",
      "url": "https://cdn.submagic.co/media/88a08eec-712a-45d0-8d0b-3b631700cb3a.mp3",
      "metadata": {
        "duration": 180.5,
        "fileSize": 4500000
      },
      "createdAt": "2024-01-10T08:00:00.000Z"
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "VIDEO",
      "fileName": "broll-clip.mp4",
      "url": "https://cdn.submagic.co/media/a1b2c3d4-e5f6-7890-abcd-ef1234567890.mp4",
      "metadata": {
        "width": 1920,
        "height": 1080,
        "duration": 12.3,
        "fileSize": 15000000
      },
      "createdAt": "2024-01-09T14:30:00.000Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "f5e4d3c2-b1a0-9876-fedc-ba0987654321"
}
```

--------------------------------

### Successful Response Example

Source: https://docs.submagic.co/api-reference/user-media-upload

Example of a successful response when uploading user media.

```json
{
  "userMediaId": "88a08eec-712a-45d0-8d0b-3b631700cb7v"
}
```

--------------------------------

### Update Project Request Examples

Source: https://docs.submagic.co/api-reference/update-project

Examples of how to update a project using cURL, JavaScript, and Python.

```bash
curl -X PUT "https://api.submagic.co/v1/projects/550e8400-e29b-41d4-a716-446655440000" \
    -H "x-api-key: sk-your-api-key-here" \
    -H "Content-Type: application/json" \
    -d '{
      "removeSilencePace": "fast",
      "removeBadTakes": true,
      "hookTitle": {
        "text": "New intro in 15 seconds",
        "template": "laura",
        "top": 40,
        "size": 28
      },
      "music": {
        "userMediaId": "88a08eec-712a-45d0-8d0b-3b631700cb3a",
        "volume": 25,
        "startFromTime": 10,
        "fade": true
      },
      "items": [
        {
          "type": "user-media",
          "startTime": 10.5,
          "endTime": 15.2,
          "userMediaId": "123e4567-e89b-12d3-a456-426614174000",
          "layout": "pip-top-right"
        },
        {
          "type": "ai-broll",
          "startTime": 25,
          "endTime": 31,
          "prompt": "smooth slider shot of a team collaborating in a modern studio",
          "layout": "split-50-50"
        }
      ]
    }'
```

```javascript
const updateProject = async (projectId, updateData) => {
    const response = await fetch(
      `https://api.submagic.co/v1/projects/${projectId}`,
      {
        method: "PUT",
        headers: {
          "x-api-key": "sk-your-api-key-here",
          "Content-Type": "application/json",
        },
        body: JSON.stringify(updateData),
      }
    );

    const result = await response.json();
    console.log("Project updated:", result.message);
    return result;
  };

  // Usage
  const updateData = {
    removeSilencePace: "fast",
    removeBadTakes: true,
    hookTitle: {
      text: "New intro in 15 seconds",
      template: "laura",
      top: 40,
      size: 28,
    },
    music: {
      userMediaId: "88a08eec-712a-45d0-8d0b-3b631700cb3a",
      volume: 25,
      startFromTime: 10,
      fade: true,
    },
    items: [
      {
        type: "user-media",
        startTime: 10.5,
        endTime: 15.2,
        userMediaId: "123e4567-e89b-12d3-a456-426614174000",
        layout: "pip-top-right",
      },
      {
        type: "ai-broll",
        startTime: 25,
        endTime: 31,
        prompt:
          "smooth slider shot of a team collaborating in a modern studio",
        layout: "split-50-50",
      },
    ],
  };

  const result = await updateProject(
    "550e8400-e29b-41d4-a716-446655440000",
    updateData
  );
```

```python
import json
import requests

def update_project(project_id, update_data):
    url = f'https://api.submagic.co/v1/projects/{project_id}'
    headers = {
        'x-api-key': 'sk-your-api-key-here',
        'Content-Type': 'application/json'
    }

    response = requests.put(url, headers=headers, json=update_data)
    result = response.json()

    print(f"Project updated: {result.get('message')}")
    return result

# Usage
update_data = {
    'removeSilencePace': 'fast',
    'removeBadTakes': True,
    'hookTitle': {
        'text': 'New intro in 15 seconds',
        'template': 'laura',
        'top': 40,
        'size': 28
    },
    'music': {
        'userMediaId': '88a08eec-712a-45d0-8d0b-3b631700cb3a',
        'volume': 25,
        'startFromTime': 10,
        'fade': True
    },
    'items': [
        {
            'type': 'user-media',
            'startTime': 10.5,
            'endTime': 15.2,
            'userMediaId': '123e4567-e89b-12d3-a456-426614174000',
            'layout': 'pip-top-right'
        },
        {
            'type': 'ai-broll',
            'startTime': 25,
            'endTime': 31,
            'prompt': 'smooth slider shot of a team collaborating in a modern studio',
            'layout': 'split-50-50'
        }
    ]
}

result = update_project('550e8400-e29b-41d4-a716-446655440000', update_data)
```

--------------------------------

### Example Request to Create a Project

Source: https://docs.submagic.co/introduction

This example demonstrates how to create a project using the Submagic API by providing a video URL and template name.

```bash
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 First Video",
    "language": "en",
    "videoUrl": "https://drive.google.com/video.mp4",
    "templateName": "Hormozi 2"
  }'
```

--------------------------------

### Get Templates

Source: https://docs.submagic.co/llms-full.txt

Retrieve a list of all available video templates for styling and effects

```bash
curl -X GET "https://api.submagic.co/v1/templates" \
    -H "x-api-key: sk-your-api-key-here"
```

```javascript
const response = await fetch("https://api.submagic.co/v1/templates", {
    headers: {
      "x-api-key": "sk-your-api-key-here",
    },
  });

  const data = await response.json();
  console.log(data.templates);
```

```python
import requests

headers = {
    'x-api-key': 'sk-your-api-key-here'
}

response = requests.get('https://api.submagic.co/v1/templates', headers=headers)
data = response.json()

print("Available templates:", data['templates'])
```

--------------------------------

### Get Project (Python)

Source: https://docs.submagic.co/api-reference/get-project

Example of how to fetch project details using Python's requests library.

```python
import requests

def get_project(project_id):
    url = f'https://api.submagic.co/v1/projects/{project_id}'
    headers = {
        'x-api-key': 'sk-your-api-key-here'
    }

    response = requests.get(url, headers=headers)
    project = response.json()

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

# Usage
project = get_project('550e8400-e29b-41d4-a716-446655440000')
```

--------------------------------

### Example Response

Source: https://docs.submagic.co/api-reference/hook-title-templates

Example response showing available hook title template names.

```json
{
  "templates": [
    "tiktok",
    "laura",
    "steph",
    "kevin",
    "kelly",
    "mark",
    "logan",
    "enrico",
    "mike",
    "devin",
    "hormozi",
    "masi",
    "ali"
  ]
}
```

--------------------------------

### Example Project Creation with Hook Title

Source: https://docs.submagic.co/api-reference/hook-title-templates

Example of how to specify a hook title template when creating or updating a project.

```json
{
  "hookTitle": {
    "text": "Stop scrolling—watch this in 30 seconds",
    "template": "tiktok",
    "top": 45,
    "size": 32
  }
}
```

--------------------------------

### URL-based Project

Source: https://docs.submagic.co/api-reference/templates

Example of creating a project with a template using a URL.

```json
{
  "title": "My Trendy Video",
  "language": "en",
  "videoUrl": "https://example.com/video.mp4",
  "templateName": "Hormozi 2"
}
```

--------------------------------

### File Upload Project

Source: https://docs.submagic.co/api-reference/templates

Example of creating a project with a template using file upload.

```json
{
  "title": "Professional Presentation",
  "language": "en",
  "templateName": "Hormozi 2",
  "file": "video.mp4"
}
```

--------------------------------

### Failed Project Response

Source: https://docs.submagic.co/api-reference/get-project

Example of a failed project status response, including the reason for failure.

```json
{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "My Awesome Video",
    "description": "AI description of the project",
    "language": "en",
    "status": "failed",
    "webhookUrl": "https://yoursite.com/webhook/submagic",
    "templateName": "Hormozi 2",
    "transcriptionStatus": "FAILED",
    "failureReason": "Video format not supported or file corrupted",
    "magicZooms": true,
    "magicBrolls": false,
    "magicBrollsPercentage": 50,
    "removeSilencePace": null,
    "removeBadTakes": false,
    "videoMetaData": {
      "width": 1920,
      "height": 1080,
      "duration": 185.2,
      "fps": 30
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:33:45.000Z"
  }
```

--------------------------------

### 429 Rate Limited Error Response

Source: https://docs.submagic.co/api-reference/hook-title-templates

Example response when the rate limit has been exceeded.

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

--------------------------------

### Create User Media using Python

Source: https://docs.submagic.co/api-reference/user-media

Example of how to create user media using Python.

```python
import requests

def create_user_media(media_url):
    url = 'https://api.submagic.co/v1/user-media'
    headers = {
        'x-api-key': 'sk-your-api-key-here',
        'Content-Type': 'application/json'
    }
    data = {
        'url': media_url
    }

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

    print(f"User media created: {result['userMediaId']}")
    return result

# Usage
media = create_user_media('https://example.com/media/sample-video.mp4')
```

--------------------------------

### Completed Magic Clips Project Response

Source: https://docs.submagic.co/api-reference/get-project

Example of a project completion response with generated magic clips.

```json
{
    "id": "e568c322-7fa5-497a-8fb0-3ba32e9e67d2",
    "title": "YT magic-clips test1",
    "description": "AI description of the project",
    "language": "en",
    "status": "completed",
    "webhookUrl": "https://webhook-test.com/6704c8535a2a913c3d094aba685d6a19",
    "previewUrl": "https://app.submagic.co/view/e568c322-7fa5-497a-8fb0-3ba32e9e67d3",
    "transcriptionStatus": "COMPLETED",
    "videoMetaData": {
      "width": 1920,
      "height": 1080,
      "duration": 283,
      "fps": 30
    },
    "magicClips": [
      {
        "id": "5c26f199-08dd-4fab-911f-5378c23cc103",
        "title": "Fusion Camera Technology",
        "duration": 24.8,
        "viralityScores": {
          "total": 87,
          "shareability": 22,
          "hook_strength": 21,
          "story_quality": 22,
          "emotional_impact": 22
        },
        "status": "completed",
        "previewUrl": "https://app.submagic.co/view/5c26f199-08dd-4fab-911f-5378c23cc104"
      }
    ]
  }
```

--------------------------------

### 400 Validation Error Response

Source: https://docs.submagic.co/api-reference/hook-title-templates

Example response for a validation error, such as an invalid template name.

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

--------------------------------

### Validation Error - End Time

Source: https://docs.submagic.co/api-reference/update-project

Example of a validation error when the end time is not greater than the start time.

```json
{
    "error": "VALIDATION_ERROR",
    "message": "endTime must be greater than startTime"
  }
```

--------------------------------

### Completed Project Response

Source: https://docs.submagic.co/api-reference/get-project

Example of a successful project completion response, including transcription data and video metadata.

```json
{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "My Awesome Video",
    "description": "AI description of the project",
    "language": "en",
    "status": "completed",
    "webhookUrl": "https://yoursite.com/webhook/submagic",
    "userThemeId": "730e9500-f29c-52e5-b826-556755550001",
    "downloadUrl": "https://api.submagic.co/download/550e8400-e29b-41d4-a716-446655440000",
    "directUrl": "https://dqu1p08d61fh.cloudfront.net/api/9cc52d00-43d7-442f-9a22-050312bkm24f/1ddee5b4-101f-4c1e-a74a-b6b3bcfe206c/video.mp4-download.mp4",
    "previewUrl": "https://app.submagic.co/view/550e8400-e29b-41d4-a716-446655440000",
    "transcriptionStatus": "COMPLETED",
    "magicZooms": false,
    "magicBrolls": true,
    "magicBrollsPercentage": 30,
    "removeSilencePace": "natural",
    "removeBadTakes": false,
    "videoMetaData": {
      "width": 1920,
      "height": 1080,
      "duration": 185.2,
      "fps": 30
    },
    "words": [
      {
        "id": "silence_f9164d70-ac39-41cc-ae31-5b9de3093a2f",
        "text": "",
        "type": "silence",
        "startTime": 0,
        "endTime": 0.08
      },
      {
        "id": "w1EydrN5",
        "text": "Do",
        "type": "word",
        "startTime": 0.08,
        "endTime": 0.16
      },
      {
        "id": "8VUdYfGN",
        "text": "you",
        "type": "word",
        "startTime": 0.16,
        "endTime": 0.24
      },
      {
        "id": "eZBH24RB",
        "text": "mind",
        "type": "word",
        "startTime": 0.24,
        "endTime": 0.32
      },
      {
        "id": "RFLElgda",
        "text": "if",
        "type": "word",
        "startTime": 0.32,
        "endTime": 0.4
      },
      {
        "id": "iTWC5pc9",
        "text": "we",
        "type": "word",
        "startTime": 0.4,
        "endTime": 0.52
      },
      {
        "id": "EpT23tSM",
        "text": "do",
        "type": "word",
        "startTime": 0.52,
        "endTime": 0.68
      },
      {
        "id": "KtVZ8VDN",
        "text": "something",
        "type": "word",
        "startTime": 0.68,
        "endTime": 0.84
      },
      {
        "id": "LtVZ8CM",
        "text": "?",
        "type": "punctuation",
        "startTime": 0.84,
        "endTime": 0.84
      }
    ],
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:45:30.000Z"
  }
```

--------------------------------

### Get Hook Title Templates (cURL)

Source: https://docs.submagic.co/llms-full.txt

Example of how to retrieve available hook title template names using cURL.

```bash
curl -X GET "https://api.submagic.co/v1/hook-title/templates" \
    -H "x-api-key: sk-your-api-key-here"
```

--------------------------------

### 401 Unauthorized Error Response

Source: https://docs.submagic.co/api-reference/hook-title-templates

Example response for an unauthorized request due to an invalid or missing API key.

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

--------------------------------

### Example Project Creation with Hook Title

Source: https://docs.submagic.co/llms-full.txt

Example of how to specify a hook title template when creating or updating a project.

```json
"hookTitle": {
    "text": "Stop scrolling—watch this in 30 seconds",
    "template": "tiktok",
    "top": 45,
    "size": 32
  }
```
Tokens:
Raw