Mindz icon

Mindz

Interact with Mindz API

Actions116

Overview

The node interacts with the Mindz API to manage various resources, including courses. Specifically, for the Course - Create operation, it allows users to create a new course within the Mindz platform. This is useful in scenarios where an organization wants to programmatically add new educational courses to their system, such as onboarding new training modules or launching new learning content.

Practical examples include:

  • Automatically creating courses when new training programs are designed.
  • Integrating course creation into a larger workflow that manages educational content lifecycle.
  • Syncing courses from external systems into Mindz without manual input.

Properties

Name Meaning
Name The name/title of the course to be created. This is a required string property.
Description A textual description of the course. Optional and used to provide additional details.

Output

The node outputs JSON data representing the newly created course object returned by the Mindz API. This typically includes fields such as the course ID, name, description, creation timestamps, and other metadata defined by the API.

If the node supports binary data output (not indicated here), it would represent associated files or media related to the course, but this is not evident from the provided code.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2-based API key credential.
  • The node depends on the Mindz API being accessible and properly authenticated.
  • No other external dependencies are indicated.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to create courses.
  • Missing required properties: The "Name" property must be provided; otherwise, the API will reject the request.
  • API connectivity issues: Network problems or incorrect endpoint configurations can cause failures.
  • Invalid input formats: Make sure the input values conform to expected types (e.g., strings for name and description).

Common error messages might include unauthorized access, validation errors for missing or invalid fields, or server errors if the Mindz API is down.

Links and References

  • Mindz API documentation (general reference for endpoints and data models)
  • OAuth2 authentication setup guides for n8n integrations
  • n8n documentation on creating custom nodes and handling API credentials

Discussion