Skip to main content
POST

Authorizations

​
X-API-Key
string
header
required

Your API Key, visit storyfed.com to generate one.

Body

application/json
​
prompt
string
required

The prompt or script for the video.

Example:

"Make a video about 5 good healthy tips"

​
quality_tier
enum<string>
required

The desired rendering quality. Note: Currently, only 'Budget' is supported in the API. This quality is static images only, perfect for explainer videos, stories and news

Available options:
Budget
Example:

"Budget"

​
webhook_url
string<uri>

The URL where status updates and final result payloads will be sent.

Example:

"https://webhook.site/123"

​
ratio
enum<string>

The aspect ratio of the generated video. Default is 9:16

Available options:
9:16,
16:9,
1:1
Example:

"9:16"

​
estimated_length
integer

Estimated length in seconds. Maximum is 180.

Required range: x <= 180
Example:

60

​
country
string

Target country for the video context.

Example:

"United States"

​
channel
string

(Optional - Advanced) Storyfed id of the parent user channel to save the video.

​
channel_series
string

(Optional - Advanced) Storyfed id of the parent user channel_series to save the video.

​
template
string

(Optional - Advanced) Storyfed id of the video template.

​
narrator
string

(Optional - Advanced) Storyfed id of the narrator.

​
attachments
object[]

List of attachment objects containing image URLs and metadata. This images can be reference images or stock images to be used

Callbacks

POST
{$request.body#/webhook_url}onVideoUpdate

Body

application/json
​
status
string
Example:

"completed"

​
stage
string
Example:

"finished"

​
preview_url
string<uri>
​
result
object

Response

200

Your server should return a 2xx status code to acknowledge receipt of the webhook.

Response

Success - Job Started

​
status
string
Example:

"success"

​
response
object