Skip to main content

API FAQs

P
Written by Peace Aisosa
Updated today

Is the JSON code generated through the editor directly compatible with the API, or do we need to adjust the code before sending it to the API?

The JSON output from the editor is fully compatible with the API as is.

You can simply copy, paste, and send it as an API request without any modifications.

How can I use Figma designs and logos in Shotstack for real estate branding?

To use Figma designs with Shotstack, you can export your designs from Figma and use them as images within your Shotstack video project.

For real estate branding, you can incorporate logos and designs by exporting them from Figma and adding them to your Shotstack videos.

If you need to automate the process of adding a real estate agency's logo to multiple property photographs, you can set the image as a merge field in your video.

By sending a request to the API with the desired image, your video will be rendered with the preferred real estate agency logo, similar to how you would replace a name in a bulk email.

How can I add a thumbnail to my videos?

You can add a thumbnail by including the following in your JSON:

"thumbnail": {
"capture": 3
}

Here’s an example of a complete template with a thumbnail:

{
"timeline": {
"background": "#FFFFFF",
"tracks": [
{
"clips": [
{
"length": "auto",
"asset": {
"type": "video",
"src": "fakevideolink.com"
},
"start": 0
}
]
}
]
},
"output": {
"format": "mp4",
"fps": 25,
"size": {
"width": 1920,
"height": 1080
},
"thumbnail": {
"capture": 3
}
}
}

How can I use html in my template and JSON

The HTML asset for text is deprecated. Please use the text asset instead. You can find more details in the documentation.

What can I do if my video exceeds the 10GB fetch limit

Currently, the 10GB fetch limit cannot be increased. However, you can manage large videos within this limit by following these steps:

  • Use the Ingest API to adjust your source videos to the desired resolution and frame rate of your final video. This step can significantly reduce the file size of your videos.

  • If your video exceeds the 10GB limit after pre-processing with Ingest API, use FFmpeg to split it into smaller segments, each under the 10GB limit. Then, merge these segments into a single video to ensure the combined file size stays below the 10GB threshold.

Are templates created in the dashboard incompatible with the Studio SDK?"

Templates created in the dashboard are compatible with the Studio editor.

I created a video in the editor, but the preview still shows the JSON from the welcome template. Why don’t I see my video’s JSON?

This can happen if your browser is showing cached data. Please refresh your browser, clear your cache, and try again.

What resolution do you accept?

We support up to 1080p resolution. 4K is available on high-volume plans. Please contact support and ask for a human agent if you’d like to enable it.

Does Shotstack support adding text to a video or merging two existing videos through API functions as part of AI workflow automation?

Yes, Shotstack supports this. You can use the text asset in your Edit to programmatically add text to your videos.

Here is a simple example template which demonstrates this functionality.

Did this answer your question?