AI/ragflow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-08-12 18:19:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update api.md (#1961)

Browse Source 
### What problem does this PR solve?

### Type of change

- [x] Documentation Update
This commit is contained in:
H 2024-08-15 14:52:23 +08:00 committed by GitHub
parent 5169299826
commit ef8728a314
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/references/api.md
View File

@ -25,12 +25,19 @@ Authorization: Bearer {API_KEY}
In the current design, the RESTful API key you get from RAGFlow does not expire. In the current design, the RESTful API key you get from RAGFlow does not expire.
::: :::
To get your API key: To get your Chat API key or Agent API key:
1. In RAGFlow, click **Chat** tab in the middle top of the page. For Chat API key:
2. Hover over the corresponding dialogue **>** **Chat Bot API** to show the chatbot API configuration page. 1. In RAGFlow, click **Chat** tab in the middle top of the page.
3. Click **Api Key** **>** **Create new key** to create your API key. 2. Hover over the corresponding dialogue **>** **Chat Bot API** to show the chatbot API configuration page.
4. Copy and keep your API key safe. 3. Click **Api Key** **>** **Create new key** to create your API key.
4. Copy and keep your API key safe.
For Agent API key:
1. In RAGFlow, click **Agent** tab in the middle top of the page.
2. Click your agent **>** ** Chat Bot API** to show the chatbot API configuration page.
3. Click **Api Key** **>** **Create new key** to create your API key.
4. Copy and keep your API key safe.
## Create conversation ## Create conversation
@ -212,7 +219,7 @@ This method retrieves the history of a specified conversation session.
## Get answer ## Get answer
This method retrieves from RAGFlow the answer to the user's latest question. This method retrieves from RAGFlow Chat or RAGFlow Agent the answer to the user's latest question.
### Request ### Request