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

# Getting started

citrus is the simplest way to store vector embeddings for your next AI project. At its core, it consists of just 4 functions. Getting started with it is as simple as it gets.

## What is citrusdb?

Citrusdb is an open-source (distributed) vector database. You can use citrusdb for storing your OpenAI embeddings to perform quick semantic search. We have only begun working on this and we'll release our roadmap soon!

But we have most of the essential features ready for you to be able to start playing with. This includes:

* Simple API.
* Fast and efficient vector index.
* Data persistence.

## Want to jump right in?

Feeling like an eager beaver? Jump in to the quick start docs and store your first vector embedding:

{% content-ref url="/pages/TZb5qNqGc8hR2jSaLdmo" %}
[Quick Start](/quick-start.md)
{% endcontent-ref %}

{% content-ref url="/pages/lThK4nmbHvGKYwa3gCaW" %}
[Cloud hosted citrus](/cloud-hosted-citrus/api-reference.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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.searchcitrus.com/getting-started.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.