> For the complete documentation index, see [llms.txt](https://docs.avis.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avis.xyz/integrations/chat-and-rag/onyx.md).

# Onyx

### Overview <a href="#overview" id="overview"></a>

[Onyx](http://onyx.app/) is a self-hostable Chat UI that integrates with all AVIS models. Features include:

* Creating custom Agents
* Web search
* Deep Research
* RAG over uploaded documents and connected apps
* Connectors to applications like Google Drive, Email, Slack, etc.
* MCP and OpenAPI Actions support
* Image generation
* User/Groups management, RBAC, SSO, etc.

Onyx can be deployed for single users or large organizations.

### [​](https://docs.ollama.com/integrations/onyx#install-onyx)Install Onyx <a href="#install-onyx" id="install-onyx"></a>

Deploy Onyx with the [quickstart guide](https://docs.onyx.app/deployment/getting_started/quickstart).

{% hint style="info" %}
Resourcing/scaling docs [here](https://docs.onyx.app/deployment/getting_started/resourcing).
{% endhint %}

### [​](https://docs.ollama.com/integrations/onyx#usage-with-ollama)Usage with AVIS <a href="#usage-with-ollama" id="usage-with-ollama"></a>

1. Login to your Onyx deployment (create an account first).

<figure><img src="/files/nGlgXJ6uItxWpTKn4NSX" alt="" width="563"><figcaption></figcaption></figure>

2. In the set-up process select `avis` as the LLM provider.

<figure><img src="/files/Uk2rxWBcvMh4ng6soKVp" alt="" width="563"><figcaption></figcaption></figure>

3. Provide your **AVlS API URL** and select your models.

{% hint style="info" %}
If you’re running Onyx in Docker, to access your computer’s local network use `http://host.docker.internal` instead of `http://127.0.0.1`.
{% endhint %}

<figure><img src="/files/9hmvgselksRI3qo6basY" alt="" width="563"><figcaption></figcaption></figure>

You can also easily connect up Onyx Cloud with the `AVIS Cloud` tab of the setup.

### [​](https://docs.ollama.com/integrations/onyx#send-your-first-query)Send your first query <a href="#send-your-first-query" id="send-your-first-query"></a>

<figure><img src="/files/LTqUzMKQ5W7hvVQXGsGh" alt="" width="563"><figcaption></figcaption></figure>


---

# 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://docs.avis.xyz/integrations/chat-and-rag/onyx.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.