From c03074300f71f2d17a60212dcab387b538471052 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Tue, 29 Jul 2025 21:07:15 -0400 Subject: [PATCH] docs: combine api keys and authentication pages (#9172) * combine-api-keys-and-auth * remove-old-page-redirect-and-sidebar * Update docs/docs/Configuration/api-keys-and-authentication.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix-parse-error * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * upto-env-vars * clarity-in-example * clarify-user-creation * specify-which-table * links * link text * environment variable alignment * environment variable table cleanup --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> Co-authored-by: April M --- SECURITY.md | 2 +- .../api-reference-api-examples.mdx | 9 +- docs/docs/Agents/agents.mdx | 2 +- docs/docs/Components/bundles-lmstudio.mdx | 2 +- .../components-custom-components.mdx | 10 +- docs/docs/Concepts/concepts-flows.mdx | 2 +- docs/docs/Concepts/concepts-overview.mdx | 2 +- docs/docs/Concepts/concepts-publish.mdx | 7 +- docs/docs/Concepts/mcp-server.mdx | 11 +- .../api-keys-and-authentication.mdx | 359 ++++++++++++++++++ .../Configuration/configuration-api-keys.mdx | 184 --------- .../configuration-authentication.mdx | 208 ---------- docs/docs/Configuration/configuration-cli.mdx | 80 ++-- .../Configuration/environment-variables.mdx | 195 ++++------ .../Contributing/contributing-telemetry.mdx | 2 +- .../Develop/Clients/typescript-client.mdx | 2 +- docs/docs/Develop/develop-application.mdx | 4 +- docs/docs/Develop/memory.mdx | 6 +- .../Get-Started/get-started-quickstart.mdx | 5 +- docs/docs/Support/release-notes.mdx | 2 +- docs/docs/Tutorials/agent.mdx | 4 +- docs/docs/Tutorials/chat-with-files.mdx | 4 +- docs/docs/Tutorials/chat-with-rag.mdx | 4 +- docs/docs/Tutorials/mcp-tutorial.mdx | 4 +- docs/docusaurus.config.js | 4 +- docs/sidebars.js | 11 +- 26 files changed, 521 insertions(+), 604 deletions(-) create mode 100644 docs/docs/Configuration/api-keys-and-authentication.mdx delete mode 100644 docs/docs/Configuration/configuration-api-keys.mdx delete mode 100644 docs/docs/Configuration/configuration-authentication.mdx diff --git a/SECURITY.md b/SECURITY.md index d4f3cb15d..275df1f23 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -59,4 +59,4 @@ Setting `LANGFLOW_SKIP_AUTH_AUTO_LOGIN=true` and `LANGFLOW_AUTO_LOGIN=true` skip `LANGFLOW_SKIP_AUTH_AUTO_LOGIN=true` is the default behavior, so users do not need to change existing workflows in 1.5. To update your workflows to require authentication, set `LANGFLOW_SKIP_AUTH_AUTO_LOGIN=false`. -For more information, see [Authentication](https://docs.langflow.org/configuration-authentication). \ No newline at end of file +For more information, see [API keys and authentication](https://docs.langflow.org/api-keys-and-authentication). \ No newline at end of file diff --git a/docs/docs/API-Reference/api-reference-api-examples.mdx b/docs/docs/API-Reference/api-reference-api-examples.mdx index 29f30b140..0f64dfa83 100644 --- a/docs/docs/API-Reference/api-reference-api-examples.mdx +++ b/docs/docs/API-Reference/api-reference-api-examples.mdx @@ -59,11 +59,8 @@ You can configure the Langflow port number in the `LANGFLOW_PORT` [environment v ### Authentication -In Langflow versions 1.5 and later, most API endpoints require a Langflow API key, even when `AUTO_LOGIN` is set to `True`. -The only exceptions are the MCP endpoints `/v1/mcp`, `/v1/mcp-projects`, and `/v2/mcp`, which never require authentication. - -To authenticate a Langflow API request, provide a Langflow API key in either an `x-api-key` header or query parameter. -For more information, see [API keys](/configuration-api-keys). +In Langflow versions 1.5 and later, most API endpoints require authentication with a Langflow API key in either an `x-api-key` header or query parameter. +For more information, see [API keys and authentication](/api-keys-and-authentication). As with any API, follow industry best practices for storing and referencing sensitive credentials. For example, you can [set environment variables](#set-environment-variables) for your API keys, and then reference those environment variables in your API requests. @@ -117,7 +114,7 @@ curl --request POST \ }' ``` -Commonly used values in Langflow API requests include your [Langflow server URL](#base-url), [Langflow API keys](/configuration-api-keys), flow IDs, and [project IDs](/api-projects#read-projects). +Commonly used values in Langflow API requests include your [Langflow server URL](#base-url), [Langflow API keys](#authentication), flow IDs, and [project IDs](/api-projects#read-projects). You can retrieve flow IDs from the [**API access** pane](/concepts-publish#api-access), in a flow's URL, and with [`GET /flows`](/api-flows#read-flows). diff --git a/docs/docs/Agents/agents.mdx b/docs/docs/Agents/agents.mdx index 5ab6e88a2..ed6aecbfa 100644 --- a/docs/docs/Agents/agents.mdx +++ b/docs/docs/Agents/agents.mdx @@ -115,7 +115,7 @@ For example, to use the default OpenAI model, you must provide a valid OpenAI AP You can enter the key directly, but it is recommended that you follow industry best practices for storing and referencing API keys. For example, you can use a