Vizard AI

https://docs.vizard.ai/docs/
Admin
Vizard AI is an API platform that enables developers to automatically transform long-form videos...
Tokens:9,826
Snippets:98
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Create a Vizard AI project via API

Source: https://docs.vizard.ai/docs/advanced

Examples of how to send a POST request to the project creation endpoint using various programming languages.

```curl
curl -X POST https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create \
  -H "Content-Type: application/json" \
  -H "VIZARDAI_API_KEY: YOUR_API_KEY" \
  -d '{
    "lang": "en",
    "preferLength": [0],
    "videoUrl": "https://www.youtube.com/watch?v=OqLfw-TzzfI",
    "videoType": 2,
    "ratioOfClip": 1,
    "templateId": 52987165,
    "removeSilenceSwitch": 0,
    "maxClipNumber": 10,
    "keyword": "AI, spark, vizard",
    "subtitleSwitch": 1,
    "headlineSwitch": 1,
    "clipModel": "clip_v2",
    "projectName": "Introducing Spark 1.0 - Clip any video with a simple prompt now!"
  }'
```

```python
import requests

url = "https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create"
headers = {
    "Content-Type": "application/json",
    "VIZARDAI_API_KEY": "YOUR_API_KEY"
}

data = {
    "lang": "en",
    "preferLength": [0],
    "videoUrl": "https://www.youtube.com/watch?v=OqLfw-TzzfI",
    "videoType": 2,
    "ratioOfClip": 1,
    "templateId": 52987165,
    "removeSilenceSwitch": 0,
    "maxClipNumber": 10,
    "keyword": "AI, spark, vizard",
    "subtitleSwitch": 1,
    "headlineSwitch": 1,
    "projectName": "Introducing Spark 1.0 - Clip any video with a simple prompt now!"
}

response = requests.post(url, headers=headers, json=data)
print(response.status_code)
print(response.json())
```

```typescript
import axios from 'axios';

const url = 'https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create';

const headers = {
  'Content-Type': 'application/json',
  'VIZARDAI_API_KEY': 'YOUR_API_KEY'
};

const data = {
  lang: 'en',
  preferLength: [0],
  videoUrl: 'https://www.youtube.com/watch?v=OqLfw-TzzfI',
  videoType: 2,
  ratioOfClip: 1,
  templateId: 52987165,
  removeSilenceSwitch: 0,
  maxClipNumber: 10,
  keyword: 'AI, spark, vizard',
  subtitleSwitch: 1,
  headlineSwitch: 1,
  projectName: 'Introducing Spark 1.0 - Clip any video with a simple prompt now!'
};

axios.post(url, data, { headers })
  .then(res => {
    console.log(res.status);
    console.log(res.data);
  })
  .catch(err => {
    console.error(err.response?.data || err.message);
  });
```

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

### GET /hvizard-server-front/open-api/v1/project/query/{projectId}

Source: https://docs.vizard.ai/docs/quickstart

Retrieves the status and metadata of a video processing project using its unique project ID.

```APIDOC
## GET /hvizard-server-front/open-api/v1/project/query/{projectId}

### Description
Checks the status of a video processing project. It is recommended to poll this endpoint every 30 seconds until the clips are ready.

### Method
GET

### Endpoint
https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/query/{projectId}

### Parameters
#### Path Parameters
- **projectId** (string) - Required - The unique identifier returned from the project creation request.
```

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

### Example JSON Response

Source: https://docs.vizard.ai/docs/generate-ai-social-caption

A successful response containing the generated social media caption text.

```json
{
  "code": 2000,
  "aiSocialContent": "Unlock your creativity and elevate your video-making skills with Spark 1.0! 🚀✨ Whether you're a seasoned creator or just starting out, this next-gen video understanding model simplifies the way you edit and share your content. With just a prompt, you can clip your videos like a pro! 🎥💡

Discover how to easily transform your video links from platforms like YouTube, Google Drive, and Vimeo, or simply drag and drop your files. The Clip It Your Way feature opens up endless possibilities for customization—just input any prompt and watch the magic unfold! 🌟

Join our amazing community on Discord, filled with fellow creators, marketers, and industry experts who are all here to exchange ideas and help you refine your craft. 🎉 Plus, learn how to format your videos for social media in just seconds—making them perfectly ready for TikTok, Instagram Reels, and more!

Ready to take the leap? Streamline your workflow and share your brilliance directly on platforms like Facebook, Twitter, and LinkedIn in no time! 🌐🔥 

#VideoEditing #AI #ContentCreation #Vizard #Spark1.0 #SocialMediaMarketing #VideoEditingTips #TikTok #InstagramReels #YouTubeShorts #ContentCreators #JoinUs #VideoOptimization #CreatorCommunity"
}
```

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

