Skip to content

docs: Enhance output schema template property documentation #2197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcel-rbro wants to merge 4 commits into
base: master
Choose a base branch
from
Open

docs: Enhance output schema template property documentation #2197

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6ce3dd
docs: Enhance output schema template property documentation
marcel-rbro Jan 21, 2026
29c8488
fix: Correct bold formatting in output schema documentation
marcel-rbro Jan 21, 2026
a729695
fix: Change heading to simple present tense
marcel-rbro Jan 21, 2026
1f6f73b
docs: Apply PR review suggestions
marcel-rbro Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion sources/platform/actors/development/actor_definition/output_schema/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The output schema defines the collections of keys and their properties. It allow
|----------------|--------------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `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. |
| `description` | string | false | A description of the output. Only used when reading the schema (useful for LLMs) |
| `template` | string | true | Defines a template which will be translated into output URL. The template can use variables (see below) |
| `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 Apify Console **Output** tab and in the API response's output property. |

### Available template variables

Expand All @@ -90,6 +90,32 @@ The output schema defines the collections of keys and their properties. It allow
| `run.defaultDatasetId` | string | ID of the default dataset |
| `run.defaultKeyValueStoreId` | string | ID of the default key-value store |

## Understand templates

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:

1. Variable interpolation: Replacing `{{variable}}` placeholders with actual runtime values
2. URL generation: Creating the final output URL
3. Display: Showing the output in Apify Console **Output** tab and including it in the API response

### Template syntax

Templates use double curly braces `{{variable}}` for variable interpolation. For example:

- `{{links.apiDefaultDatasetUrl}}/items` becomes `https://api.apify.com/v2/datasets/<dataset-id>/items`
- `{{run.containerUrl}}` becomes `https://<container-id>.runs.apify.net/`

You can access nested properties using dot notation (e.g., `{{run.defaultDatasetId}}`, `{{links.publicRunUrl}}`).

### Where templates appear

The generated URLs from your templates appear in two places:

1. Apify Console: In the **Output** tab of your Actor run
2. API response: In the `output` property when calling the GET Run endpoint

The examples below demonstrate various template patterns and their results in both the Console and API.

## Examples

### Linking default dataset
Expand Down
Loading