Introduction

Welcome to Alphamoon Workspace API

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

In a hurry?

Start with our Quick API Tutorial processes for an overview of the most essential actions you can take with the API.

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.

Authentication

Click here to learn more about the authentication process.

See next:

PreviousDocument SplittingNextQuickstart

Last updated