### GET /hvizard-server-front/open-api/v1/project/social-accounts

Source: https://docs.vizard.ai/docs/retrieve-social-accounts

Retrieves a list of all social accounts connected to the user's Vizard workspace, including their status and platform details.

```APIDOC
## GET /hvizard-server-front/open-api/v1/project/social-accounts

### Description
Returns a list of social accounts connected to your Vizard workspace. Use the returned `id` when publishing videos to a specific platform.

### Method
GET

### Endpoint
https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/social-accounts

### Request Example
curl -X GET "https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/social-accounts" \
  -H "VIZARDAI_API_KEY: YOUR_API_KEY"

### Response
#### Success Response (200)
- **publishAccounts** (array) - Each object represents a connected social account.
- **total** (number) - Total count of social accounts.

#### Response Example
{
  "publishAccounts": [
    {
      "id": "12345",
      "platform": "Instagram",
      "username": "user123",
      "page": "pagename",
      "profilePic": "https://example.com/profile.jpg",
      "pageProfilePic": "https://example.com/profile.jpg",
      "expiresAt": 1712956800,
      "status": "active"
    }
  ],
  "total": 10
}
```

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

### Retrieve Project Status and Videos via cURL

Source: https://docs.vizard.ai/docs/retrieve-video-clips

Use this GET request to poll the status of a project and retrieve generated video metadata. Replace {projectId} with the ID received during submission.

```curl
curl -X GET "https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/query/{projectId}" \
     -H "VIZARDAI_API_KEY: YOUR_API_KEY"
```

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

### Retrieve Clips via Polling

Source: https://docs.vizard.ai/docs/quickstart

Check the status of a project by sending a GET request with the projectId. It is recommended to poll at 30-second intervals.

```curl
curl -X GET https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/query/{projectId} \
  -H "VIZARDAI_API_KEY: YOUR_API_KEY"
```

```python
import requests

headers = {
    "VIZARDAI_API_KEY": "YOUR_API_KEY"
}

project_id = "your_project_id"
response = requests.get(
    f"https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/query/{project_id}",
    headers=headers
)

print(response.json())
```

```typescript
import axios from 'axios';

const headers = {
  'VIZARDAI_API_KEY': 'YOUR_API_KEY'
};

const projectId = 'your_project_id';

axios.get(`https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/query/${projectId}`, { headers })
  .then(res => console.log(res.data))
  .catch(err => console.error(err));
```

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

### Social accounts response structure

Source: https://docs.vizard.ai/docs/retrieve-social-accounts

Example JSON response containing the list of publishable social accounts and the total count.

```json
{
  "publishAccounts": [
    {
      "id": "12345",
      "platform": "Instagram",
      "username": "user123",
      "page": "pagename",
      "profilePic": "https://example.com/profile.jpg",
      "pageProfilePic": "https://example.com/profile.jpg",
      "expiresAt": 1712956800,
      "status": "active"
    }
  ],
  "total": 10
}
```

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

### POST /hvizard-server-front/open-api/v1/project/create

Source: https://docs.vizard.ai/docs/basic

Creates a new project by submitting a video URL for processing. The 'lang' parameter specifies the spoken language in the video, which can be set to 'auto' or a specific ISO 639-1 code.

```APIDOC
## POST /hvizard-server-front/open-api/v1/project/create

### Description
Creates a new project in Vizard AI by providing a video URL and configuration settings.

### Method
POST

### Endpoint
https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create

### Request Body
- **lang** (string) - Required - The spoken language in the video (e.g., 'auto', 'en', 'es', 'pt', 'fr', 'de', 'ru').
- **preferLength** (array) - Required - Configuration for preferred video length.
- **videoUrl** (string) - Required - The URL of the video to be processed.
- **videoType** (integer) - Required - The type of video being submitted.

### Request Example
{
  "lang": "en",
  "preferLength": [0],
  "videoUrl": "https://www.youtube.com/watch?v=OqLfw-TzzfI",
  "videoType": 2
}
```

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

### Project Configuration Parameters

Source: https://docs.vizard.ai/docs/advanced

Parameters used to configure project settings for video clipping.

