← All toolsFiles & Documentsdocx_handlerAll editions

ADD_IMAGE_DOCX

Inserts an image into an existing .docx file.

Parameters

NameTypeRequiredDescription
pathstringyesAbsolute path to the .docx file
image_pathstringyesAbsolute path to the image file
width_inchesnumber—Width in inches (default: 5.0). Height auto-scales.

How to use it

You normally trigger this by describing what you want in chat — the agent selects ADD_IMAGE_DOCX automatically. For example:

Try saying
“use docx handler to add …”

In a workflow

As a step in a multi-step workflow DAG:

json
{
  "id": "s1",
  "agent": "docx_handler",
  "action": "ADD_IMAGE_DOCX",
  "args": {
    "path": "/Users/me/Documents/file.txt",
    "image_path": "/Users/me/Documents/file.txt",
    "width_inches": 1
  },
  "depends_on": [],
  "outputs": []
}

Direct call

For scripting, call it directly via POST /execute_tool. Every tool returns { success, message, data }.

bash
curl -X POST http://127.0.0.1:8000/execute_tool \
  -H "Content-Type: application/json" \
  -d '{"tool_name":"ADD_IMAGE_DOCX","args":{"path":"/Users/me/Documents/file.txt","image_path":"/Users/me/Documents/file.txt","width_inches":1}}'

Part of the docx_handler plugin. Browse the full Plugin & Tool Catalog or the relevant feature guide.