> 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-unity-sdk/features/scene-metadata.md).

# Scene metadata

Scene Metadata gives Convai characters awareness of the objects in your Unity scene. Add a `ConvaiObjectMetadata` component to any GameObject to describe what it is — that static name, description, and include flag send automatically when a session connects, and re-sync live to every connected character if you edit them afterward, no scripting required. The same component can also expose optional tracked properties that report an object's live runtime state to characters while a session is active.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>How scene metadata works</strong><br>Understand the registration and delivery flow, and when to use Scene Metadata vs. Dynamic Context.</td><td><a href="/pages/KwecfeB1C1fimjgaLENp">/pages/KwecfeB1C1fimjgaLENp</a></td></tr><tr><td><strong>Scene metadata quick start</strong><br>Register your first scene object and confirm it reaches Convai.</td><td><a href="/pages/b21526ee9b2c1ed58e407fc454da6b3bd057905a">/pages/b21526ee9b2c1ed58e407fc454da6b3bd057905a</a></td></tr><tr><td><strong>Scene metadata component reference</strong><br>Every Inspector field for <code>ConvaiObjectMetadata</code>, including tracked properties, and <code>ConvaiSceneMetadataCollector</code>.</td><td><a href="/pages/cb67fd355a439e2cf54faaa44dd018f205299a93">/pages/cb67fd355a439e2cf54faaa44dd018f205299a93</a></td></tr><tr><td><strong>Scene metadata scripting API</strong><br><code>ConvaiObjectMetadata</code>, <code>ConvaiMetadataRegistry</code>, and <code>ConvaiSceneMetadataCollector</code> public methods.</td><td><a href="/pages/aa4f25375b3961f18138e4a75710532316656e63">/pages/aa4f25375b3961f18138e4a75710532316656e63</a></td></tr><tr><td><strong>Scene metadata usage examples</strong><br>Complete setups for medical training, industrial safety, museum guides, runtime object exclusion, and tracked properties.</td><td><a href="/pages/c47675608acf86e70caf6c8b756d2be389006162">/pages/c47675608acf86e70caf6c8b756d2be389006162</a></td></tr><tr><td><strong>Troubleshoot scene metadata</strong><br>Diagnosis for AI ignoring objects, validation errors, empty metadata payloads, and dependency failures.</td><td><a href="/pages/66fddc4b0f911e97d589403a45f3ae569eb83b5d">/pages/66fddc4b0f911e97d589403a45f3ae569eb83b5d</a></td></tr></tbody></table>


---

# 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-unity-sdk/features/scene-metadata.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.