```APIDOC
## Project Configuration Parameters

### Description
These parameters allow users to customize the behavior of the video clipping process, including enabling AI features and setting project metadata.

### Parameters
- **highlightSwitch** (integer) - Optional - Controls auto highlight keywords in subtitles. 1: Enabled, 0: Disabled (default).
- **autoBrollSwitch** (integer) - Optional - Enables auto B-roll function. 1: Enabled, 0: Disabled (default).
- **headlineSwitch** (integer) - Optional - Controls whether an AI-generated headline is added to the clip. 1: Enabled (default), 0: Disabled.
- **projectName** (string) - Optional - Sets a custom name for the clipping project. Defaults to the source filename or video title if not provided.
```

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

### POST /project/create Response

Source: https://docs.vizard.ai/docs/response

Describes the JSON response structure returned upon successful submission of a video project creation request.

```APIDOC
## POST /project/create

### Description
Returns the status and project identification details after a video submission request is accepted.

### Response
#### Success Response (2000)
- **code** (int) - Status code of the request.
- **projectId** (string) - Unique ID of the project used to poll or retrieve clips.
- **shareLink** (string) - Shareable link to the project (only available for Business/Team plan users).
- **errMsg** (string) - Error message, shown only when code is not 2000.

#### Response Example
{
  "code": 2000,
  "projectId": 17861706,
  "shareLink": "https://vizard.ai/project?invite=BW77vF&susId=1862&utm_source=project_share&utm_medium=project_share_email&utm_campaign=project_share_email",
  "errMsg": ""
}
```

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

### POST /hvizard-server-front/open-api/v1/project/create

Source: https://docs.vizard.ai/docs/quickstart

Submits a video for processing to generate clips. This endpoint returns a projectId used for tracking the status of the request.

```APIDOC
## POST /hvizard-server-front/open-api/v1/project/create

### Description
Submits a video for processing to generate clips. The API supports various sources including remote files, YouTube, Google Drive, Vimeo, and StreamYard.

### Method
POST

### Endpoint
https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create

### Request Body
- **lang** (string) - Required - The language of the video content.
- **preferLength** (array) - Required - Preferred length settings for clips.
- **videoUrl** (string) - Required - The URL of the video to be processed.
- **videoType** (integer) - Required - The type identifier for the video source.

### Request Example
{
  "lang": "en",
  "preferLength": [0],
  "videoUrl": "https://www.youtube.com/watch?v=OqLfw-TzzfI",
  "videoType": 2
}
```

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

### POST /project/create

Source: https://docs.vizard.ai/docs/submit-a-long-video

Submits a long-form video for processing. Users must provide the video URL, clip duration, aspect ratio, and template preferences.

```APIDOC
## POST /project/create

### Description
Submits a long-form video to the platform to begin the automated clipping process.

### Method
POST

### Endpoint
/project/create

### Request Body
- **video_url** (string) - Required - The URL of the long-form video to be processed.
- **clip_duration** (string) - Required - The preferred duration for the generated clips.
- **aspect_ratio** (string) - Required - The desired aspect ratio for the output clips.
- **template** (string) - Required - The custom template to be applied to the clips.
```

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

### Specify Video File Extension

Source: https://docs.vizard.ai/docs/submit-a-short-video-for-editing

Required only when videoType is set to 1 for direct video files.

```json
"ext": "mp4"
```

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

### Optional Vizard API Parameters

Source: https://docs.vizard.ai/docs/submit-a-short-video-for-editing

Use these parameters to customize video output, such as enabling subtitles, emojis, or specifying a template ID.

```json
{
    "ratioOfClip": 1,
    "subtitleSwitch": 1,
    "emojiSwitch": 0,
    "highlightSwitch": 1,
    "autoBrollSwitch": 1,
    "headlineSwitch": 1,
    "removeSilenceSwitch": 1,
    "templateId": 52987165,
    "projectName": "My Edited Video Project"
}
```

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

### Project Creation JSON Response

Source: https://docs.vizard.ai/docs/response

The standard JSON object returned after a successful request to the project creation endpoint.

```json
{
  "code": 2000,
  "projectId": 17861706,
  "shareLink": "https://vizard.ai/project?invite=BW77vF&susId=1862&utm_source=project_share&utm_medium=project_share_email&utm_campaign=project_share_email",
  "errMsg": ""
}
```

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

### Submit a Video for Clipping

Source: https://docs.vizard.ai/docs/quickstart

