- Docs
- Parameters
- defer_render
defer_render
- Recordings
Render a recording only when it’s first needed
How it works
Section titled “How it works”By default, a recording starts rendering as soon as you create it. With defer_render: true, it has the awaiting_render status until one of these happens:
- The first request for its
recording_url. That request waits for the recording to finish, then returns it. - A store request,
PUT /v1/recording/{id}/store, which renders and saves the recording without downloading it.
Checking the recording’s status or metadata doesn’t start it.
Values
Section titled “Values”true or false.
Default behavior
Section titled “Default behavior”Defaults to false. The recording starts rendering when it’s created.
When to use it
Section titled “When to use it”Use defer_render when you create recordings ahead of time but only some of them will be watched. For example, you might create one per product page and render each one the first time a visitor opens it.
Leave it off when you’ll want the recording soon, so it’s more likely to be finished by the time it’s requested.
An identical recording reused through dedupe_duration_s keeps its existing state.
Example usage
Section titled “Example usage”Create a deferred recording
Section titled “Create a deferred recording”{ "url": "https://example.com/products/42", "duration_ms": 10000, "actions": [{ "type": "simple_scroll" }], "defer_render": true}Start it without downloading
Section titled “Start it without downloading”curl -X PUT 'https://hcti.io/v1/recording/01a1b2c3-d4e5-7f60-8a9b-0c1d2e3f4a5b/store' \ -u "$HCTI_API_ID:$HCTI_API_KEY"This requires the images:store permission.
Need help?
Talk to a human. Email support@htmlcsstoimage.com and we’ll help you get started.