Octave icon

Octave

Interact with the Octave V2 API

Actions26

Overview

The "Agent - Personalize Template" operation allows users to personalize a template using an agent identified by its OId (Object ID). This node is useful for dynamically customizing content such as emails, messages, or documents based on specific personal and company information. It supports additional runtime context and instructions in JSON format to further tailor the output.

Practical examples include:

  • Generating personalized email templates for marketing campaigns by injecting recipient details.
  • Customizing sales outreach messages with job titles and LinkedIn profiles.
  • Creating dynamic content for onboarding or customer support communications.

Properties

Name Meaning
Agent OId Name or ID The unique identifier of the agent to run. Choose from a list or specify an ID via expression.
Company Domain Optional company domain (e.g., example.com) to personalize the template.
Company Name Optional name of the company for personalization.
Email Optional email address of the person to personalize the template.
First Name Optional first name of the person for personalization.
Job Title Optional job title of the person to customize the content.
LinkedIn Profile URL Optional LinkedIn profile URL of the person for richer personalization.
Output Format Desired output format: either plain text or JSON structured output.
Runtime Context (JSON) Optional additional JSON object providing runtime context for the personalization process.
Runtime Instructions (JSON) Optional JSON object containing extra instructions to guide how the template should be personalized.
Additional Inputs (JSON) Optional JSON object for any other inputs the agent might accept, e.g., custom fields or template IDs.

Output

The node outputs a JSON array where each item contains the personalized content generated by the agent. The main output field is json, which holds the personalized template result in the chosen format (text or json). If binary data were involved, it would typically represent files or attachments, but this operation focuses on textual or structured JSON output.

Dependencies

  • Requires an API key credential for authenticating with the Octave V2 API.
  • The node depends on the Octave service's agent functionality to perform template personalization.
  • No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

  • Common issues:

    • Invalid or missing agent OId can cause failures; ensure the correct agent is selected or specified.
    • Malformed JSON in runtime context, instructions, or additional inputs may lead to parsing errors.
    • Network or authentication errors if the API key is invalid or expired.

  • Error messages:

    • Errors returned from the API will be included in the output under an error field with possible apiResponse details.
    • Parsing errors for JSON inputs will indicate failure to parse the provided JSON string.

  • Resolutions:

    • Verify the agent OId is correct and accessible.
    • Validate all JSON inputs before running the node.
    • Check API key validity and permissions.

Links and References

Discussion