Initiate video processing by sending a POST request with the video URL and configuration. The response includes a projectId required for subsequent status checks.

```curl
curl -X POST https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create \
  -H "Content-Type: application/json" \
  -H "VIZARDAI_API_KEY: YOUR_API_KEY" \
  -d '{
    "lang": "en",
    "preferLength": [0],
    "videoUrl": "https://www.youtube.com/watch?v=OqLfw-TzzfI",
    "videoType": 2
  }'
```

```python
import requests

headers = {
    "Content-Type": "application/json",
    "VIZARDAI_API_KEY": "YOUR_API_KEY"
}

data = {
    "lang": "en",
    "preferLength": [0],
    "videoUrl": "https://www.youtube.com/watch?v=OqLfw-TzzfI",
    "videoType": 2
}

response = requests.post(
    "https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create",
    headers=headers,
    json=data
)

print(response.json())
```

```typescript
import axios from 'axios';

const headers = {
  'Content-Type': 'application/json',
  'VIZARDAI_API_KEY': 'YOUR_API_KEY'
};

const payload = {
  lang: 'en',
  preferLength: [0],
  videoUrl: 'https://www.youtube.com/watch?v=OqLfw-TzzfI',
  videoType: 2
};

axios.post('https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/create', payload, { headers })
  .then(res => console.log(res.data))
  .catch(err => console.error(err));
```

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

### POST /hvizard-server-front/open-api/v1/project/ai-social

Source: https://docs.vizard.ai/docs/generate-ai-social-caption

Generates an AI-written social media caption for a specified video clip.

```APIDOC
## POST /hvizard-server-front/open-api/v1/project/ai-social

### Description
Generates an AI-written social media caption for a specified video clip. This endpoint is designed for videos containing spoken dialogue.

### Method
POST

### Endpoint
https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/ai-social

### Parameters
#### Request Body
- **finalVideoId** (long) - Required - The exported video ID from the previous step.
- **aiSocialPlatform** (int) - Optional - Target platform style: 1 = General (default), 2 = TikTok, 3 = Instagram, 4 = YouTube, 5 = Facebook, 6 = LinkedIn, 7 = Twitter.
- **tone** (int) - Optional - Caption tone: 0 = Neutral (default), 1 = Interesting, 2 = Catchy, 3 = Serious, 4 = Question.
- **voice** (int) - Optional - Voice style: 0 = First person (default), 1 = Third person.

### Request Example
{
  "finalVideoId": 14015572,
  "aiSocialPlatform": 2,
  "tone": 2,
  "voice": 0
}
```

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

### POST /hvizard-server-front/open-api/v1/project/publish-video

Source: https://docs.vizard.ai/docs/publish-clips-to-social-media

Publishes a generated video clip to a specified social media account. You can optionally schedule the post or provide custom captions and titles.

```APIDOC
## POST /hvizard-server-front/open-api/v1/project/publish-video

### Description
Publish a generated clip to a connected social account. Vizard automatically creates the post caption and relevant hashtags if not provided.

### Method
POST

### Endpoint
https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/publish-video

### Parameters
#### Request Body
- **finalVideoId** (long) - Required - The ID of the generated video.
- **publishTime** (long) - Optional - Unix timestamp for scheduled publishing. If not set, the video is published immediately.
- **socialAccountId** (String) - Required - The ID of the connected social account.
- **post** (String) - Optional - Video description for the social post.
- **title** (String) - Optional - YouTube video title. Only used for YouTube.

### Request Example
{
  "finalVideoId": 14015572,
  "publishTime": 1767605047792,
  "socialAccountId": "123456",
  "post": "Your post content here",
  "title": "Your YouTube title here"
}

### Response
#### Success Response (200)
- **code** (int) - Status code of the request (2000 for success).

#### Response Example
{
  "code": 2000
}
```

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

### Project Query API Response Structure

Source: https://docs.vizard.ai/docs/retrieve-video-clips

The JSON response returned by the project query endpoint, containing project metadata and a list of generated video objects.

```json
{
  "code": 2000,
  "shareLink": "https://vizard.ai/project?invite=BW77vF&susId=1862&utm_source=project_share&utm_medium=project_share_email&utm_campaign=project_share_email",
  "videos": [
    {
      "videoId": 14015572,
      "videoUrl": "https://cdn-video.vizard.ai/vizard/video/export/...",
      "videoMsDuration": 80400,
      "title": "Transform Content Creation with Spark 1.0's AI Video Editing",
      "transcript": "Hi, we're here with Vizard...",
      "viralScore": "10",
      "viralReason": "This clip leverages the appeal of AI technology...",
      "relatedTopic": "[]",
      "clipEditorUrl": "https://vizard.ai/editor?id=99058552&type=clip"
    },
    ...
  ],
    "projectId": 17861706,
    "projectName" : "My first project"
}
```

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

