yujunjun/ragflow
1
0
Fork 0
mirror of https://github.com/infiniflow/ragflow.git synced 2025-10-29 17:00:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
### 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
This commit is contained in:
writinwaters 2024-06-17 18:45:27 +08:00 committed by GitHub
parent d9a9be4b4c
commit a89389a05a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/guides/llm_api_key_setup.md
View File

@ -20,7 +20,7 @@ For now, RAGFlow supports the following online LLMs. Click the corresponding lin
- [VolcEngine](https://www.volcengine.com/docs/82379). - [VolcEngine](https://www.volcengine.com/docs/82379).
:::note :::note
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). 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).
::: :::
## Configure your API key ## Configure your API key

6
docs/references/api.md
View File

@ -14,13 +14,17 @@ https://demo.ragflow.io/v1/
## Authorization ## Authorization
All of RAGFlow's RESTFul APIs use API key for authorization, so keep it safe and do not expose it to the front end. All of RAGFlow's RESTful APIs use API key for authorization, so keep it safe and do not expose it to the front end.
Put your API key in the request header. Put your API key in the request header.
```buildoutcfg ```buildoutcfg
Authorization: Bearer {API_KEY} Authorization: Bearer {API_KEY}
``` ```
:::note
In the current design, the RESTful API key you get from RAGFlow does not expire.
:::
To get your API key: To get your API key:
1. In RAGFlow, click **Chat** tab in the middle top of the page. 1. In RAGFlow, click **Chat** tab in the middle top of the page.