Creatomate API
Cloud API for generating and editing video and images programmatically. Creatomate uses a JSON-based format called RenderScript to define video/image compositions.
Quick Start
const Creatomate = require('creatomate');
const client = new Creatomate.Client('YOUR_API_KEY');
// Render from a template
const renders = await client.render({
templateId: 'your-template-id',
modifications: {
'Title': 'Hello World',
'Text 1': 'Dynamic content here'
}
});
// Or build from source
const source = new Creatomate.Source({
outputFormat: 'mp4',
width: 1920,
height: 1080,
elements: [
new Creatomate.Video({ source: 'https://...' }),
new Creatomate.Text({ text: 'Overlay text' })
]
});
const renders = await client.render({ source });
Quick Reference
| Task |
Read |
| Getting started with the SDK |
sdk-basics.md |
| Building video from elements |
source-elements.md |
| Text overlays and animations |
text-elements.md |
| Working with templates |
templates.md |
| Transitions and effects |
effects.md |
| Creating slideshows |
slideshows.md |
| Adding captions/subtitles |
captions.md |
| Social media formats |
social-media.md |
| Compositions (scenes) |
compositions.md |
| AI integration (ChatGPT) |
ai-integration.md |
Reference Files
Foundation
- references/sdk-basics.md - Client setup, API key, rendering basics
- references/source-elements.md - Source object, element types, tracks
Elements
- references/text-elements.md - Text styling, fonts, backgrounds, animations
- references/video-audio.md - Video/Audio elements, trimming, looping
- references/images.md - Image elements, slideshows, Ken Burns effects
Effects & Animations
- references/effects.md - Filters, blur, masks, color overlays, shadows
- references/animations.md - Keyframes, transitions, enter/exit animations
- references/captions.md - Animated captions, AWS Transcribe integration
Advanced
- references/compositions.md - Grouping elements, scenes, nested timelines
- references/templates.md - Using templates with modifications
- references/social-media.md - TikTok, Instagram, YouTube formats
- references/ai-integration.md - ChatGPT integration, AI-generated content
Code Examples
For 50+ working code examples, see the official Creatomate Node.js Examples repository.
Popular Examples
1---2name: creatomate3description: Creatomate video/image generation API. Use when: (1) Creating videos or images programmatically with the Creatomate SDK, (2) Building slideshows, concatenating videos, adding text overlays, (3) Adding animated captions or subtitles, (4) Generating social media content (TikTok, Instagram Stories, YouTube Shorts), (5) Using templates with dynamic modifications, (6) Applying effects (blur, filters, masks, transitions), (7) Integrating with ChatGPT for AI-generated content, (8) Working with compositions and animations.4---56# Creatomate API78Cloud API for generating and editing video and images programmatically. Creatomate uses a JSON-based format called RenderScript to define video/image compositions.910## Quick Start1112```javascript13const Creatomate = require('creatomate');14const client = new Creatomate.Client('YOUR_API_KEY');1516// Render from a template17const renders = await client.render({18 templateId: 'your-template-id',19 modifications: {20 'Title': 'Hello World',21 'Text 1': 'Dynamic content here'22 }23});2425// Or build from source26const source = new Creatomate.Source({27 outputFormat: 'mp4',28 width: 1920,29 height: 1080,30 elements: [31 new Creatomate.Video({ source: 'https://...' }),32 new Creatomate.Text({ text: 'Overlay text' })33 ]34});35const renders = await client.render({ source });36```3738## Quick Reference3940| Task | Read |41|------|------|42| Getting started with the SDK | [sdk-basics.md](references/sdk-basics.md) |43| Building video from elements | [source-elements.md](references/source-elements.md) |44| Text overlays and animations | [text-elements.md](references/text-elements.md) |45| Working with templates | [templates.md](references/templates.md) |46| Transitions and effects | [effects.md](references/effects.md) |47| Creating slideshows | [slideshows.md](references/slideshows.md) |48| Adding captions/subtitles | [captions.md](references/captions.md) |49| Social media formats | [social-media.md](references/social-media.md) |50| Compositions (scenes) | [compositions.md](references/compositions.md) |51| AI integration (ChatGPT) | [ai-integration.md](references/ai-integration.md) |5253## Reference Files5455### Foundation56- [references/sdk-basics.md](references/sdk-basics.md) - Client setup, API key, rendering basics57- [references/source-elements.md](references/source-elements.md) - Source object, element types, tracks5859### Elements60- [references/text-elements.md](references/text-elements.md) - Text styling, fonts, backgrounds, animations61- [references/video-audio.md](references/video-audio.md) - Video/Audio elements, trimming, looping62- [references/images.md](references/images.md) - Image elements, slideshows, Ken Burns effects6364### Effects & Animations65- [references/effects.md](references/effects.md) - Filters, blur, masks, color overlays, shadows66- [references/animations.md](references/animations.md) - Keyframes, transitions, enter/exit animations67- [references/captions.md](references/captions.md) - Animated captions, AWS Transcribe integration6869### Advanced70- [references/compositions.md](references/compositions.md) - Grouping elements, scenes, nested timelines71- [references/templates.md](references/templates.md) - Using templates with modifications72- [references/social-media.md](references/social-media.md) - TikTok, Instagram, YouTube formats73- [references/ai-integration.md](references/ai-integration.md) - ChatGPT integration, AI-generated content7475## Code Examples7677For 50+ working code examples, see the official **[Creatomate Node.js Examples](https://github.com/Creatomate/node-examples)** repository.7879### Popular Examples8081| Example | Description |82|---------|-------------|83| [concatenate](https://github.com/Creatomate/node-examples/tree/main/concatenate) | Combine multiple videos |84| [slideshow](https://github.com/Creatomate/node-examples/tree/main/slideshow) | Image slideshow with transitions |85| [captions](https://github.com/Creatomate/node-examples/tree/main/captions) | Animated captions with AWS Transcribe |86| [chatgpt](https://github.com/Creatomate/node-examples/tree/main/chatgpt) | AI-generated video content |87| [story-video](https://github.com/Creatomate/node-examples/tree/main/story-video) | TikTok/Instagram story format |88| [text-overlay](https://github.com/Creatomate/node-examples/tree/main/text-overlay) | Text on video |89| [picture-in-picture](https://github.com/Creatomate/node-examples/tree/main/picture-in-picture) | PiP layout |90| [aws-polly](https://github.com/Creatomate/node-examples/tree/main/aws-polly) | Text-to-speech videos |91| [blur-background](https://github.com/Creatomate/node-examples/tree/main/blur-background) | Background blur effect |92| [template](https://github.com/Creatomate/node-examples/tree/main/template) | Template rendering |