Scrapybara icon

Scrapybara

Interact with the Scrapybara API
Join our community

Actions8

Overview

This node integrates with the Scrapybara API to manage and interact with virtual instances. Specifically, for the Instance - Screenshot operation, it allows users to capture a screenshot of a specified instance. This is useful in scenarios where you want to visually verify the state of an instance remotely, such as monitoring a browser session, checking the UI of a remote desktop, or capturing evidence during automated testing.

Practical examples:

  • Taking a screenshot of a running Ubuntu or Windows instance to verify that a process has completed.
  • Capturing the current screen of a browser instance to monitor web page rendering.
  • Automating visual checks in workflows that require confirmation of GUI states.

Properties

Name Meaning
Instance ID The unique identifier of the instance from which to take the screenshot. This is required to specify the target instance.

Output

The output JSON contains the following fields:

  • success: A boolean indicating whether the screenshot was successfully captured.
  • instanceId: The ID of the instance for which the screenshot was taken.
  • screenshot: The screenshot data returned by the API. This is typically image data encoded in a format provided by the Scrapybara API (e.g., base64-encoded PNG).

If the operation fails, an error message will be thrown describing the failure.

Dependencies

  • Requires an active connection to the Scrapybara API via an API key credential.
  • The node depends on the external scrapybara client library to communicate with the API.
  • Proper configuration of the API key credential within n8n is necessary for authentication.

Troubleshooting

  • Common issues:

    • Invalid or expired instance ID: Ensure the instance ID exists and is currently active.
    • Network or API connectivity problems: Verify network access and API key validity.
    • Permission errors: Confirm that the API key has sufficient permissions to perform screenshot operations.

  • Error messages:

    • Failed to capture screenshot of instance <ID>: <error message>: Indicates the screenshot request failed. Check the instance status and API credentials.

  • To resolve errors, verify the instance ID correctness, ensure the instance is running, and confirm the API key is valid and authorized.

Links and References

Discussion