Skip to main content
Connectors give FlexOrch direct read access to your cloud storage buckets so you can ingest documents without uploading them manually. Once a connector is set up, you can reference it in processing requests or pair it with Scheduled Sync to build a fully automated ingestion pipeline.

​
Supported connectors

ConnectorType string
Amazon S3s3
Google Cloud Storagegcs
Azure Blob Storageazure_blob

​
Create a connector

Send a POST /v1/connectors request with the connector type, a human-readable name, and a config object containing the credentials and bucket details for your chosen provider. 
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": "production-docs",
    "config": {
      "bucket": "my-documents",
      "region": "us-east-1",
      "aws_access_key_id": "AKIA...",
      "aws_secret_access_key": "..."
    }
  }'

​
Test a connector

After creating a connector, verify that FlexOrch can reach your bucket by calling the test endpoint. A successful response confirms that your credentials and permissions are valid.
cURL
curl -X POST https://api.flexorch.com/v1/connectors/42/test \
  -H "X-API-KEY: dfx_your_key_here"
Response
{
  "success": true,
  "message": "Connection established successfully."
}

​
Use a connector in a processing request

Pass source.connector_id along with a source.keys array of object paths to submit specific files from your bucket for processing.
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": [
        "contracts/q4/agreement_001.pdf",
        "contracts/q4/agreement_002.pdf"
      ]
    }
  }'
Connectors also power Scheduled Sync. Configure a schedule and FlexOrch will automatically detect and process new files added to your bucket — no manual intervention needed.

​
Connector guides

Amazon S3

Connect using IAM credentials and an S3 bucket.

Google Cloud Storage

Connect using a GCP service account JSON key.

Azure Blob Storage

Connect using an Azure Storage account and access key.