Download original files

A quick guide on how to download original files using the Alphamoon API

Download uploaded files

Alphamoon REST API enables you to download original files for specified collections. To do that, get the collection_id of the processed file from:

  • Upload a file endpoint (Base64 or Binary)

  • Get collections endpoint

  • URL e.g. https://workspace.alphamoon.ai/supervision/223742cc9bca43fd81b2d41b0018e4c7

Use the following endpoint to get the original files:

Download original files for specified collections

GET /api/v0.3/collections/{collection_id}/uploaded files

Path Parameters

NameTypeDescription

collection-id*

String

The id of the collection for which you want to download the original files.

Download file

See the example:

curl -X 'GET' \
  'https://workspace.alphamoon.ai/api/v0.3/collections/c0da3bd0798e4549a1eb673887258dd3/uploaded_files' \
  -H 'accept: */*' \
  -H 'Authorization: Basic API_KEY_BASE64_ENCODED'

If a collection contains only one document, the output will retain the same format. For instance, if you upload a single PDF document, the output will also be in PDF.

On the other hand, if you upload a folder of files as a single collection, then you'll get the ZIP archive as an output.

See next:

Last updated