Outline to video

This endpoint creates a video directly from your provided outline and selected background footage. Once the video is generated, you’ll receive a unique identifier (apiFileId). Use this apiFileId with the GET /get-file endpoint to monitor the export status—the process typically takes about as long as the video's duration.

Alternatively, you can supply a webhook URL to automatically receive export status updates, eliminating the need to manually poll the GET /get-file endpoint.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

outline

object (Outline)

required

The outline of the video.

sections

array[object (Section) {6}]

required

Sections of the video.

useGetty

boolean

optional

Option to include Getty/iStock assets, if available.

Default:

false

useGenerativeImage

boolean

optional

Option to include generative images.

Default:

false

imageGenStyle

string

optional

Style used for the generative images.

Example:

superhero comic book

musicUrl

string

optional

URL of the background music.

musicVolume

number

optional

Volume level for the background music, ranging from 0 (silent) to 1 (loudest).

>= 0<= 1

Default:

0.15

captionDetails

object (Caption Details)

optional

Style of captions in the video.

aspectRatio

object (Aspect Ratio)

optional

Aspect ratio of the video.

width

number

required

Width component of the aspect ratio.

height

number

required

Height component of the aspect ratio.

minDimensionPixels

integer

optional

Minimum dimension of the video in pixels. Height and width will be calculated based on minDimensionPixels and aspectRatio.

<= 1080> 0

Default:

1080

webhookUrl

string

optional

URL for your webhook, which will receive a POST request with JSON body { apiFileId: string; apiFileSignedUrl: string } once the video is generated.

Example

{
    "outline": {
        "sections": [
            {
                "text": "The Model Context Protocol (MCP) is revolutionizing how artificial intelligence interacts with various data sources, akin to how USB-C ports standardize connections for devices. In a world where AI models often find themselves isolated from the data they require to function optimally, MCP serves as a vital bridge. This open protocol allows applications to seamlessly provide context to large language models (LLMs), enabling them to access and utilize data from diverse sources—be it local files, databases, or remote services.",
                "voice": "Matilda",
                "title": "MCP",
                "subtitle": "How MCP is revolutionizing AI",
                "overlayType": "TITLE_SCREEN"
            },
            {
                "text": "At its essence, MCP operates on a client-server architecture. Host applications, such as development environments and AI tools, connect to lightweight MCP servers, which expose specific capabilities. This structure not only simplifies the integration process but also allows developers the flexibility to switch between different LLM providers without the hassle of creating custom connections for each data source. By offering a growing list of pre-built integrations and best practices for data security, MCP empowers developers to build sophisticated agents and workflows that enhance the utility of AI.",
                "voice": "Matilda"
            },
            {
                "text": "The significance of MCP extends beyond mere functionality; it represents a shift towards more connected and context-aware AI systems. As organizations like Block and Apollo adopt MCP, they highlight its potential to transform how AI tools retrieve and process information. With its open-source foundation, MCP invites developers to contribute and collaborate, paving the way for future innovations in AI technology. By simplifying the connection between AI and real-world applications, MCP is not just a protocol; it is a catalyst for a new era of intelligent, data-driven solutions.",
                "voice": "Matilda"
            }
        ],
        "useGenerativeImage": true,
        "captionDetails": {
          "verticalAlignment": "BOTTOM"
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ext.videogen.io/v2/outline-to-video' \
--header 'Content-Type: application/json' \
--data-raw '{
    "outline": {
        "sections": [
            {
                "text": "The Model Context Protocol (MCP) is revolutionizing how artificial intelligence interacts with various data sources, akin to how USB-C ports standardize connections for devices. In a world where AI models often find themselves isolated from the data they require to function optimally, MCP serves as a vital bridge. This open protocol allows applications to seamlessly provide context to large language models (LLMs), enabling them to access and utilize data from diverse sources—be it local files, databases, or remote services.",
                "voice": "Matilda",
                "title": "MCP",
                "subtitle": "How MCP is revolutionizing AI",
                "overlayType": "TITLE_SCREEN"
            },
            {
                "text": "At its essence, MCP operates on a client-server architecture. Host applications, such as development environments and AI tools, connect to lightweight MCP servers, which expose specific capabilities. This structure not only simplifies the integration process but also allows developers the flexibility to switch between different LLM providers without the hassle of creating custom connections for each data source. By offering a growing list of pre-built integrations and best practices for data security, MCP empowers developers to build sophisticated agents and workflows that enhance the utility of AI.",
                "voice": "Matilda"
            },
            {
                "text": "The significance of MCP extends beyond mere functionality; it represents a shift towards more connected and context-aware AI systems. As organizations like Block and Apollo adopt MCP, they highlight its potential to transform how AI tools retrieve and process information. With its open-source foundation, MCP invites developers to contribute and collaborate, paving the way for future innovations in AI technology. By simplifying the connection between AI and real-world applications, MCP is not just a protocol; it is a catalyst for a new era of intelligent, data-driven solutions.",
                "voice": "Matilda"
            }
        ],
        "useGenerativeImage": true,
        "captionDetails": {
          "verticalAlignment": "BOTTOM"
        }
    }
}'

application/json

Body

apiFileId

string

required

Primary ID of video file to be generated.

Examples

SuccessSample Response Request

{
    "apiFileId": "874d3150-f0e3-435c-be3d-0936d892b7e7"
}

Request

Request samples

Responses