Skip to main content

Upload a creative template

A creative template is a fundamental resource to create video creatives with the Shakr API. Shakr supports your After Effects project file to be converted as a creative template that becomes the base resource for making the final video creative.

To upload an After Effects project file (compressed in .zip file format), you need to create three objects with our API: Template, TemplateStyle, and TemplateStyleVersion.

  • Template: A group of TemplateStyle that share similar visual design and structure.
  • TemplateStyle: Unique unit of video used in Shakr. One Template can include many TemplateStyles with various display ratio(i.e. 4:5, 1:1, 9:16, etc) and various lengths(i.e. 15s, 30sec, etc).
  • TemplateStyleVersion: Individual version of TemplateStyle, with different languages.

These objects can all be created in a single request using the TemplateStyleVersion Create API. To learn more, refer to the Create a template style version section.

After Creating TemplateStyleVersion​

After creating TemplateStyleVersion object, status attribute will transition as follows:

  • processing: Shakr is analyzing the project file.
  • demo_rendering: Shakr is performing a test render of the template.
  • edit_ready: Template is ready to be used in Template Editor.
info

If there are any errors found in the After Effects project file, the status parameter will make transition to failed state. We are currently working on documenting a public list of error codes you can reference.

Once the status makes transition to edit_ready state, you can now open the Shakr Template Editor using the Template-Scoped Access Token. The Shakr Template Editor SDK is a tool that empowers converting the After Effects project file to a creative template that is unique to the Shakr’s platform. Refer to the Shakr Template Editor SDK section to learn more.

After Template Editor SDK process​

After Template Editor SDK finished the editing and saved all template data, status attribute will transition as follows:

  • thumbnail_generating: Shakr is generating thumbnails and performing final processing steps.
  • processed: The converting process is complete. The After Effects project file is converted to a creative template using the Shakr Template Editor and is ready for use for the video making.