File Service

File Service provides file upload, retrieval, download, and share-link behavior behind the OpenEdge gateway.

When to Use It

Use File Service when your application needs:

• Temporary or permanent file distribution.
• Public download links.
• User-owned file metadata.
• Billing and API-key enforcement around file operations.

API Surface

Authenticated file operations are routed under:

/v1/apps/file/*

Public download/share routes are available under:

/v1/apps/file/download/*
/v1/apps/file/share/*

The gateway validates API keys and records usage for authenticated file requests before forwarding to the bound file service worker.

Service Configuration

Create a File Service instance in the console:

{
  "service_id": "file",
  "alias": "default",
  "config": {
    "root_folder": "my-bucket",
    "public_access": true
  },
  "status": "active"
}

root_folder scopes stored files under a customer-specific prefix. public_access controls whether public-read style workflows are enabled for that instance.

Authentication

Use an API key for authenticated file operations:

X-API-Key: sk_xxx

Recommended scopes:

file:read
file:write

Billing Notes

File operations can be charged per upload, retrieval, or storage policy. The current commercial model recommends prepaid balance with transaction logs for billable actions.