UseAPI icon

UseAPI

Interact with RunwayML through UseAPI
Join our community

Actions22

Overview

This node integrates with the RunwayML service via the UseAPI platform, enabling users to perform various media-related operations. Specifically, for the Runway - AI Image Description: Extract Description operation, it retrieves a descriptive textual summary of an image asset stored in RunwayML by its asset ID.

Common scenarios where this node is beneficial include:

  • Automatically generating metadata or alt text descriptions for images in content management workflows.
  • Enhancing accessibility by providing image descriptions.
  • Analyzing and cataloging large image collections by extracting semantic information.
  • Integrating image understanding into automation pipelines without manual intervention.

For example, a user can input an image asset ID, and the node will return a JSON object containing a description of the image content, which can then be used downstream for tagging, searching, or reporting.

Properties

Name Meaning
Image Asset ID The unique identifier of the image asset in RunwayML to describe. This is a required string input.

Output

The node outputs a JSON object under the json field containing the response from the RunwayML API describing the image. The structure typically includes fields such as:

  • A textual description or caption summarizing the image content.
  • Possibly additional metadata related to the image analysis.

The exact structure depends on the RunwayML API response but generally provides semantic details about the image.

No binary data output is produced by this operation.

Dependencies

  • Requires an active API key credential for UseAPI configured in n8n to authenticate requests to the RunwayML endpoints.
  • Network access to https://api.useapi.net/v1/runwayml/frames/describe/{imageAssetId} endpoint.
  • Proper configuration of the "UseAPI" credentials with valid API keys and permissions to access RunwayML services.

Troubleshooting

  • Missing or invalid API key: The node will fail if the API key credential is not set or invalid. Ensure the API key is correctly configured in n8n credentials.
  • Invalid Image Asset ID: If the provided image asset ID does not exist or is incorrect, the API may return an error or empty description. Verify the asset ID before running.
  • Network issues: Connectivity problems to the UseAPI endpoint will cause request failures. Check network settings and firewall rules.
  • Permission errors: Insufficient permissions on the API key or account may result in authorization errors.
  • Empty or unexpected response: If the API returns no description or malformed data, verify that the image asset is accessible and properly processed in RunwayML.

Error messages thrown by the node typically include HTTP status codes and messages from the API response, which help diagnose the issue.

Links and References

Discussion