Storage Integration

ScreenshotAPI gives you the ability to integrate third-party storage services such as Wasabi,Amazon S3, andGoogle Cloud Storage for storing your captured screenshots, PDFs, or videos. This integration allows you to automatically route your capture outputs directly into your own storage buckets, ensuring secure, scalable, and centralized file management.

You can configure multiple buckets per service, choose a default bucket for fallback, and dynamically select storage destinations per request. This provides full flexibility based on your project or team requirements.

To configure a storage service, go to the Storage Integration tab in your ScreenshotAPIDashboard, where you can add and manage your storage credentials and buckets with ease.

This setup is ideal for organizations that want to maintain ownership of their data while leveraging ScreenshotAPI's automation and capture capabilities.

Each storage integration requires a few essential fields:

• endpointUrl: The base URL used to interact with the storage service (e.g.,https://s3.eu-central-2.wasabisys.comfor Wasabi).
• accessKey: Your storage service’s public key used for authentication.
• secretKey: The private key paired with your access key for secure API access.
• region: The geographical region of your bucket (e.g., us-east-1).
• bucketName: The name of your storage bucket where files will be uploaded.
• projectId: Required only for Google Cloud Storage; it specifies the GCP project associated with the bucket.

After providing the required credentials for the selected storage service, the user must test the connection to the bucket to ensure that all configurations are valid and the integration is functioning correctly. This validation step helps prevent storage errors during actual screenshot operations and ensures the system has proper access to the specified bucket.

Following is the API endpoint that demonstrates how to use your configured bucket for saving screenshots:

https://shot.screenshotapi.net/v3/screenshot?token={token}&url=www.google.com&byob=true&storage_service=wasabi&bucket_name={bucket}

Replace token with yourAPI TOKENand bucket_name with the name of your integrated bucket.

Required Parameters

Bring Your Own Bucket (BYOB)

Allows the use of a custom storage bucket that has already been configured under the Storage Integrations tab. This enables direct saving of screenshots to your own cloud bucket instead of the default storage.

Default value:false.

Note: Make sure the storage integration is properly set up and tested before enabling this parameter.

Optional Parameters

If the optional parameters are not provided while byob is enabled, ScreenshotAPI will automatically use the default configured storage service and bucket associated with your account. This ensures seamless operation without requiring these fields in every request. However, it is recommended to explicitly provide these parameters when managing multiple storage services or buckets to avoid ambiguity and ensure data is stored in the intended location.

Storage Service

Specifies which storage service to use for saving the screenshot whenbyob is enabled and multiple services are already configured. This must match the exact name of the service listed in the Storage Integrations tab (e.g., aws, wasabi, google_cloud).

Default value:' '.

Note: This parameter is required when byob is set to true. Ensure the selected service is correctly configured and tested.

Bucket Name

Specifies the name of the storage bucket to which the screenshot will be saved when byob is enabled. This must match the exact bucket name configured under the Storage Integrations tab. Specify this if you have multiple buckets configured under the same service.

Default value:' '.

Note: This parameter is required when byob is set to true. Ensure the bucket is correctly configured and accessible.