> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Creatomate

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

![Creatomate logo](https://mintcdn.com/composio-preview/NPf8agM6UrvZD-Iu/images/toolkits/creatomate.svg?fit=max\&auto=format\&n=NPf8agM6UrvZD-Iu\&q=85\&s=50aee2096e39767338db2b1dec8f9329)

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

## Tools

> [accordion] 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
>
> **metadata** `string`
>
> Caller-defined string echoed in the render record and webhook payload.
>
> **max\_width** `number`
>
> Maximum output width while preserving aspect ratio; overrides render\_scale.
>
> **max\_height** `number`
>
> Maximum output height while preserving aspect ratio; overrides render\_scale.
>
> **template\_id** `string`
>
> ID of the saved template to render. Required in template mode and mutually exclusive with render\_script.
>
> **webhook\_url** `string`
>
> HTTP(S) URL that receives the Render object when the asynchronous render succeeds or fails.
>
> **render\_scale** `number`
>
> Scale relative to the original resolution; Creatomate ignores it when max\_width or max\_height is set.
>
> **modifications** `object`
>
> Template element-name or property-path keys mapped to replacement JSON values. Valid only with template\_id.
>
> **output\_format** `string ("mp4" | "jpg" | "png" | "gif")`
>
> Output format override. In direct mode, this takes precedence over output\_format in render\_script.
>
> **render\_script** `object`
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Non-empty name for the template.
>
> **tags** `array`
>
> Labels used to organize and filter the template.
>
> **source** `object` *required*
>
> Complete RenderScript with arbitrary nested JSON describing output, dimensions, elements, and animations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Template
>
> **Slug:** `CREATOMATE_DELETE_TEMPLATE`
>
> Delete one project template. The template stops resolving for new renders, while finished renders are unaffected; an editor that still has it open may offer to restore it.
>
> #### Input Parameters
>
> **template\_id** `string` *required*
>
> ID of the template to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **render\_id** `string` *required*
>
> Render ID returned by Create Render.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template
>
> **Slug:** `CREATOMATE_GET_TEMPLATE`
>
> Return one project template including its complete RenderScript source.
>
> #### Input Parameters
>
> **template\_id** `string` *required*
>
> Template ID from List Templates, Create Template, or the template editor URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **tags** `string`
>
> Comma-separated template tags to match with OR semantics, for example product,marketing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> New non-empty template name; omit to keep the current name.
>
> **tags** `array`
>
> Complete replacement tag list; pass an empty list to remove all tags, or omit to leave tags unchanged.
>
> **source** `object`
>
> 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` *required*
>
> ID of the template to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
