UseAPI icon

UseAPI

Interact with RunwayML through UseAPI
Join our community

Actions22

Overview

The node integrates with the RunwayML service via the UseAPI platform, specifically supporting the "Gen-4 Create" operation under the "Runway" resource. This operation generates a video using Runway's Gen-4 model based on an initial image asset and optional text prompt.

Typical use cases include:

  • Creating AI-generated videos starting from a specific image asset.
  • Enhancing creative workflows by generating video content with specified aspect ratios and durations.
  • Automating video generation tasks in pipelines where input images and descriptive prompts are available.

For example, a user can provide the ID of a first image asset and optionally describe the desired video content with a text prompt. The node then requests RunwayML to generate a video of specified length and aspect ratio, returning metadata about the generated video task.

Properties

Name Meaning
First Image Asset ID ID of the first image asset to start the video generation. Use "Get Assets" operation to find assets.
Text Prompt Optional description of the desired video content to guide generation with Gen-4.
Aspect Ratio Aspect ratio of the generated video. Options: 16:9 (Landscape), 9:16 (Portrait), 1:1 (Square), 4:3, 3:4, 21:9 (Widescreen)
Duration (Seconds) Length of the generated video in seconds. Options: 5 or 10 seconds.
Additional Options Collection of optional parameters:
- Seed Random seed number for generation (range 1-4294967294). Leave empty for random seed.
- Explore Mode Boolean flag to enable Explore mode (available for Runway Unlimited plan), which does not consume credits.
- Reply URL URL to receive asynchronous notifications when generation completes or fails.
- Reply Reference User-defined reference ID included in the response for tracking purposes.
- Max Jobs Maximum number of parallel jobs allowed (range 1-10).

Output

The node outputs JSON data representing the response from the RunwayML Gen-4 create API endpoint. This typically includes:

  • Metadata about the created generation task, such as task ID, status, timestamps.
  • Details about the requested video generation parameters.
  • Possibly URLs or references to the generated video once completed (depending on API response).

No binary data is directly output by this operation; it focuses on task creation and metadata.

Dependencies

  • Requires an API key credential for UseAPI that has access to RunwayML services.
  • The node makes HTTP POST requests to the endpoint https://api.useapi.net/v1/runwayml/gen4/create.
  • For receiving asynchronous notifications, users can specify a webhook URL (Reply URL).
  • No other external dependencies are required.

Troubleshooting

  • Missing or invalid API key: The node requires a valid API key credential. Ensure the credential is configured correctly.
  • Invalid or missing First Image Asset ID: The operation requires a valid existing image asset ID. Use the "Get Assets" operation to verify asset IDs.
  • Operation cancelled due to missing confirmation: Not applicable here but other operations require explicit confirmation.
  • Seed value out of range: If specifying a seed, ensure it is within the allowed range (1 to 4294967294).
  • Network or API errors: Check connectivity and API status. Error responses include HTTP status codes and messages.
  • Explore Mode usage: Only available for users with Runway Unlimited plans; enabling without proper plan may cause errors.
  • Max Jobs limits: Ensure the maxJobs parameter is between 1 and 10 to avoid rejection.

If the node encounters an error and "Continue On Fail" is enabled, it will output error details in the JSON response for easier debugging.

Links and References

Discussion