Remote Sources

The integration with Remote Sources is a key feature that extends the platform's capabilities to include cloud-based file handling. This functionality allows users to easily reference and process files stored in remote blob containers across various cloud providers, including AWS, GCP, and Azure.

This section of the API documentation provides detailed guidance on how to utilize Remote Sources within Alfred. It outlines the process of accessing and uploading files from these external storage options directly into the Alfred platform for processing. Users can leverage the /api/file/upload endpoint to specify the source name, container, and file name, effectively linking Alfred to their remote storage.

The documentation will cover essential aspects such as authentication, configuration of source names, and the necessary parameters for identifying and accessing files in different cloud environments. It will also provide examples and best practices for smoothly integrating remote blob containers with Alfred, ensuring users can harness the full potential of cloud storage in conjunction with Alfred's robust document processing capabilities.

This Remote Sources feature is designed to offer flexibility and efficiency, enabling users to seamlessly incorporate cloud-stored documents into their IDP workflows within Alfred. Whether it's processing files stored on AWS S3 buckets, Azure Blob Storage, or Google Cloud Storage, this section will equip users with the knowledge to effectively manage and process their documents from various cloud platforms.

Create remote source

POST https://tagshelf.host/api/source/create

Creates an object storage source. These are external sources of data which can be referenced as a source for file uploads. A successful response will be returned in JSON with the source unique identifier and name.

Headers

Name	Type	Description
Content-Type*	String	application/json
Authorization	String	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	String	Application API Key

Request Body

Name	Type	Description
source_name	String	Name of your remote source
access_key	String	Access key (used on AWS and DO)
secret_key	String	Secret key to access remote resource.
account_name	String	Name of the account/bucket.
region	String	Region in which the resource is hosted.
type	String	Cloud provider to be used. Supported providers are AWS, DO and Azure.

200 OK

{
  "id": "559167cb-4c76-4e28-bf15-34cbf614119c",
  "source_name": "REMOTE SOURCE"
}

Get all remote sources

GET https://tagshelf.host/api/source/list

Returns a list of configured object storage sources. A successful response will be returned in JSON with a list of source unique identifiers and names as well as its creation date. Anatomy of the Request

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	string	<app_api_key>

200 OK

[
{
  "id": "559167cb-4c76-4e28-bf15-34cbf614119c",
  "source_name": "my remote source"
},
{
  "id": "559167cb-4c76-4e28-bf15-34cbf614219c",
  "source_name": "my remote source 2"
}
]

Remove remote source

DELETE https://tagshelf.host/api/source/remove/:name

Removes a given configured object storage source A successful response will be returned in JSON will the removed's source unique identifier and name.

Path Parameters

Name	Type	Description
name	String	Name of the remote source

Headers

Name	Type	Description
Content-Type	String	application/json
Authorization	String	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	String	<app_api_key>

200 OK

{
  "id": "559167cb-4c76-4e28-bf15-34cbf614119c",
  "source_name": "my remote source"
}