> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pdfnoodle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Storage Options (s3)

# 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**](https://app.gitbook.com/s/0ZiE10OwIphqlXGMhEL6/guides/saving-to-your-s3-storage).

### Configuration Options

#### `s3_bucket`

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

<img src="https://mintcdn.com/pdforge/rwoRLXXUvihWxlAY/images/api-reference/options/-s3_bucket-1.png?fit=max&auto=format&n=rwoRLXXUvihWxlAY&q=85&s=62bcafdfa992f400e787c6dc42ef8bcf" alt="" width="1256" height="656" data-path="images/api-reference/options/-s3_bucket-1.png" />

#### `s3_key`

default: `pdforge/{`[`template_id`](#user-content-fn-1)[^1]`}/`[`{auto_generated_filename}`](#user-content-fn-2)[^2]

Define the path (folders and filename, without extension) where your file will be saved inside your S3 bucket.

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

**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": "john.doe@email.com"
            },
            "details": [{"score":"100", "description":"high score"}]
    }
}
'
```

[^1]: Your template id

[^2]: An auto generated random hash
