Can the agent application retrieve the sys.user_id variable information

[idleQing]

Self Checks

• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:)
• Please do not modify this template :) and fill in all the required fields.

1. Is this request related to a challenge you're experiencing? Tell me about your story.

Can the agent application obtain the variable information of sys.user_id?

2. Additional context or comments

No response

[dosubot[bot]]

Yes, agent applications in Dify can retrieve the sys.user_id variable. sys.user_id is a built-in system variable that uniquely identifies the current user and is always present in the workflow or chatflow context. You can reference it in workflow nodes, code nodes, templates (like {{sys.user_id}}), and custom tool plugins.

If you are embedding an agent application via iframe, you need to GZIP-compress, Base64-encode, and URI-encode the user ID, then pass it as a sys.user_id parameter in the iframe URL for Dify to recognize it. In API calls, sys.user_id is set to the value you provide in the user field of your request. In the IDE, it uses the internal admin Account's UUID as the user context—these environments are intentionally isolated and do not share user context automatically.

For more details and code examples on passing sys.user_id via iframe, see this issue. For plugin and workflow access, see this discussion and this workflow variable guide.

If you need to use sys.user_id inside a workflow or plugin, just reference it as sys.user_id in your logic or template.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}

   

[idleQing]

I used 'agent' instead of 'chatflow' or 'workflow'

[dosubot[bot]]

Yes, agent applications in Dify can access sys.user_id just like chatflow and workflow apps. In the agent context, sys.user_id is carried as the user_id field in the AgentChatAppGenerateEntity and is passed through all agent execution logic, so it's available for use in templates, tools, and plugins within the agent app context. There’s no special handling—agents reuse the same user_id plumbing as chatflow/workflow, so you can reference sys.user_id in your agent logic or templates as needed see code see runner.

If you’re embedding an agent via iframe, make sure to GZIP-compress, Base64-encode, and URI-encode the user ID, then pass it as a sys.user_id parameter in the iframe URL so Dify can recognize it details. For API calls, set the user field in your request to control sys.user_id.

Let me know if you need an example or run into any issues with sys.user_id in your agent app!

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}

   

[idleQing]

Is this the way I quoted it in the picture?

[dosubot[bot]]

Yes, the way you referenced {{sys.user_id}} in the orchestration (编排) prompt input area is correct. Dify uses double curly braces for variable interpolation in prompts, and sys.user_id is available as a built-in system variable in agent applications. As long as sys.user_id is set in your context (for example, passed via API, iframe, or config), it will be resolved at runtime in your agent prompt just as shown in your screenshot. This syntax is consistent across agents, workflows, and chatflows in Dify, and no special handling is needed for agents—just use {{sys.user_id}} where you want the user ID to appear in your prompt template reference reference.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}