chat with api

[xyzhu68]

I am trying to chat in ragflow using api. But the answer from api ist not as good as in web site.
If I chat with api,using chat_id, are the system prompts automatically used? If not, how to add it? In the system prompt, there is information about the knowlege base: "{knowledge}". Is this a variable and should it be replace with knowlege base name?

[dosubot[bot]]

Hi @xyzhu68! I'm Dosu and I’m helping the ragflow team.

When you chat with the RAGFlow API using chat_id, the system prompt is automatically used. If you do not provide a custom prompt configuration, the API assigns a default system prompt, which includes a section referencing the knowledge base with the placeholder {knowledge}. This variable is not optional and must be present in the system prompt for proper knowledge base integration. The {knowledge} variable is a reserved placeholder that RAGFlow replaces with the actual content (chunks) retrieved from your selected knowledge base(s) during each API call—it should not be manually replaced with the knowledge base name; just keep it as {knowledge} in your prompt configuration. If you remove {knowledge} from the prompt, the assistant will not be able to use the knowledge base content in its answers, which can lead to poor or irrelevant responses reference reference reference.

If you want to customize the system prompt or add other variables, you can do so in the Chat Configuration under the Prompt Engine tab, and then pass values for custom variables via the API reference.

If you notice that API answers are not as good as those from the website, it may be due to differences in prompt configuration, knowledge base binding, or how the {knowledge} variable is handled. Make sure your API requests use the same assistant/chat configuration as the web UI, and that {knowledge} is present in your system prompt. If you are seeing duplicated content in both system and user fields, you can set the system prompt to empty in the web UI to avoid this reference.

To reply, just mention my name @dosu.

---

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