API Reference
HomeChangelogAcademy

Custom Variables

Inject dynamically Data into the prompt.

ℹ️

You can inject dynamically custom variables into your prompt.

Overview

Custom Variables allow you to dynamically inject data into your prompts, enhancing the capabilities and relevance of your Assistant. By integrating custom data fields via API requests, you can tailor the Assistant's responses to specific contexts, such as a user's role or company-specific information.

Use Cases

  • Personalization: Tailor responses based on user-specific information (e.g., name, role, preferences).
  • Contextual Relevance: Provide responses that are relevant to a specific business or operational context.
  • Dynamic Content: Update the content of prompts based on changing variables.

How to Use Custom Variables

  1. Define Custom Variables: Identify the key pieces of information that are relevant to your use case. For example, user roles, company names, or specific settings.
  2. Add Variables to API Request: Incorporate these custom variables into your API request as a JSON object. This enables the Assistant to access and utilize this data in its responses.
  3. Integrate with Synthflow Dashboard: Ensure that these variables are also recognized and managed within your Synthflow Dashboard for consistency and control. Detailed instructions here.

Example of Custom Variables

"custom_variables": [
    "Company: Synthflow",
    "Role: Sales Specialist"
]