Storage Options (s3)

Setting Up S3 Storage

You’re on the High plan and want to store your files in a custom S3 bucket? We’ve got a full guide on how to set up S3 connections and switch the default bucket directly from the dashboard. Check out the guide.

Configuration Options

`s3_bucket`

Set this to the ID of an active S3 connection to override the default storage location.

`s3_key`

default: pdforge/{template_id¹}/{auto_generated_filename}² Define the path (folders and filename, without extension) where your file will be saved inside your S3 bucket.

Don’t include the file extension — we’ll handle that based on the file type (e.g., .pdf, .png).

Here’s a request example for a synchronous render:

curl --location 'https://api.pdfnoodle.com/v1/pdf/sync' \
--header 'Authorization: Bearer pdfnoodle_api_123456789' \
--header 'Content-Type: application/json' \
--data '{
    "templateId": "template_id",
    "s3_bucket": "s3_123456789",
    "s3_key": "path/to/your/file",
    "data":{
            "currentDDate": "01/12/2025",
            "user": {
                    "name":"John Doe",
                    "email": "[email protected]"
            },
            "details": [{"score":"100", "description":"high score"}]
    }
}
'

Your template id ↩
An auto generated random hash ↩