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, the Get Stream URL operation retrieves a streaming URL for a given instance, enabling users to access live video or screen streams of that instance.

Common scenarios where this node is beneficial include:

  • Monitoring remote virtual machines or browser sessions visually.
  • Integrating live stream URLs into dashboards or other automation workflows.
  • Accessing real-time visual feedback from instances for debugging or operational purposes.

For example, after starting an instance, you can use this node to get its stream URL and embed it in a monitoring tool or send it via notification to stakeholders.

Properties

Name Meaning
Instance ID The unique identifier of the instance for which to retrieve the stream URL.

Output

The output JSON contains the following fields:

  • success (boolean): Indicates whether the operation succeeded.
  • instanceId (string): The ID of the instance queried.
  • streamUrl (string): The URL to access the live stream of the instance.

Example output JSON:

{
  "success": true,
  "instanceId": "abc123",
  "streamUrl": "https://streaming.example.com/instance/abc123"
}

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Scrapybara API using an API key credential.
  • The node depends on the external scrapybara client library to communicate with the API.
  • Proper API credentials must be configured in n8n for authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Instance ID will cause failure to retrieve the stream URL.
    • Network or API connectivity problems may result in errors.
    • Insufficient permissions or expired API keys can prevent successful calls.

  • Error messages:

    • Failed to get stream URL of instance <ID>: <error message> indicates the node could not retrieve the URL. Check if the instance ID is correct and the API key is valid.
    • General network errors suggest verifying internet connectivity and API endpoint accessibility.

  • Resolution tips:

    • Confirm the instance exists and is running.
    • Verify API credentials are correctly set up and have required permissions.
    • Retry after ensuring stable network conditions.

Links and References

Discussion