search

Upload File

A guide on how to upload files via Base64 and Binary endpoints

hashtag
Uploading a file in a nutshell

Alphamoon Workspace supports a variety of file formats such as DOCX, XLSX, PDF (editable and scanned), PNG, JPG, TIFF, and more.

circle-info

File formats Want to know more about the type of files you can upload to Alphamoon Workspace? Visit the Supported Document Types tab.

To upload a file to a process, a user needs to know process_id. If you want to know where to find it visit the Get the Process ID tab.

circle-info

Note It is up to you whether you upload your files using Base64 or the Binary endpoints.

hashtag
Base64

Base64 Encoding is the most widely used technique for storing or transmitting binary data by converting it to text.

hashtag
Upload a file (Base64)

POST /api/v0.3/processes/{process_id}/files/base64

Upload the file using the process_id.

hashtag
Path Parameters

Name
Type
Description

process_id*

String

The id of the process for which you want to upload the file.

{
  "id": "b6e07480bb2a4ea59a4b5855814585d8",
  "collectionId": "223742cc9bca43fd81b2d41b0018e4c7",
  "name": "faktura.pdf",
  "status": "Queued",
  "progress": 0,
  "numberOfPages": null,
  "createdAt": "2023-06-07T11:18:19Z",
  "updatedAt": "2023-06-07T11:18:19Z",
  "metadata": {}
}

hashtag
See the example

hashtag
Binary

Binary file upload refers to the process of transferring and uploading files that contain binary data, such as images, documents, or any other non-text-based files. Unlike plain text files, binary files consist of a sequence of bytes that represent the encoded data of the file.

hashtag
Upload file (Binary)

POST /api/v0.2/processes/{process_id}/files/binary

Upload the file by using the process_id.

hashtag
Path Parameters

Name
Type
Description

process_id*

String

The id of the process for which you want to upload the file.

hashtag
Request Body

Name
Type
Description

Request body*

String

multipart/form-data

hashtag
See the example

circle-check

Success!

Once a file is uploaded, data extraction starts automatically. The response contains collection_id needed later to get the results.

hashtag
See next:

PreviousGet collectionsNextUpdate collection

Last updated