IMESSAGE_SEND_FILE

macOS only

This capability uses native Apple apps and is available in the macOS edition. The Linux editions offer equivalent cross-platform capabilities instead.

Parameters

Name	Type	Required	Description
`chat_guid`	string	yes	Chat GUID or phone/email
`file_path`	string	yes	Local file path to send
`message`	string	—	Optional text to send with the file

How to use it

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

Try saying

“send a message to the team channel”

In a workflow

As a step in a multi-step workflow DAG:

{
  "id": "s1",
  "agent": "imessage",
  "action": "IMESSAGE_SEND_FILE",
  "args": {
    "chat_guid": "…",
    "file_path": "/Users/me/Documents/file.txt",
    "message": "…"
  },
  "depends_on": [],
  "outputs": []
}

Direct call

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

curl -X POST http://127.0.0.1:8000/execute_tool \
  -H "Content-Type: application/json" \
  -d '{"tool_name":"IMESSAGE_SEND_FILE","args":{"chat_guid":"…","file_path":"/Users/me/Documents/file.txt","message":"…"}}'

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