You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve the documentation for the `template` property in output schemas
by expanding the property description and adding a comprehensive
"Understanding templates" section that explains template processing,
syntax, and where generated URLs appear.
Changes:
- Enhanced template property description with Mustache syntax details
- Added "Understanding templates" section explaining:
- How the platform processes templates (interpolation, generation, display)
- Template syntax with concrete examples
- Where templates appear (Console and API)
Addresses feedback from GitHub issue #2165.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|`title`| string | true | The output's title, shown in the run's output tab if there are multiple outputs and in API as key for the generated output URL. |
75
75
|`description`| string | false | A description of the output. Only used when reading the schema (useful for LLMs) |
76
-
|`template`| string | true | Defines a template which will be translated into output URL. The template can use variables (see below) |
76
+
|`template`| string | true | Defines a URL template that generates the output link. Templates use Mustache-style variable interpolation with {{variable}} syntax. The generated URL appears in the Apify Console Output tab and in the API response's output property.|
77
77
78
78
### Available template variables
79
79
@@ -90,6 +90,32 @@ The output schema defines the collections of keys and their properties. It allow
90
90
|`run.defaultDatasetId`| string | ID of the default dataset |
91
91
|`run.defaultKeyValueStoreId`| string | ID of the default key-value store |
92
92
93
+
## Understanding templates
94
+
95
+
Templates allow you to dynamically generate URLs that point to your Actor's output. When an Actor run completes, the Apify platform processes each template by:
96
+
97
+
1.**Variable interpolation**: Replacing `{{variable}}` placeholders with actual runtime values
98
+
2.**URL generation**: Creating the final output URL
99
+
3.**Display**: Showing the output in the Apify Console Output tab and including it in the API response
100
+
101
+
### Template syntax
102
+
103
+
Templates use Mustache-style double curly braces `{{variable}}` for variable interpolation. For example:
0 commit comments