> For the complete documentation index, see [llms.txt](https://docs.novacura.com/flow-connect/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.novacura.com/flow-connect/reference/reference/flowscript-copilot.md).

# Flowscript Copilot

FlowScript Copilot is an AI-powered assistant (chatbot) designed to support users in creating FlowScript code.

{% hint style="info" %}
***To use FlowScript Copilot, please upgrade the Designer to version 1.0.0.149 or later***
{% endhint %}

FlowScript Copilot offers a Copilot-like experience specifically tailored to FlowScript, enabling users to:

1. Contextually aware, **FlowScript Copilot** is capable of handling conversations by retaining context from previous questions and answers.
2. FlowScript Copilot can interpret the user intent and provide a solution to the problem.
3. Access **syntax explanations** and **code examples**.
4. Use **"copy-paste" functionality** for code snippets.
5. Receive **real-time responses** to FlowScript queries.
6. Get **FlowScript function suggestions** as potential solutions to problems.
7. Provide feedback for continuous improvement.

To find Flowscript Copilot open Designer and click "Tools" and choose "FlowScript Playground"<br>

<figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FlBWHF4PtWNPtyCKdTJRn%2FScreenshot%202025-04-15%20at%2010.35.52.png?alt=media&amp;token=943971f5-1cc5-436a-83e2-3b66e99affb5" alt=""><figcaption></figcaption></figure>

In Playground, launch the Flowscript Copilot by clicking the **Magic button**.<br>

<figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2F4IJIbqCES97bURgMVMqM%2FScreenshot%202025-04-15%20at%2010.40.51.png?alt=media&amp;token=f4a38d31-89c3-483e-8474-ab2bfe5e4368" alt="" width="255"><figcaption></figcaption></figure>

To start a conversation, ask questions related to FlowScript code. The Copilot can only respond to FlowScript-specific questions. It will explain how to solve the problem and provide a ready-to-use code snippet that you can copy and paste into the Playground and run it. If code is correct you will get the output in the Playground.

<figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2Fiy74MOHFNq98jDgTdkoj%2FScreenshot%202025-04-15%20at%2010.55.17.png?alt=media&amp;token=436a963c-786f-4f5c-b640-295f1eff1363" alt=""><figcaption></figcaption></figure>

If the code is incorrect, it will be highlighted in the Playground, and an error message may appear with an explanation.

<figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FduRLjByyhKz0RC7CgQQW%2FScreenshot%202025-04-15%20at%2010.59.38.png?alt=media&amp;token=74a3d9c2-c063-4498-befe-90d86093b855" alt=""><figcaption></figcaption></figure>

The Flowscript Copilot maintains the context of the conversation (up to 10 messages), allowing it to handle follow-up questions related to the same use case. To clear the chat history, click the brush icon.

<figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FZQb5FsM3Knfl52fBsi6Y%2FScreenshot%202025-04-15%20at%2010.52.24.png?alt=media&amp;token=c8b15bc5-6325-4ed2-a05f-e0173d293c61" alt="" width="375"><figcaption></figcaption></figure>

The FlowScript Copilot can generate both code examples and complete functions. To verify that a function solves your problem, it's recommended to declare the necessary variables in your prompt.

Have feedback? Use the feedback icon in the app to let us know what you think.


---

# 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.novacura.com/flow-connect/reference/reference/flowscript-copilot.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.