← Tools Reference

RenderForm

RenderForm integration (Design & Media, Developer Tools). Imported from open-connector.

API key6 toolshttps://get.renderform.io
GET
renderform_get_usage
Get current RenderForm credit usage for the API key and return a normalized usage summary.

/api/v1/usage

GET
renderform_list_templates
List RenderForm templates with optional pagination and filters for name, tags, and source template ID.

/api/v2/my-templates

5 parameters
ParamTypeRequiredDescription
namestringoptionalOptional template name filter.
pageintegeroptionalZero-based page number.
sizeintegeroptionalNumber of templates to return per page.
tagsarrayoptionalTemplate tags used to filter the template list.
sourceTemplateIdstringoptionalOptional source template identifier used to filter cloned templates.
GET
renderform_get_template
Get one RenderForm template by identifier and return its normalized template details.

/api/v2/my-templates/{templateId}

1 parameter
ParamTypeRequiredDescription
templateIdstringrequiredTemplate identifier to retrieve.
POST
renderform_render_image
Render one RenderForm image or PDF from a template and return the request identifier, file URL, and echoed request.

/api/v2/render

9 parameters
ParamTypeRequiredDescription
templatestringrequiredTemplate identifier to render.
dataobjectoptionalTemplate data object forwarded to RenderForm for placeholder replacement.
fileNamestringoptionalOptional custom output file name.
webhookUrlstringoptionalOptional webhook URL called by RenderForm after rendering completes.
metadataobjectoptionalArbitrary metadata object stored together with the generated RenderForm result.
versionstringoptionalOptional cache-busting version string used to force a fresh render.
widthintegeroptionalOptional output width in pixels.
heightintegeroptionalOptional output height in pixels.
waitTimeintegeroptionalOptional wait time in milliseconds before rendering begins.
GET
renderform_list_results
List RenderForm generated results with pagination and optional template or batch filters.

/api/v2/results

4 parameters
ParamTypeRequiredDescription
pageintegeroptionalZero-based page number.
sizeintegeroptionalNumber of results to return per page.
batchstringoptionalOptional batch identifier filter.
templatestringoptionalOptional template identifier filter.
POST
renderform_take_screenshot
Capture one website screenshot with RenderForm and return the request identifier, file URL, and echoed request.

/api/v1/screenshots

4 parameters
ParamTypeRequiredDescription
urlstringrequiredWebsite URL to capture.
widthintegerrequiredScreenshot width in pixels.
heightintegerrequiredScreenshot height in pixels.
waitTimeintegeroptionalOptional wait time in milliseconds before capture.