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

# Introduction

The Alphamoon REST API gives you the ability to access and manage your company's file information without using the front-end platform.

This guide includes all the **Alphamoon API endpoints** with which you can interact in order to:

* Create **processes** and **collections**
* Upload one or multiple files to a collection
* Get the **results** of the processed file
* **Export** collections
* Get the **status** of your collection
* Get the **Supervision** URL to bring up the front-end module

{% hint style="info" %}
**In a hurry?**

Start with our [Quick API Tutorial](broken://pages/jFNn2wAaLxh4okKQuKG0) processes for an overview of the most essential actions you can take with the API.
{% endhint %}

### Base URL

```
https://workspace.alphamoon.ai/api
```

### OpenAPI

```
https://workspace.alphamoon.ai/api/v0.3/openapi.json
```

You can download the OpenAPI document using one of your favorite tools, eg. Postman or Swagger UI.

{% hint style="info" %}
**Authentication**

[Click here](/documentation/api/authenticating.md) to learn more about the authentication process.
{% endhint %}

#### See next:


---

# 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://alphamoon.gitbook.io/documentation/api/introduction.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.