> For the complete documentation index, see [llms.txt](https://docs.ndi.video/all/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ndi.video/all/developing-with-ndi/ndi-metadata.md).

# NDI Metadata

**NDI includes the ability to send XML formatted metadata messages between NDI senders and receivers using several different methods.**

{% hint style="info" %}
If you're interested you can check out our Github repository of for [Metadata here](https://github.com/NDIConnected/ndi-docs-metadata)
{% endhint %}

This is a powerful mechanism that can be used to communicate status, provide for remote control, and many other purposes. In particular, the ability to send messages bidirectionally between NDI senders and receivers allows NDI to simplify workflows that would be significantly more complex if implemented with other audio/video streaming protocols.

The following documentation explains how to utilize the metadata capabilities of NDI and includes all standard metadata elements developed to date. As new use cases emerge, expect this list of standards to expand.

{% hint style="warning" %}
We recommend that you use an XML Linter of your choice to prevent any potential syntax errors
{% endhint %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ndi.video/all/developing-with-ndi/ndi-metadata.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
