Creatomate
API & Integration -> API Reference

Create a Render

This API endpoint allows you to create a video, image, or GIF, which is also referred to as a Render.

Parameters

template_id string optional

The ID of the template created in the editor. If you don't want to use a template, you can omit this parameter and provide RenderScript directly in the API request.

modifications string optional

Changes to apply to the template before it is rendered. Learn more about modifications on this page.

render_scale number optional

The scale at which to render. The default value is 1.0 (100%), which means the output is generated at original resolution. Can be a number between 0.1 and 10.

max_width number optional

Scales the output so that its width never exceeds the provided number. This parameter can be combined with max_height. If set, render_scale is ignored.

max_height number optional

Scales the output so that its height never exceeds the provided number. This parameter can be combined with max_width. If set, render_scale is ignored.

webhook_url number optional

A URL that is called when the render succeeds or fails.

metadata string optional

A value you want to pass to the webhook URL.

curl -X POST https://api.creatomate.com/v2/renders \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY_HERE" \
     -d '{
  "template_id": "YOUR_TEMPLATE_ID_HERE",
  "modifications": {
    "Text-1": "This text is placed in the element Text-1",
    "Video-1": "https://cdn.creatomate.com…/demo/video1.mp4"
  },
  "render_scale": 0.75,
  "max_width": 1080,
  "max_height": 1080,
  "webhook_url": "https://example.com…/webhook",
  "metadata": "Any text value"
}'

Examples

See the examples below to get started using this API endpoint.

Template-based Rendering

This example shows how to generate a video based on a template.

Using RenderScript

If you prefer not to use a template, you can pass the RenderScript data directly.

Related resources