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

# Welcome to ChatGPTfirewall

<figure><img src="/files/vsJ48WQpAhBTVeGLeWwA" alt="chatgptfirewall.png" width="256"><figcaption></figcaption></figure>

## :wave: Welcome to ChatGPTfirewall

## Overview

Welcome to our GitBook! This is a quick-start guide to understanding and using ChatGPTFirewall, a application that lets you chat with your data securely. Our app uses vector databases and a confidential server to make sure you can ask questions about your files and get answers without exposing any sensitive information. It's like having a conversation with your data, but keeping all the private details private.

Here's what you'll find inside this GitBook:

* **Quick Overview**: Learn what ChatGPTFirewall does and why it's special.
* **Getting Started**: Easy steps to get you up and running.
* **How-To Guides**: From uploading files to managing your settings, we've got you covered.
* **Deep Dives**: For those who love the details, learn how our app protects your data.
* **API Guide**: For developers, get to know how to work with our application programmatically.

ChatGPTFirewall stands out by putting a protective layer between your documents and the conversational AI, ensuring that no sensitive data is shared. Whether you're just curious about what your data can tell you or you need to ensure confidentiality while interacting with AI, this guide is here to help. Let's dive in and explore how ChatGPTFirewall keeps your conversations with your data secure and private!

## Quick links

{% content-ref url="/pages/aD4vUYrT2I2ohcgRp6AI" %}
[Introduction](/chatgptfirewall/overview/introduction.md)
{% endcontent-ref %}

{% content-ref url="/pages/Wjj9FFZkdWdhhU0Klbh1" %}
[Quick Start Guide](/chatgptfirewall/overview/quick-start-guide.md)
{% endcontent-ref %}

{% content-ref url="/pages/0VZ5huskfgs66eICUpsm" %}
[Features](/chatgptfirewall/overview/features.md)
{% endcontent-ref %}

## :book: Tutorial

We've put together some helpful guides for you to get setup with our product quickly and easily.

{% content-ref url="/pages/5X9f5cdJHTNnsuL2cvco" %}
[Manual](/chatgptfirewall/tutorial/manual.md)
{% endcontent-ref %}

{% content-ref url="/pages/BbFyQ5OeZXfuKGwDSyLi" %}
[Configurations](/chatgptfirewall/tutorial/configurations.md)
{% endcontent-ref %}

## :desktop: Tech in depth

Explore the nitty-gritty of our architecture and why we are safe.

{% content-ref url="/pages/W1vQOcFQY5dsxLekPlkf" %}
[Architecture](/chatgptfirewall/tech-in-depth/architecture.md)
{% endcontent-ref %}

{% content-ref url="/pages/QwKTXLNfcYwXuMkRdnYg" %}
[Safety](/chatgptfirewall/tech-in-depth/safety.md)
{% endcontent-ref %}

## :electric\_plug: API

A list of all the application's endpoints in our python backend.

{% content-ref url="/pages/6ci9JNqiLEY2smIFtKEA" %}
[Overview](/chatgptfirewall/api/overview.md)
{% endcontent-ref %}


---

# 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://chatgptfirewall.gitbook.io/chatgptfirewall/welcome-to-chatgptfirewall.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.