### Disable Clip Mode for Editing

Source: https://docs.vizard.ai/docs/submit-a-short-video-for-editing

Set getClips to 0 to instruct Vizard to perform editing on the provided video rather than generating new clips.

```json
"getClips": 0
```

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

### Set Video Language

Source: https://docs.vizard.ai/docs/submit-a-short-video-for-editing

Configure the language for transcription and subtitles using auto-detection or specific ISO 639-1 codes.

```json
"lang": "auto"
```

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

### Editing Request Parameters

Source: https://docs.vizard.ai/docs/submit-a-short-video-for-editing

A summary of the required and optional parameters used to configure a video editing request.

```APIDOC
## Editing Request Parameters

### Description
This request structure is used to submit a video for processing. It combines mandatory source information with optional customization flags for editing features.

### Parameters
#### Request Body
- **getClips** (integer) - Required - Flag to determine if clips should be generated.
- **videoUrl** (string) - Required - The URL of the source video.
- **videoType** (integer) - Required - The type identifier for the source video.
- **lang** (string) - Required - The language setting for the video (e.g., "auto").
- **ratioOfClip** (integer) - Optional - The aspect ratio setting for the output.
- **subtitleSwitch** (integer) - Optional - Toggle for subtitle generation.
- **emojiSwitch** (integer) - Optional - Toggle for emoji inclusion.
- **highlightSwitch** (integer) - Optional - Toggle for highlight generation.
- **autoBrollSwitch** (integer) - Optional - Toggle for automated B-roll insertion.
- **headlineSwitch** (integer) - Optional - Toggle for headline generation.
- **removeSilenceSwitch** (integer) - Optional - Toggle for silence removal.
- **templateId** (integer) - Optional - The ID of the template to apply.
- **projectName** (string) - Optional - The name for the resulting project.

### Request Example
{
    "getClips": 0,
    "videoUrl": "https://www.youtube.com/watch?v=OqLfw-TzzfI",
    "videoType": 1,
    "lang": "auto",
    "ratioOfClip": 1,
    "subtitleSwitch": 1,
    "emojiSwitch": 0,
    "highlightSwitch": 1,
    "autoBrollSwitch": 1,
    "headlineSwitch": 1,
    "removeSilenceSwitch": 1,
    "templateId": 52987165,
    "projectName": "My Edited Video Project"
}
```

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

### Publish a video clip via cURL

Source: https://docs.vizard.ai/docs/publish-clips-to-social-media

Sends a POST request to publish a video. Omit the publishTime parameter to publish immediately, and use the title field only for YouTube uploads.

```curl
curl -X POST "https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/publish-video" \
  -H "Content-Type: application/json" \
  -H "VIZARDAI_API_KEY: YOUR_API_KEY" \
  -d '{
    "finalVideoId": 14015572,
    "publishTime": 1767605047792,
    "socialAccountId": "123456",
    "post": "Your post content here",
    "title": "Your YouTube title here"
  }'
```

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

### Submit Video for Editing

Source: https://docs.vizard.ai/docs/submit-a-short-video-for-editing

Configures the API request to process a short video for editing by disabling clip generation and specifying source details.

```APIDOC
## Submit Video for Editing

### Description
Submit a short video (under 3 minutes) to Vizard for editing tasks. Ensure `getClips` is set to 0 to enable edit mode.

### Request Body
- **getClips** (integer) - Required - Set to 0 to enable edit mode.
- **videoUrl** (string) - Required - The URL of the video source.
- **videoType** (integer) - Required - The platform type of the video (1: Remote file, 2: YouTube, 3: Google Drive, 4: Vimeo, 5: StreamYard, 6: TikTok, 7: Twitter, 9: Twitch, 10: Loom, 11: Facebook, 12: LinkedIn).
- **ext** (string) - Required for videoType 1 - The file extension (mp4, 3gp, avi, mov).
- **lang** (string) - Required - The language spoken in the video (e.g., 'auto', 'en', 'es', 'pt', 'fr', 'de', 'ru').

### Request Example
{
  "getClips": 0,
  "videoUrl": "https://example.com/video.mp4",
  "videoType": 1,
  "ext": "mp4",
  "lang": "en"
}
```

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

