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

# Introduction

## Welcome to the OpenIndex.ai API documentation

We are opening up our API to allow developers to build their RAG (retrieval augmented generation) stack in their own applications.

You can get your API key at the [OpenIndex Dashboard](https://www.openindex.ai/dashboard/keys) and just pass it as a bearer token in the `Authorization` HTTP header.

## Want to jump right in?

Go right ahead with our Quick Start to learn how to get started with few lines of code.

{% content-ref url="/pages/HFYWkNXmSvfnIbBv8FSH" %}
[Quick Start](/openindex.ai-api-documentation-1/quick-start.md)
{% endcontent-ref %}

## Want to deep dive?

See below our API reference with a list of all endpoints.

{% content-ref url="/pages/BwjgDFsw0Crj13etseQ5" %}
[API Reference](/openindex.ai-api-documentation-1/reference/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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://openindexai.gitbook.io/openindex.ai-api-documentation-1/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
