TEMPLATES_API.md

Templates API

No authorization is required for ./templates API's.

• Get All Templates
• Get Templates Categories
• Get a Specific Template
• Get Color-Presets of the Template
• Get Pluggable-Screens of the Template
• Get Recommended-Custom-Colors of the Template
• Get Template-Presets of the Template
• Get SVG Content of the Template
• Get Theme of the Template
• Get Transitions of the Template

Get All Templates

Retrieves all templates.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplates({
    categoryId: 3,
    equalizer: false,
    limit: 4,
    offset: 10
  })
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

See example

Get Templates Categories

Retrieves templates categories.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplatesCategories({ language: 'en' })
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• The supported language codes are: ar, de, en, es, fr, pt, ru, tr.

See example

Get a Specific Template

Retrieves a specific template.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplate(701, { language: 'en' })
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• The supported language codes are: ar, de, en, es, fr, pt, ru, tr.

See example

Get Color-Presets of the Template

Retrieves color-presets of the template. You can apply these color presets to your project to give it better and unique look.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplateColorPresets(701)
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• The number of color-presets is varying from template to template.

See example

Get Pluggable-Screens of the Template

Retrieves pluggable-screens of the template.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplatePluggableScreens(701)
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• Only lego templates might have a pluggable-screen.
• The number of pluggable-screens is varying from template to template. Pluggable-Screens are grouped by categories.

See example

Get Recommended-Custom-Colors of the Template

Retrieves recommended-custom-colors of the template. You can apply these recommended custom colors to your project to give it better and unique look.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplateRecommendedCustomColors(701)
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• The number of recommended-custom-colors is varying from template to template.

See example

Get Template-Presets of the Template

Retrieves template-presets of the template.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplatePresets(701)
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• Only lego templates might have a template-preset.

• The number of template-presets is varying from template to template. Template-presets are ready-made stories created from this template to fasten your video production.

See example

Get SVG Content of the Template

Retrieves SVG content of the template.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplateSVGContent(701)
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

See example

Get Theme of the Template

Retrieves theme of the template.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplateTheme(701)
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• Both lego & non-lego templates might have a theme.

See example

Get Transitions of the Template

Retrieves transitions of the template.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getTemplateTransitions(701)
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

See example

⬆ back to the top