Literal AI icon

Literal AI

Use the Literal AI API

Overview

This node integrates with the Literal AI API to manage datasets and their components. Specifically, for the "Dataset" resource and the "Add Step" operation, it allows users to add an existing step to a specified dataset. This is useful in scenarios where you want to build or update datasets by associating them with particular processing or transformation steps that have been defined elsewhere.

Practical example: Suppose you have a dataset representing customer feedback data and a step that processes sentiment analysis on text inputs. Using this node, you can add the sentiment analysis step to your dataset so that subsequent operations or analyses consider this processing step as part of the dataset workflow.

Properties

Name Meaning
Dataset ID The unique identifier of the dataset to which you want to add a step.
Step ID The unique identifier of the step that you want to add to the dataset.

Output

The node outputs a JSON object under the json field containing the response from the Literal AI API after adding the step to the dataset. This typically includes confirmation details about the association between the dataset and the step, such as IDs and status messages.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for the Literal AI API.
  • The node uses the official Literal AI client library (@literalai/client) to interact with the API.
  • Proper configuration of the API key credential within n8n is necessary for authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Dataset ID or Step ID parameters will cause the API call to fail.
    • Incorrect or expired API key credentials will result in authentication errors.
    • Network connectivity problems may prevent successful communication with the Literal AI API.
  • Error messages:

    • Errors returned from the API are captured and included in the node output if "Continue On Fail" is enabled.
    • Typical error messages might include "Dataset not found," "Step not found," or "Unauthorized."
  • Resolutions:

    • Verify that the Dataset ID and Step ID are correct and exist in your Literal AI account.
    • Ensure the API key credential is valid and has appropriate permissions.
    • Check network connectivity and firewall settings.

Links and References

Discussion