> For the complete documentation index, see [llms.txt](https://brixxbox.gitbook.io/brixxbox-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://brixxbox.gitbook.io/brixxbox-documentation/client-api-reference/functions/brixxgpt.md).

# brixxGPT

{% hint style="info" %}
OpenAI API Key must be stored in the workspace settings!
{% endhint %}

### OpenAI API Key must

### Parameter

gptOptions - Json object with parameters.

* system - to set the stage. A promt to tell the model, how to behave
* user - User input, examples and a query. This is the user promt

### Example Usages

```javascript
let response = app.brixxGPT({
    system: "Reply in a HTML snipped Text, that will be inserted in an existing div",
    user: "How to create a for loop in JS?"
});

// "output" is a brixxbox htmlTemplate control     
$(app.getHtmlElement("output")).html(response);

         
```


---

# 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://brixxbox.gitbook.io/brixxbox-documentation/client-api-reference/functions/brixxgpt.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.