Sign in

v1

latestOpenAPI 3.1.02026-08-06244570.4 KB
Integrations

Save S3 configuration

Save or update S3-compatible storage configuration.

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

Usage: Configure your S3-compatible storage to receive generated PDFs directly in your own bucket instead of the default CDN.

Supported providers:

  • Amazon S3
  • DigitalOcean Spaces
  • Cloudflare R2
  • MinIO
  • Any S3-compatible storage

Secret key behavior:

  • For new configuration: secret_access_key is required
  • For updates: Omit secret_access_key to keep existing value

No credits consumed: This is a configuration endpoint.

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

post/v1/integrations/s3

Request body

endpoint_urlstring required

S3-compatible endpoint URL. Must start with https://

access_key_idstring required

Access key ID for S3 authentication

secret_access_keystring nullable

Secret access key. Required for new configuration, optional for updates (keeps existing if omitted)

bucket_namestring required

S3 bucket name. Must follow S3 naming conventions (lowercase, no underscores)

default_prefixstring

Default path prefix for uploaded files. Can include slashes for folder structure

Example request

{
  "access_key_id": "AKIAIOSFODNN7EXAMPLE",
  "bucket_name": "my-pdf-bucket",
  "default_prefix": "generated/pdfs/",
  "endpoint_url": "https://s3.amazonaws.com",
  "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}

Response

Configuration saved successfully

successboolean required

Whether the operation succeeded

Example response

{
  "success": true
}