Describe a template's fillable inputs
get_template_inputsReturns the inputs of one template that batch rows can fill: each input's id, label, text or image type, whether it is required, its default (a text input's value, an image input's asset and preview), image slot size and fit, the key rows use for it (its name, or its id when two layers share the name), a text input's styles (s1, s2, ...) when it has several, and a valueExample; rowExample is a whole ready row. Those keys and values are what validate_batch, create_batch, update_batch, and update_job accept. It needs a template ID; finding templates is search_templates' job. Inputs the author turned off or placed on hidden layers are left out unless requested, and omittedInputs names them: their template text still renders, so check them (dates, terms, links) when the copy changes theme; a row can fill them by key. The template's internal layout is not returned. An animated template also gives its duration and its stillTime, the second its images show unless create_batch gives another. Needs templates:read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pageId | No | One page of the template (the designer connection's page_id). A template's pages are separate designs, each with its own inputs; the first page when omitted. | |
| templateId | Yes | Template ID returned by search_templates | |
| includeHidden | No | Also return inputs on layers hidden in the template | |
| includeDisabled | No | Also return inputs the template author turned off |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| pages | No | The template's pages; each is a separate design with its own inputs | |
| width | Yes | Width in pixels; null if unknown | |
| height | Yes | Height in pixels; null if unknown | |
| inputs | Yes | ||
| pageId | No | The page these inputs are from (pass it as pageId to the batch tools) | |
| openUrl | Yes | Link that opens the template in the Kalpana app | |
| duration | No | An animated template's timeline length in seconds | |
| stillTime | No | The second the page's still image shows, set by its designer. Images use it unless create_batch gives stillTime; without either, they show the last frame | |
| isAnimated | No | True when the template moves; each image shows one moment of the motion | |
| rowExample | No | A row filling every input, keyed and shaped as rows are: copy and edit it | |
| description | Yes | ||
| omittedInputs | No | Inputs left out of `inputs`. Their template text renders as designed unless a row fills them by key; check them when the copy changes theme (dates, terms, links) |