> 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/getactiveprojects_143661810.md).

# GetActiveProjects

<table data-header-hidden><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Model Selection</td></tr><tr><td><strong>Description</strong></td><td><p>Return a list of active projects.</p><p>For each project, this function returns the full path of the configuration file, the name and the IP address of the machine that opened this project, the instance ID of the current project session, and the list of models belonging to this project. For each model, path, ID and state are returned.</p></td></tr><tr><td><strong>Required Control</strong></td><td>None</td></tr><tr><td><strong>Usage</strong></td><td>(projectInfo1, projectInfo2,...) = <strong>RtlabApi.GetActiveProjects</strong>() (project_path, project_instance_id, controller_machine_name, controller_ip_address, number_of_models, models) = projectInfo1 (modelInfo1, modelInfo2,...) = models (model_path, model_instance_id, model_state) = modelInfo1</td></tr><tr><td><strong>Input</strong></td><td>None</td></tr><tr><td><strong>Output</strong></td><td><p><strong>1 tuple per active project</strong>:</p><ul><li>project_path: path of the active project’s configuration file</li><li>project_instance_id: instance Identifier of the active project</li><li>controller_machine_name: controller machine name</li><li>controller_ip_address: controller's IP address and port number</li><li>number_of_models: number of models in the project</li><li><p>1 tuple per model:</p><ul><li>model_path: model's path</li><li>model_id: model identifier (1 .. number_of_models)</li><li>model_state: model's state (cf. OP_MODEL_STATE)</li></ul></li></ul></td></tr><tr><td><strong>Return value</strong></td><td><p><strong>EOK</strong>: Success.</p><p><strong>EIO</strong>: Error sending the request or receiving the reply.</p></td></tr><tr><td><strong>Examples</strong></td><td>None</td></tr><tr><td><strong>Related items</strong></td><td>OpenProject</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/getactiveprojects_143661810.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.
