Orshot TemplatesInstall

Overview

This node integrates with the Orshot API to generate various types of images based on customizable templates. It is useful for automating the creation of visual content such as social media screenshots, website snapshots, link previews, word definitions, comparison graphs, app store screenshots, beautified screenshots, Instagram posts, iPhone mockups, notes screenshots, Open Graph images, bar graphs, and testimonials.

Typical use cases include:

• Automatically generating styled tweet screenshots or Instagram post images for social media marketing.
• Creating website or app screenshots for documentation or promotional materials.
• Producing custom Open Graph images for blog posts or products to enhance link sharing previews.
• Generating visually appealing comparison graphs or bar charts from data.
• Automating the creation of word definition cards or testimonial visuals.

For example, a user can input a Tweet ID and customize colors and layout options to generate a branded tweet screenshot image automatically.

Properties

Example of some template parameter groups:

• Tweet Screenshot Parameters (tweet-imageParams):

  • Canvas Background Color, Tweet ID, Tweet URL, Hide Date/Time, Hide Media, Padding, Width, Tweet Text Color, etc.

• Website Screenshot Parameters (websitescreenshotParams):

  • Website URL, Delay (ms), Full Capture (boolean), Width, Height.

• Link Preview Image Parameters (linkpreviewimageParams):

  • Title, Author, URL, Background Color, Font Family, Width, etc.

• Word Definition Image Parameters (worddefinitionimageParams):

  • Word, Meaning, Colors, Font Sizes, Width, Height, Font Family.

• Comparison Graph Parameters (comparisongraphParams):

  • Metric Names, Current Values, Previous Values, Colors for bars and text, Padding, Width, Description.

• App Store Screenshot Simple Parameters (appstorescreenshotsimpleParams):

  • Title, Screenshot Image URL, Size Variant, Background Color, Text Color.

• Beautify Screenshot Parameters (beautifyscreenshotParams):

  • Background Color, Border Radius, Padding, Width, Height, Background Pattern, Screenshot Shadow.

• Instagram Post Image Parameters (instagrampostimageParams):

  • Username, Caption, Likes Count, Profile Picture URL, Post Image URL, Verified (boolean), Width, Height.

• iPhone 14 Mockup Parameters (iphone14mockupParams):

  • Screenshot Image URL, Width, Height, Omit Background (boolean).

• Notes Screenshot Parameters (iphonenotesscreenshotParams):

  • Title, Content, Folder Text, Font Sizes, Hide Icons (hamburger, redo, share, undo), Width.

• Open Graph Image Parameters (multiple variants like opengraphimage1Params, opengraphimage2Params, etc.):

  • Title, Description, Background Color/Image, Text Color, User Info, Logo URL.

• Simple Bar Graph Parameters (simplebargraphParams):

  • Labels, Values, Colors for bars and labels, Background Image URL, Padding, Width, Height.

• Testimonial Screenshot Parameters (testimonialscreenshotParams):

  • Author Name, Photo URL, Description, Rating, Testimonial Text, Font Sizes, Width.

Output

The node outputs an array of JSON objects, each containing the response from the Orshot API for the generated image. The key information in the output JSON includes:

• A URL pointing to the generated image in PNG format.

The output JSON structure looks like this (example):

{
  "url": "https://generated-image-url.png",
  "otherMetadata": { ... }
}

No binary data is directly output by the node; instead, the image is provided as a URL that can be used downstream.

Dependencies

• Requires an API key credential for the Orshot API to authenticate requests.
• The node makes HTTP POST requests to https://api.orshot.com/v1/generate/images.
• No additional environment variables are required beyond the API authentication setup.

Troubleshooting

• Common issues:

  • Invalid or missing API key credential will cause authentication failures.
  • Incorrect or incomplete template parameters may result in API errors or unexpected image outputs.
  • Network connectivity issues can prevent successful API calls.
  • Providing invalid URLs or IDs (e.g., Tweet ID) may cause the API to fail generating the image.

• Error messages:

  • Authentication errors typically indicate problems with the API key; ensure the credential is correctly configured.
  • Validation errors from the API usually specify which parameter is invalid or missing; review the input properties carefully.
  • Timeout or network errors suggest connectivity problems; retry or check network settings.

• Resolution tips:

  • Verify API credentials and permissions.
  • Double-check all required parameters for the selected template.
  • Use valid and accessible URLs or IDs.
  • Test with minimal parameters first, then add customization incrementally.

Links and References

• Orshot API Documentation (assumed official docs for reference)
• n8n HTTP Request Node documentation for understanding HTTP authentication and request handling.
• General resources on image generation APIs and social media screenshot tools.