AI Tools Widget Module

The AI Tools Widget module allows you to enhance the Crowdin Editor’s AI Assistant by integrating custom data visualizations. By creating this type of app, you can provide interactive graphical representations of project data, such as translation progress, contributor activity, quality metrics, etc. These visualizations are rendered directly in the Editor and enable the AI Assistant to present complex information in a more accessible and insightful manner, helping users make informed decisions.

Access

You can grant access to this module to one of the following user categories:

For Crowdin:

• Only me (i.e., project owner)
• All project members
• Selected users

For Crowdin Enterprise:

• Only organization admins
• All users in the organization projects
• Selected users

Structure

manifest.json

{
  "modules": {
    "ai-tools-widget": [
      {
        "key": "custom-data-visualization",
        "toolType": "function",
        "function": {
          "name": "display_custom_graph",
          "description": "Render a custom graph based on project-specific data.",
          "parameters": {
            "type": "object",
            "properties": {
              "dataType": {
                "type": "string",
                "description": "The type of data to visualize (e.g., 'translation progress', 'quality assurance')."
              },
              "timeFrame": {
                "type": "string",
                "description": "The time frame for the data (e.g., 'last_week', 'last_month')."
              }
            },
            "required": ["dataType", "timeFrame"]
          }
        },
        "url": "/ai-tools-widget/display_custom_graph/index.html"
      }
    ]
  }
}

Properties

key	Type: string Required: yes Description: Module identifier within the Crowdin app.
toolType	Type: string Required: yes Allowed value: function Description: Type of the tool used in the module.
function.name	Type: string Required: yes Description: The human-readable name of the function.
function.description	Type: string Required: yes Description: The description of what the function does. Helps AI understand how and when to use it.
function.parameters	Type: object Required: no Description: The list of input parameters used by the function. Follows JSON Schema structure.
url	Type: string Required: yes Description: The relative URL to the widget HTML file that will be rendered in the Crowdin Editor UI. The url should point to a static HTML file bundled with your Crowdin App that contains the widget’s UI and logic.

Behavior

Unlike the AI Tools module, which receives a structured payload from the AI Assistant as a POST request, the AI Tools Widget module defines a function that renders a custom widget in the Crowdin Editor. This widget is loaded directly in the browser and can interact with the Crowdin UI or call APIs as needed.

No server-side request is sent to the defined url. Instead, the widget runs entirely in the browser and relies on the HTML and JavaScript logic implemented at that path.

The widget is fully responsible for handling its input, data fetching, rendering, and user interactions.