The Direct API consists of a single GET endpoint, which is https://api.creatomate.com/v1/direct. You can use the following query parameters to specify what kind of video or image should be returned:
output_format (string, required)
The output format of the render, which can be jpg, png, gif, or mp4.
frame_rate (number, optional)
The frame rate of the rendered video, which can be 1 to 60 fps for mp4, and 1 to 15 for gif. Do not provide this parameter when rendering a jpg or png.
render_scale (number, optional)
The scale at which you want your render to be in relation to the template. The default value is 1.0 (100%), which means the render will have the same dimensions as the template.
max_width (number, optional)
Scales the render so that its width never exceeds the provided number while maintaining its aspect ratio. This parameter can be combined with max_height. If set, render_scale will be ignored.
max_height (number, optional)
Scales the render so that its height never exceeds the provided number while maintaining its aspect ratio. This parameter can be combined with max_width. If set, render_scale will be ignored.
template_id (string, optional)
The ID of the template that you want to use.
project_id (string, optional)
The ID of your project. This parameter should only be provided when generating by source (using the source parameter described below).
source (string, optional)
You can provide the template source here directly if you do not want to use a template from your account. Because the source is in JSON, you'll need to URL encode it before using it as a query parameter. This option requires project_id to be set. In addition, you need to sign your URL or set Direct API access to Unprotected, as described in Access Restriction.
cache (string, optional)
By default, the render is cached based on the URL. By setting cache=no, the render will be recreated each time it is requested, regardless of whether the URL is the same.
[...modifications] (string, optional)
Modifications that need to be applied to the template before it is rendered. This follows the format of the modifications object of the REST API. For example, to replace a text element named Text-1 with the text Example, append Text-1=Example to the URL.
signature (string, optional)
If you set Direct API access to Protected in project settings, you must sign your URL with a HMAC-SHA256 signature. This parameter should be placed at the end of the URL.