H commited on
Commit
591d80e
·
1 Parent(s): fb3b3ab

Update api.md (#1961)

Browse files

### What problem does this PR solve?

### Type of change

- [x] Documentation Update

Files changed (1) hide show
  1. docs/references/api.md +13 -6
docs/references/api.md CHANGED
@@ -25,12 +25,19 @@ Authorization: Bearer {API_KEY}
25
  In the current design, the RESTful API key you get from RAGFlow does not expire.
26
  :::
27
 
28
- To get your API key:
29
 
30
- 1. In RAGFlow, click **Chat** tab in the middle top of the page.
31
- 2. Hover over the corresponding dialogue **>** **Chat Bot API** to show the chatbot API configuration page.
32
- 3. Click **Api Key** **>** **Create new key** to create your API key.
33
- 4. Copy and keep your API key safe.
 
 
 
 
 
 
 
34
 
35
  ## Create conversation
36
 
@@ -212,7 +219,7 @@ This method retrieves the history of a specified conversation session.
212
 
213
  ## Get answer
214
 
215
- This method retrieves from RAGFlow the answer to the user's latest question.
216
 
217
  ### Request
218
 
 
25
  In the current design, the RESTful API key you get from RAGFlow does not expire.
26
  :::
27
 
28
+ To get your Chat API key or Agent API key:
29
 
30
+ For Chat API key:
31
+ 1. In RAGFlow, click **Chat** tab in the middle top of the page.
32
+ 2. Hover over the corresponding dialogue **>** **Chat Bot API** to show the chatbot API configuration page.
33
+ 3. Click **Api Key** **>** **Create new key** to create your API key.
34
+ 4. Copy and keep your API key safe.
35
+
36
+ For Agent API key:
37
+ 1. In RAGFlow, click **Agent** tab in the middle top of the page.
38
+ 2. Click your agent **>** ** Chat Bot API** to show the chatbot API configuration page.
39
+ 3. Click **Api Key** **>** **Create new key** to create your API key.
40
+ 4. Copy and keep your API key safe.
41
 
42
  ## Create conversation
43
 
 
219
 
220
  ## Get answer
221
 
222
+ This method retrieves from RAGFlow Chat or RAGFlow Agent the answer to the user's latest question.
223
 
224
  ### Request
225