Skip to main content
Creatomate logo
  • Category: video & audio
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 7
  • Triggers: 0
  • Slug: CREATOMATE
  • Version: 20261101_00

Tools

Slug: CREATOMATE_CREATE_RENDERStart 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

string
Caller-defined string echoed in the render record and webhook payload.
number
Maximum output width while preserving aspect ratio; overrides render_scale.
number
Maximum output height while preserving aspect ratio; overrides render_scale.
string
ID of the saved template to render. Required in template mode and mutually exclusive with render_script.
string
HTTP(S) URL that receives the Render object when the asynchronous render succeeds or fails.
number
Scale relative to the original resolution; Creatomate ignores it when max_width or max_height is set.
object
Template element-name or property-path keys mapped to replacement JSON values. Valid only with template_id.
string ("mp4" | "jpg" | "png" | "gif")
Output format override. In direct mode, this takes precedence over output_format in 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREATOMATE_CREATE_TEMPLATECreate a reusable project template from a RenderScript without starting a render, returning the saved template and any non-fatal warnings.

Input Parameters

string
required
Non-empty name for the template.
array
Labels used to organize and filter the template.
object
required
Complete RenderScript with arbitrary nested JSON describing output, dimensions, elements, and animations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREATOMATE_DELETE_TEMPLATEDelete 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

string
required
ID of the template to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREATOMATE_GET_RENDERReturn the current status and available output metadata for one asynchronous render; terminal statuses are succeeded and failed.

Input Parameters

string
required
Render ID returned by Create Render.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREATOMATE_GET_TEMPLATEReturn one project template including its complete RenderScript source.

Input Parameters

string
required
Template ID from List Templates, Create Template, or the template editor URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREATOMATE_LIST_TEMPLATESReturn 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

string
Comma-separated template tags to match with OR semantics, for example product,marketing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREATOMATE_UPDATE_TEMPLATEPartially update a template’s name, replacement tag list, or complete replacement RenderScript source; omitted fields remain unchanged.

Input Parameters

string
New non-empty template name; omit to keep the current name.
array
Complete replacement tag list; pass an empty list to remove all tags, or omit to leave tags unchanged.
object
Complete replacement RenderScript with arbitrary nested JSON; pass an empty object to replace it with empty JSON, or omit to leave it unchanged.
string
required
ID of the template to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not