From a89389a05a72f09b5d390035d4c89ef414ea7fa8 Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Mon, 17 Jun 2024 18:45:27 +0800 Subject: [PATCH] [doc] RAGFlow's api key never expires (#1188) ### 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 | 2 +- docs/references/api.md | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/guides/llm_api_key_setup.md b/docs/guides/llm_api_key_setup.md index bd1019f44..598440097 100644 --- a/docs/guides/llm_api_key_setup.md +++ b/docs/guides/llm_api_key_setup.md @@ -20,7 +20,7 @@ For now, RAGFlow supports the following online LLMs. Click the corresponding lin - [VolcEngine](https://www.volcengine.com/docs/82379). :::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 diff --git a/docs/references/api.md b/docs/references/api.md index d0d91fc28..e4a153bae 100644 --- a/docs/references/api.md +++ b/docs/references/api.md @@ -14,13 +14,17 @@ https://demo.ragflow.io/v1/ ## 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. ```buildoutcfg 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: 1. In RAGFlow, click **Chat** tab in the middle top of the page.