Using ms_delay
Adjust rendering delay to capture dynamic content
Table of contents
When to use ms_delay
Important
Most users don’t need ms_delay. Only use this parameter if you notice missing content in your screenshots.
The ms_delay
parameter should only be used when:
- Your screenshots are missing expected content
- Dynamic content isn’t appearing in the final image
- Custom fonts or images aren’t loading properly
How it works
When content is missing from your screenshots, the ms_delay
parameter lets you add a delay before capture. This can help with:
- JavaScript that needs time to execute
- Assets (images, fonts) still loading
- Animations not completing
- Dynamic content not appearing
Default behavior
By default, the API intelligently handles most loading scenarios:
- Waits for the page to fully load
- Detects when assets finish loading
- Automatically manages common JavaScript frameworks
Only add ms_delay
if you notice issues with the default behavior.
Image credits and billing
Credit usage
The ms_delay
parameter can affect how many image credits are consumed per request:
Delay Range (ms) | Credits Used | Example Usage |
---|---|---|
0-5000 | 1 credit | Standard usage, suitable for most cases |
5001-10000 | 2 credits | Complex pages with many assets |
10001-15000 | 3 credits | Heavy JavaScript applications |
15001-20000 | 4 credits | Maximum delay scenarios |
Important notes
- Maximum allowed value is 20,000ms (20 seconds)
- Values are rounded up to the nearest credit tier
- Credits are calculated before the request is processed
Cost optimization
To minimize credit usage, try optimizing your page load time before increasing ms_delay. Consider using render_when_ready for precise timing control.
Examples
// Standard usage (1 credit)
{
"html": "<div>Your content</div>",
"ms_delay": 3000
}
// 2 credits used
{
"html": "<div>Your content</div>",
"ms_delay": 8000
}
// 4 credits used (maximum)
{
"html": "<div>Your content</div>",
"ms_delay": 20000
}
Alternatives to high ms_delay values
Instead of using high ms_delay
values, consider:
- Using the
render_when_ready
parameter - Optimizing your page load time
- Preloading assets
- Reducing JavaScript execution time
This can help reduce both credit usage and overall processing time.