Documentation
  • 👋Welcome to Documentation
  • 📖Glossary
  • ❓FAQs
  • General
    • Getting set up
      • Single-user organization
      • Multi-user organization
    • Supported Document Types
  • Platform Walkthrough
    • Dashboard
    • Queue
    • Configuration
    • Supervision
  • User guide How Tos
    • User Management
      • How to invite a new user to the platform?
      • How can I manage existing users?
    • Processes
      • How to create a supervised process or use the template?
      • How to create a custom process?
    • Supervision
      • How to add, assign, and remove annotations?
      • How to edit the value of the extraction?
      • How to open and edit a table mask?
      • How to open, edit, or remove the extracted table?
      • How to export your data via Supervision?
      • How to copy values and tables?
    • Upload
    • Converters
    • Data points definition
    • Data Export
    • Table Data Extraction
    • Enrichment
    • Generating new API key
  • Integrations
    • Zapier Integration
      • Quickstart
      • Alphamoon as a Trigger
      • Alphamoon as an Action
    • Google Sheets - Export
  • Features
    • Continuous Learning (Beta)
    • Document Splitting
  • API
    • Introduction
    • Quickstart
    • Organization API keys (Beta)
    • Process API keys (Beta)
    • Authenticating
    • Versioning
    • Get results
    • Get OCR results
    • Get processes
    • Get process types
    • Get collections
    • Metadata
      • Setting metadata value
    • Upload File
    • Export
    • Download original files
    • Delete collection
    • Reset process configuration
  • Resources
    • 💻Alphamoon Website
Powered by GitBook
On this page
  • Base URL
  • OpenAPI
  1. API

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

See next:

PreviousDocument SplittingNextQuickstart

Last updated 1 year ago

to learn more about the authentication process.

Click here