How to create and use user_id

[rrrrrrtrtt]

In the HTTP API, there is a field named "user_id". How can I obtain a new user_id, and how is this user_id to be used in the agent-related APIs?

[dosubot[bot]]

To obtain a new user_id in RAGFlow, you typically go through the authentication flow using OAuth2 or OpenID Connect (OIDC). After authenticating with a third-party provider, you fetch user information (which includes identifiers like email and username) using the access token. This process is handled by the Auth module and the OAuthClient class, which manages authorization URLs, token exchanges, and user info retrieval see details.

When creating a session via the HTTP API (for example, POST to /chats/<chat_id>/sessions), you can include a user_id in the request payload. If you don't provide one, the backend may generate a new user_id using a UUID function see code.

In agent-related APIs, user_id is used to distinguish between different users' sessions. For example, when creating a session for an agent (/agents/<agent_id>/sessions), the user_id is passed as a parameter to associate the session with a specific user. This allows you to manage separate conversations for different users, even if they all interact with the same agent see usage.

In summary: authenticate to get user info (and user_id), then use user_id in session and agent APIs to track and separate user-specific data and conversations.

To reply, just mention @dosu.

---

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

[ZhenhangTung]

Hi. @rrrrrrtrtt

For basic programming or usage questions like this, we recommend using tools like GitHub Copilot or other LLM assistants — they’re great for helping with quick, straightforward queries.

You’re also welcome to join our developer community where many friendly contributors are happy to help with technical debugging and advice.

We generally use GitHub Discussions for more complex issues — such as product behavior, usage challenges, or feature requests. This helps keep the forum focused and useful for everyone.

Thanks again for your understanding!