writinwaters commited on
Commit
460dec2
·
1 Parent(s): 9bca6cf

[doc] RAGFlow's api key never expires (#1188)

Browse files

### What problem does this PR solve?

_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._

### Type of change

- [x] Documentation Update

docs/guides/llm_api_key_setup.md CHANGED
@@ -20,7 +20,7 @@ For now, RAGFlow supports the following online LLMs. Click the corresponding lin
20
  - [VolcEngine](https://www.volcengine.com/docs/82379).
21
 
22
  :::note
23
- If you find your online LLM is not on the list, don't feel disheartened. The list is expanding, and you can [file a feature request](https://github.com/infiniflow/ragflow/issues/new?assignees=&labels=feature+request&projects=&template=feature_request.yml&title=%5BFeature+Request%5D%3A+) with us! Alternatively, if you have customized models or have locally-deployed models, you can [bind them to RAGFlow using Ollama or Xinference](./deploy_local_llm.md).
24
  :::
25
 
26
  ## Configure your API key
 
20
  - [VolcEngine](https://www.volcengine.com/docs/82379).
21
 
22
  :::note
23
+ If you find your online LLM is not on the list, don't feel disheartened. The list is expanding, and you can [file a feature request](https://github.com/infiniflow/ragflow/issues/new?assignees=&labels=feature+request&projects=&template=feature_request.yml&title=%5BFeature+Request%5D%3A+) with us! Alternatively, if you have customized or locally-deployed models, you can [bind them to RAGFlow using Ollama or Xinference](./deploy_local_llm.md).
24
  :::
25
 
26
  ## Configure your API key
docs/references/api.md CHANGED
@@ -14,13 +14,17 @@ https://demo.ragflow.io/v1/
14
 
15
  ## Authorization
16
 
17
- All of RAGFlow's RESTFul APIs use API key for authorization, so keep it safe and do not expose it to the front end.
18
  Put your API key in the request header.
19
 
20
  ```buildoutcfg
21
  Authorization: Bearer {API_KEY}
22
  ```
23
 
 
 
 
 
24
  To get your API key:
25
 
26
  1. In RAGFlow, click **Chat** tab in the middle top of the page.
 
14
 
15
  ## Authorization
16
 
17
+ All of RAGFlow's RESTful APIs use API key for authorization, so keep it safe and do not expose it to the front end.
18
  Put your API key in the request header.
19
 
20
  ```buildoutcfg
21
  Authorization: Bearer {API_KEY}
22
  ```
23
 
24
+ :::note
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.