> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/template-keys.md).

# Template keys

Template keys are key-value pairs stored in the `NarrativeTemplateKeys` property of `UConvaiChatbotComponent`. The plugin sends the map to Convai through `update-template-keys` when the session is connected. Dashboard section objectives can reference `{key}` placeholders — populate matching keys in `NarrativeTemplateKeys` so Convai receives the runtime values your graph expects.

### How substitution works

In the Convai dashboard, author section objectives with `{key}` placeholders (for example `{PlayerName}`). In Unreal Engine, add matching keys to `NarrativeTemplateKeys` before Convai evaluates that section's objective.

For example, if a section objective is:

```
Guide {PlayerName} through the {QuestName} safety inspection.
```

And `NarrativeTemplateKeys` contains:

| Key          | Value        |
| ------------ | ------------ |
| `PlayerName` | `Rivera`     |
| `QuestName`  | `electrical` |

Convai receives:

```
Guide Rivera through the electrical safety inspection.
```

Match each key string in `NarrativeTemplateKeys` to the placeholder name in the dashboard objective character-for-character.

### Set template keys in the Details panel

Select the character Actor in the level or open the character Blueprint. In the **Components** panel, select **Convai Chatbot**, then expand **Convai|NarrativeDesign** in the **Details** panel. The `Narrative Template Keys` field is a `TMap<FString, FString>`. Add entries for keys whose values are known at design time.

### Set template keys at runtime in Blueprint

Assign the `Narrative Template Keys` property on the `UConvaiChatbotComponent` reference in Blueprint. Write to the property as you would any `TMap` — add, remove, or replace entries at any point during play.

```
// Blueprint pseudocode — assign via Set node on the NarrativeTemplateKeys property
NarrativeTemplateKeys["PlayerName"] = "Rivera"
NarrativeTemplateKeys["QuestStatus"] = "completed"
```

Assigning the property calls `UpdateNarrativeTemplateKeys` internally. If the chatbot session is connected, the plugin sends an `update-template-keys` message to Convai with the current map.

{% hint style="info" %}
`UpdateNarrativeTemplateKeys` is marked `BlueprintInternalUseOnly` and is not available as a callable Blueprint node. Assign the **Narrative Template Keys** property directly.
{% endhint %}

### When keys are applied

Template keys are applied when Convai evaluates the active section's objective — not when the trigger fires. Set keys for a new section before calling **Invoke Narrative Design Trigger** so they are in place when the destination section's objective is evaluated.

The plugin also sends `NarrativeTemplateKeys` when the session connects (`OnAttendeeConnected`). Populate the map in **Begin Play** before triggers fire if you need values available from the first section onward.

### Verify template keys

Before calling a trigger that advances to a section with `{key}` tokens in its objective:

1. Print or inspect `NarrativeTemplateKeys` in Blueprint or the **Details** panel — confirm the expected key-value pairs are present.
2. Compare each key string character-for-character against the `{key}` tokens in the dashboard objective.
3. After the trigger fires, confirm the character's behavior reflects the substituted values. If `{key}` tokens appear literally in responses, a key name mismatch or empty map is the most likely cause. See [Troubleshoot narrative design](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/troubleshoot-narrative-design.md).

### Next steps

{% content-ref url="/pages/Khv7SfpK36SvMkUjcjoW" %}
[Narrative triggers](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-triggers.md)
{% endcontent-ref %}

{% content-ref url="/pages/7L5OLPdjT22ynoNiU7gD" %}
[Narrative design Blueprint reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-blueprint-reference.md)
{% endcontent-ref %}

{% content-ref url="/pages/Y84uFwti8p03e69iFquR" %}
[Narrative design usage examples](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-usage-examples.md)
{% endcontent-ref %}

{% content-ref url="/pages/uGDfbeU2MRjQlg7HV1GY" %}
[Troubleshoot narrative design](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/troubleshoot-narrative-design.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/template-keys.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.