### ratioOfClip Parameter

Source: https://docs.vizard.ai/docs/advanced

The ratioOfClip parameter defines the aspect ratio of the generated video clips.

```APIDOC
## ratioOfClip Parameter

### Description
Controls the output video shape for all generated clips. You can choose one format per request.

### Parameters
#### Request Body
- **ratioOfClip** (integer) - Optional - The aspect ratio of the video: 1 (9:16 Vertical), 2 (1:1 Square), 3 (4:5 Portrait), 4 (16:9 Horizontal).
```

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

### preferLength Parameter

Source: https://docs.vizard.ai/docs/basic

The preferLength parameter defines the target duration for output clips. It accepts an array of integers representing specific duration categories or 0 for automatic selection.

```APIDOC
## preferLength Parameter

### Description
Controls the target length of each short video generated by Vizard. Users can specify a single duration category or a range of categories.

### Parameters
- **preferLength** (array of integers) - Required - Specifies the desired clip duration. 
  - 0: Automatically chosen
  - 1: Less than 30 seconds
  - 2: 30 to 60 seconds
  - 3: 60 to 90 seconds
  - 4: 90 seconds to 3 minutes

### Usage Examples
- `preferLength: [1]` (Ultra-short clips <30s)
- `preferLength: [2, 3]` (Medium-length clips 30s–90s)
- `preferLength: [0]` (Auto mode)

### Notes
- 0 (auto mode) cannot be combined with other values (e.g., [0, 1] is invalid).
```

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

### Successful API response

Source: https://docs.vizard.ai/docs/publish-clips-to-social-media

Indicates that the publish request was processed successfully.

```json
{
  "code": 2000
}
```

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

### Required Vizard API Parameters

Source: https://docs.vizard.ai/docs/submit-a-short-video-for-editing

These parameters are mandatory for every editing request sent to the Vizard API.

```json
{
    "getClips": 0,
    "videoUrl": "https://www.youtube.com/watch?v=OqLfw-TzzfI",
    "videoType": 1,
    "lang": "auto"
}
```

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

### List social accounts via cURL

Source: https://docs.vizard.ai/docs/retrieve-social-accounts

Retrieves a list of connected social accounts using an API key for authentication.

```curl
curl -X GET "https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/social-accounts" \
  -H "VIZARDAI_API_KEY: YOUR_API_KEY"
```

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

### maxClipNumber

Source: https://docs.vizard.ai/docs/advanced

Sets the maximum number of clips to return from a long video.

```APIDOC
## maxClipNumber

### Description
Sets the maximum number of clips to return from a long video. This acts as an upper limit; if not included, all clips are returned.

### Parameters
- **maxClipNumber** (integer) - Optional - Range: 1 to 100.
```

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

### templateId Parameter

Source: https://docs.vizard.ai/docs/advanced

The templateId parameter allows you to apply a custom template created in the Vizard web interface to your generated clips.

```APIDOC
## templateId Parameter

### Description
Applies a custom template to the generated clips, controlling subtitle styling, headlines, logos, and branding elements. The template ratio must match the ratioOfClip parameter.

### Parameters
#### Request Body
- **templateId** (string) - Optional - The unique identifier for the template, found in the Vizard video editor 'Template' tab.
```

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

### Generate AI Social Caption Request

Source: https://docs.vizard.ai/docs/generate-ai-social-caption

Use this cURL request to generate a caption for a specific video ID by providing platform, tone, and voice parameters.

```curl
curl -X POST "https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/ai-social" \
  -H "Content-Type: application/json" \
  -H "VIZARDAI_API_KEY: YOUR_API_KEY" \
  -d '{
        "finalVideoId": 14015572,
        "aiSocialPlatform": 2,
        "tone": 2,
        "voice": 0
      }'
```

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

### removeSilenceSwitch

Source: https://docs.vizard.ai/docs/advanced

Controls whether silent gaps and filler words are removed from the final clips.

```APIDOC
## removeSilenceSwitch

### Description
Controls whether silent gaps and filler words (like “um”, “uh”) are removed from your final clips. When enabled, Vizard will automatically trim unnecessary pauses and filter filler words.

### Parameters
- **removeSilenceSwitch** (integer) - Optional - 0 (default) to disable, 1 to enable.
```
Tokens:
Raw