JoggAI icon

JoggAI

Interact with the JoggAI API to create and manage AI videos
Join our community

Actions22

Overview

This node interacts with the JoggAI API to manage various AI-related resources, including visual styles. Specifically, the "Visual Style" resource with the "Get" operation allows users to retrieve a list of visual styles filtered optionally by aspect ratio. This is useful when you want to fetch predefined visual style templates that match certain display formats for videos or images, such as portrait, landscape, or square.

Practical examples include:

  • Fetching all available visual styles to present options in a UI.
  • Filtering visual styles to only those suitable for portrait-oriented content (9:16 aspect ratio).
  • Automating video creation workflows where the visual style must match the target device's screen orientation.

Properties

Name Meaning
Aspect Ratio Optional filter to limit visual styles by aspect ratio. Options:
- All (no filtering)
- Portrait (9:16)
- Landscape (16:9)
- Square (1:1)

Output

The output is a JSON array containing the visual styles retrieved from the JoggAI API according to the specified filters. Each item in the output represents a visual style object with its associated properties (not detailed here due to source code scope). The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the JoggAI API.
  • The node depends on the external JoggAI service being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Network connectivity problems may cause request failures.
    • Invalid or missing API credentials will result in authentication errors.
    • Using an unsupported aspect ratio value could lead to empty results or errors.

  • Error messages:

    • "request failed: <error message>" indicates an issue during the API call. Check network, credentials, and parameter correctness.
    • If the node is set to continue on failure, errors will be returned as part of the output JSON with an error field describing the problem.

  • Resolutions:

    • Verify API key validity and permissions.
    • Ensure the aspect ratio property is set to one of the allowed options.
    • Confirm network access to the JoggAI API endpoint.

Links and References

Discussion