pengjunjie/langflow
1
0
Fork 1
mirror of https://github.com/langflow-ai/langflow.git synced 2026-07-25 11:10:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: combine api keys and authentication pages (#9172)

Browse Source 
* 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 <april.murphy@datastax.com>
This commit is contained in:
Mendon Kissling
2025-07-29 21:07:15 -04:00
committed by GitHub
parent cd4464d6b1
commit c03074300f
26 changed files with 521 additions and 604 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/API-Reference/api-reference-api-examples.mdx
View File

@ -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).