---
canonical_url: "https://docs.composio.dev/toolkits/creatomate"
markdown_url: "https://docs.composio.dev/toolkits/creatomate.md"
product: "platform"
version: null
last_updated: null
---

# Creatomate

Creatomate is an API for generating and managing automated videos, images, GIFs, and reusable media templates.

- **Category:** video & audio
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `CREATOMATE`
- **Version:** 00000000_00

## Tools

### Create Render

**Slug:** `CREATOMATE_CREATE_RENDER`

Start one asynchronous image, video, or GIF render from either a template or a direct RenderScript. The call consumes render credits and returns the initial status; use Get Render to check completion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata` | string | No | Caller-defined string echoed in the render record and webhook payload. |
| `max_width` | number | No | Maximum output width while preserving aspect ratio; overrides render_scale. |
| `max_height` | number | No | Maximum output height while preserving aspect ratio; overrides render_scale. |
| `template_id` | string | No | ID of the saved template to render. Required in template mode and mutually exclusive with render_script. |
| `webhook_url` | string | No | HTTP(S) URL that receives the Render object when the asynchronous render succeeds or fails. |
| `render_scale` | number | No | Scale relative to the original resolution; Creatomate ignores it when max_width or max_height is set. |
| `modifications` | object | No | Template element-name or property-path keys mapped to replacement JSON values. Valid only with template_id. |
| `output_format` | string ("mp4" | "jpg" | "png" | "gif") | No | Output format override. In direct mode, this takes precedence over output_format in render_script. |
| `render_script` | object | No | Complete direct RenderScript with arbitrary nested JSON, such as output_format, dimensions, and elements. Its properties are sent at the top level and it cannot be combined with template_id or modifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Template

**Slug:** `CREATOMATE_CREATE_TEMPLATE`

Create a reusable project template from a RenderScript without starting a render, returning the saved template and any non-fatal warnings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Non-empty name for the template. |
| `tags` | array | No | Labels used to organize and filter the template. |
| `source` | object | Yes | Complete RenderScript with arbitrary nested JSON describing output, dimensions, elements, and animations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Template

**Slug:** `CREATOMATE_DELETE_TEMPLATE`

Permanently delete one project template. Existing renders created from the template are unaffected.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | ID of the template to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Render

**Slug:** `CREATOMATE_GET_RENDER`

Return the current status and available output metadata for one asynchronous render; terminal statuses are succeeded and failed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `render_id` | string | Yes | Render ID returned by Create Render. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `CREATOMATE_GET_TEMPLATE`

Return one project template including its complete RenderScript source.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Template ID from List Templates, Create Template, or the template editor URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `CREATOMATE_LIST_TEMPLATES`

Return metadata for every template in the connected project, optionally filtered by any of the supplied comma-separated tags; RenderScript source is not included.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | string | No | Comma-separated template tags to match with OR semantics, for example product,marketing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template

**Slug:** `CREATOMATE_UPDATE_TEMPLATE`

Partially update a template's name, replacement tag list, or complete replacement RenderScript source; omitted fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New non-empty template name; omit to keep the current name. |
| `tags` | array | No | Complete replacement tag list; pass an empty list to remove all tags, or omit to leave tags unchanged. |
| `source` | object | No | Complete replacement RenderScript with arbitrary nested JSON; pass an empty object to replace it with empty JSON, or omit to leave it unchanged. |
| `template_id` | string | Yes | ID of the template to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |