> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.simplified.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.simplified.com/_mcp/server.

# Media · Video · Generate a video from a script

POST https://api.simplified.com/api/v1/tools/script-to-video
Content-Type: application/json

Creates a full video from a text script with voiceover, visuals, and captions.
Returns a task_id.

Generation costs credits. Poll getTaskResult until SUCCESS, then read result.export_id. If should_export=true, poll getVideoExport separately until status=3; download URLs are returned in assets.urls. Task SUCCESS alone does not mean the MP4 export is ready.


Reference: https://docs.simplified.com/api-reference/video-tools/generate/script-to-video

## Authentication

- `Authorization` header (required) (prefixed with ` Api-Key   `) — Header authentication of the form `Api-Key  <token>`
- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects an object.

- `payload` (ApiV1ToolsScriptToVideoPostRequestBodyContentApplicationJsonSchemaPayload, required)
- `should_export` (boolean, optional, default: true) — Whether to export the final video file.

## Response

### 202

Async task queued.

- `task_id` (string, optional) — Poll GET /api/v1/tasks/\{task\_id} until SUCCESS or FAILURE.

## Types

### ApiV1ToolsScriptToVideoPostRequestBodyContentApplicationJsonSchemaPayload

- `title` (string, required) — Script title or main topic.
- `description` (string, required) — Required full narration script, read verbatim for the voiceover.
- `keywords` (string, optional) — Comma-separated keywords to guide visuals.
- `tone` (enum, optional) — Tone of the generated video.
  - Allowed values: `professional`, `informal`, `optimistic`, `pessimistic`, `joyful`, `sad`, `sincere`, `hypocritical`, `fearful`, `hopeful`, `happy`, `serious`
- `creativity_level` (double, optional) — Creative freedom level (higher = more creative).
- `language_code` (string, optional) — Language for voiceover and captions (e.g. "en").
- `voice_id` (string, optional) — Voice ID for the AI voiceover.
- `format` (enum, optional) — Composition layout; mp4 is a compatibility alias for youtube-shorts.
  - Allowed values: `youtube-shorts`, `youtube-video`, `instagram-post-video`, `mp4`
- `no_runs` (integer, optional) — Number of video variations to generate.
- `logo_id` (string, optional) — Legacy alias for brand_kit_config.logo_id; canonical configuration takes precedence.
- `caption_style_id` (string, optional) — Legacy brand caption-style UUID alias for brand_kit_config.caption_style_id. For inline styling use caption_style.
- `media_source_config` (MediaSourceConfig, optional) — Choose stock footage, stock images, AI images, AI video clips, or uploaded assets. AI-generated visuals consume additional credits.
- `brand_kit_config` (BrandKitConfig, optional)
- `enable_captions` (boolean, optional, default: true)
- `caption_style` (CaptionStyle, optional)
- `assets` (list of CustomVideoMedia, optional) — Required when media_source_config.type=custom. Visuals are selected from these media URLs.

### MediaSourceConfig

Choose stock footage, stock images, AI images, AI video clips, or uploaded assets. AI-generated visuals consume additional credits.

- `type` (enum, required, default: stock_videos)
  - Allowed values: `stock_videos`, `stock_images`, `ai_images`, `ai_videos`, `custom`
- `mode` (enum, optional, default: speed) — For ai_videos: speed or quality mode.
  - Allowed values: `speed`, `quality`

### BrandKitConfig

- `logo_id` (string, optional, nullable)
- `caption_style_id` (string, optional, nullable)

### CaptionStyle

- `type` (string, optional, nullable)
- `id` (integer, optional, nullable)
- `extras` (map from string to any, optional, nullable)
- `fontFamily` (string, optional, nullable)
- `fontWeight` (integer, optional, nullable)

### CustomVideoMedia

- `mime` (enum, required)
  - Allowed values: `image`, `video`
- `source_url` (string, required) — Public URL of uploaded image/video to use as a visual.
- `start_time` (double, optional, default: 0) — Optional start offset in milliseconds for video visuals.

## Examples

**Request**

```json
{
  "payload": {
    "title": "string",
    "description": "string"
  }
}
```

**Response**

```json
{
  "task_id": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.simplified.com/api/v1/tools/script-to-video"

payload = { "payload": {
        "title": "string",
        "description": "string"
    } }
headers = {
    "Authorization": "Api-Key  <apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.simplified.com/api/v1/tools/script-to-video';
const options = {
  method: 'POST',
  headers: {Authorization: 'Api-Key  <apiKey>', 'Content-Type': 'application/json'},
  body: '{"payload":{"title":"string","description":"string"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.simplified.com/api/v1/tools/script-to-video"

	payload := strings.NewReader("{\n  \"payload\": {\n    \"title\": \"string\",\n    \"description\": \"string\"\n  }\n}")

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

	req.Header.Add("Authorization", "Api-Key  <apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.simplified.com/api/v1/tools/script-to-video")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Api-Key  <apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payload\": {\n    \"title\": \"string\",\n    \"description\": \"string\"\n  }\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.simplified.com/api/v1/tools/script-to-video")
  .header("Authorization", "Api-Key  <apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payload\": {\n    \"title\": \"string\",\n    \"description\": \"string\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.simplified.com/api/v1/tools/script-to-video', [
  'body' => '{
  "payload": {
    "title": "string",
    "description": "string"
  }
}',
  'headers' => [
    'Authorization' => 'Api-Key  <apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.simplified.com/api/v1/tools/script-to-video");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Api-Key  <apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"payload\": {\n    \"title\": \"string\",\n    \"description\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Api-Key  <apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["payload": [
    "title": "string",
    "description": "string"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.simplified.com/api/v1/tools/script-to-video")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```