Skip to main content
The Amazon S3 connector lets FlexOrch pull files directly from your S3 bucket using an IAM user’s access key. Once connected, you can reference the connector in processing requests or use it with Scheduled Sync to automate ingestion of new documents.

​
Prerequisites

Before you create the connector, make sure you have the following ready:
  • An active AWS account
  • An S3 bucket containing the documents you want to ingest
  • An IAM user with the following permissions on the target bucket:
    • s3:GetObject
    • s3:ListBucket
  • The IAM user’s Access Key ID and Secret Access Key

​
Create the connector

Send a POST /v1/connectors request with type: "s3" and your bucket credentials in the config object. 
curl -X POST https://api.flexorch.com/v1/connectors \
  -H "X-API-KEY: dfx_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "s3",
    "name": "my-s3-connector",
    "config": {
      "bucket": "my-documents",
      "region": "eu-west-1",
      "aws_access_key_id": "AKIA...",
      "aws_secret_access_key": "..."
    }
  }'
After creating the connector, test it to confirm FlexOrch can reach your bucket:
cURL
curl -X POST https://api.flexorch.com/v1/connectors/42/test \
  -H "X-API-KEY: dfx_your_key_here"
Never commit AWS credentials to source control or share them in plaintext. FlexOrch encrypts your connector configuration at rest, but you are responsible for keeping your IAM secret key confidential.

​
Ingest files from S3

With the connector in place, pass its id as source.connector_id and supply an array of S3 object keys you want to process.
cURL
curl -X POST https://api.flexorch.com/v1/data-process/async \
  -H "X-API-KEY: dfx_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "source": {
      "connector_id": 42,
      "keys": [
        "invoices/jan/inv_001.pdf",
        "invoices/jan/inv_002.pdf"
      ]
    }
  }'

​
Config field reference

​
bucket
string
required
The name of the S3 bucket FlexOrch will read from.
​
region
string
required
The AWS region where the bucket is hosted (e.g., us-east-1, eu-west-1).
​
aws_access_key_id
string
required
The Access Key ID for the IAM user FlexOrch will authenticate as.
​
aws_secret_access_key
string
required
The Secret Access Key paired with the above Access Key ID.
​
prefix
string
An optional key prefix (folder path) used as the default scope for Scheduled Sync — for example, contracts/. Only objects under this prefix will be polled.