v1

latestOpenAPI 3.1.02026-08-06244570.4 KB

Integrations

Get S3 configuration

Get current S3 storage configuration.

Authentication: API Key required (x-api-key header)

Usage: Retrieve your S3 integration settings. Secret access key is masked for security.

Returns 404 if S3 is not configured.

No credits consumed: This is a read-only endpoint.

Rate Limits: 60 requests/min (free), 120 requests/min (paid). Headers included in response.

get/v1/integrations/s3

Response

S3 configuration retrieved successfully

configuredboolean required

Whether S3 is configured

endpoint_urlstring required

S3-compatible endpoint URL

access_key_idstring required

Access key ID

secret_access_key_maskedstring required

Masked secret access key (shows first 4 and last 4 characters)

bucket_namestring required

S3 bucket name

default_prefixstring required

Default path prefix for uploads

Example response

{
  "access_key_id": "AKIAIOSFODNN7EXAMPLE",
  "bucket_name": "my-pdf-bucket",
  "configured": true,
  "default_prefix": "generated/pdfs/",
  "endpoint_url": "https://s3.amazonaws.com",
  "secret_access_key_masked": "wJal...EKEY"
}