Getting Started

Prerequisites

Before integrating an application with Quat, you need:

• A Quat user account.
• An active subscription if API keys are gated for your account.
• A bucket created in the Quat console.
• The S3-compatible endpoint URL for your Quat deployment.
• An S3 SDK or HTTP client that supports AWS Signature Version 4.

Required Credentials

Configure these values in your application:

Value	Description
S3_ENDPOINT	The S3-compatible object storage endpoint for your deployment.
S3_ACCESS_KEY	Your Quat access key.
S3_SECRET_KEY	Your Quat secret key.
S3_REGION	Region used by the SDK signer. Use the value provided by your deployment.
S3_BUCKET	Bucket name to read and write objects.
S3_USE_PATH_STYLE_ENDPOINT	Use true for local/private S3-compatible endpoints unless your deployment supports virtual-hosted bucket DNS.

S3_ENDPOINT=https://storage.example.local
S3_ACCESS_KEY=your-access-key
S3_SECRET_KEY=your-secret-key
S3_REGION=us-east-1
S3_BUCKET=my-bucket
S3_USE_PATH_STYLE_ENDPOINT=true

Create Or Obtain Credentials

1. Sign in to the Quat console.
2. Open Settings then API Keys.
3. Copy the access key.
4. Reveal the secret key by confirming your password.
5. Store the secret key in your application secret manager or .env file.

Note: The console supports regenerating keys. Regeneration invalidates existing credentials, so update running applications immediately after rotating keys.

Create A Bucket

1. Open Buckets.
2. Select Create bucket.
3. Enter a friendly name.
4. Configure at least one CORS rule if your browser application will access the bucket directly.
5. Create the bucket and copy its generated bucket name.

The customer app sends bucket creation requests with a friendly name and CORS rules. The backend returns the actual bucket identifier and name.

Upload A File

You can upload from the Quat console:

1. Open a bucket.
2. Select Upload object.
3. Choose one file up to 5 GB.
4. The original file name is used as the object name.

Application integrations should use the S3 SDK examples in the framework guides.

List Files

In the console:

1. Open a bucket.
2. Use the Objects tab.
3. Browse folders and files.

With an SDK, call ListObjectsV2 against the bucket.

Download A File

In the console, Quat requests a temporary download link from the backend, then downloads the object from that URL. In SDK integrations, call GetObject.

Delete A File

In the console:

1. Open the bucket.
2. Open the object actions menu.
3. Select delete.
4. Confirm the protected action.

With an SDK, call DeleteObject.

Common Configuration Mistakes

Symptom	Likely cause	Fix
Signature mismatch	Wrong region, endpoint, secret key, or path-style setting.	Verify every S3 env var and enable path-style endpoints.
Bucket not found	App is using a friendly label instead of the real bucket name.	Copy the bucket name from the Quat bucket details.
Connection refused	Endpoint points to the customer console instead of the storage endpoint.	Use the object storage endpoint, not http://localhost:3000.
Access denied	Subscription inactive, old keys, or wrong key pair.	Check billing status and regenerate/reveal credentials.
Browser CORS error	Bucket CORS policy does not allow the origin, method, or headers.	Add a CORS rule in the bucket CORS tab.