Samautomation Advanced Video

Create advanced videos using Samautomation API

Actions2

Overview

This node integrates with the Samautomation API to create and monitor advanced video rendering jobs. It supports two main operations:

  • Create Advanced Video: Starts a new video render job by specifying media clips, audio settings, captions, watermark, output settings, and render options.
  • Get Render Progress: Checks the progress of an existing video render job using a task ID or full progress URL.

Typical use cases include automating video creation workflows where users want to programmatically generate videos from various media inputs and track their rendering status. For example, marketing teams can automate promotional video generation, or content creators can batch process video compilations with captions and watermarks.

Properties

Name Meaning
Operation Choose between "Create Advanced Video" (start a new render job) or "Get Render Progress" (check job status).
Task ID (For "Get Render Progress") The full progress URL or plain ID returned from the create operation to check render status.

Additional properties for "Create Advanced Video" operation (not requested but present):

  • Output Settings: Aspect ratio, resolution, framerate.
  • Main Clips: List of video/image clips with URLs and durations.
  • Audio Settings: Background music URL and volume, voice over URL and volume, ducking options.
  • Caption Elements: Captions with text, font, start time, and duration.
  • Watermark: Image URL, position, opacity, scale, margin.
  • Render Options: Quality setting (low, medium, high).

Output

  • For Create Advanced Video:

    • JSON output includes details about the created render job such as progress_url, request_id, celery_task_id, and other metadata.
    • A success flag (success: true) and the operation name are included.

  • For Get Render Progress:

    • JSON output contains the current status of the render job including state and any available metadata.
    • If the render is complete (state === "SUCCESS") and an output video URL is provided, the node attempts to download the video file.
    • The downloaded video is attached as binary data named data with MIME type video/mp4 and filename <taskId>.mp4.
    • If downloading fails, the error message is included in the JSON output under download_error.

Dependencies

  • Requires an API key credential for authenticating with the Samautomation API.
  • Uses the SamautomationClient SDK bundled with the node to interact with the API.
  • Node makes HTTP requests to fetch the rendered video file when completed.
  • No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

  • Common issues:

    • Invalid or missing API key will cause authentication failures.
    • Providing an incorrect or expired task ID for progress checking will result in errors or no data.
    • Network issues may prevent downloading the final video file.
    • Improperly formatted input properties (e.g., invalid URLs) may cause the create operation to fail.

  • Error messages:

    • Errors from the API are wrapped and thrown as node-specific errors.
    • Download errors during fetching the video file are caught and reported in the output JSON under download_error.
    • To resolve, verify credentials, ensure valid task IDs, and check network connectivity.

  • Continue on Fail:

    • If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.

Links and References

If you need details on the "Create Advanced Video" operation or other resources, please let me know!

Discussion