> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/python-rtlab-api-reference/introduction-to-functions_143429297/getvariablesdescription_143626078.md).

# GetVariablesDescription

<table data-header-hidden><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Model Interaction, MATLAB Variables</td></tr><tr><td><strong>Description</strong></td><td><p>Provide the details of each variable defined as <strong>MATLAB variables</strong>under the model trees. The details for each variable include:</p><ul><li>Variable Id</li><li>Variable name (as defined in MATLAB)</li><li>Variable value</li><li>Tuple of paths of all parameters in blocks using the variable</li></ul><p>The API call only works when the <code>&#x3C;model_name>.param</code> file has these <strong>MATLAB variables</strong>defined. <strong>MATLAB variables</strong> get added to these variables if they are assigned inside the MATLAB command before opening model box of the <em>Simulation Tool</em> tab (in the model explorer window).</p></td></tr><tr><td><strong>Usage</strong></td><td>((id1, name1, val1, (path1.1, path1.2,...)), (id2, val2, name2, (path2.1, path2.2, ...)), ...) = <strong>RtlabApi.GetVariablesDescription</strong>( )</td></tr><tr><td><strong>Input</strong></td><td>None</td></tr><tr><td><strong>Output</strong></td><td><p>Return a tuple containing tuples for each variable. Tuple for each variable contains</p><ul><li><strong>id1</strong>: Variable Id</li><li><strong>name1</strong>: Variable name as defined in MATLAB</li><li><strong>val1</strong>: Variable value</li><li><strong>(path1.2, path2.2, ...)</strong> : Tuple of paths of all parameters in blocks using the variable.</li></ul></td></tr><tr><td><strong>Exception</strong></td><td><p><strong>EOK:</strong> Success.</p><p><strong>EINVAL:</strong> One of the variables doesn’t exist..</p><p><strong>EIO:</strong> Error sending the request or receiving the reply.</p><p><strong>EBADF:</strong> Model not specified by previous Connect or OpenProject.</p><p><strong>OP_API_MODEL_IO_TIMEOUT:</strong> Timed out waiting for reply from model.</p><p><strong>OP_API_MODEL_IO_ERROR:</strong> Model is missing some or all processes or subsystems.</p></td></tr><tr><td><strong>Examples</strong></td><td>None</td></tr><tr><td><strong>Related Items</strong></td><td>SetVariables</td></tr><tr><td><strong>Modules</strong></td><td><strong>import RtlabApi</strong></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 by asking a question.

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

```
GET https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/python-rtlab-api-reference/introduction-to-functions_143429297/getvariablesdescription_143626078.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.
