diff --git a/404.html b/404.html index fd301bf480..8204bc4b53 100644 --- a/404.html +++ b/404.html @@ -21,8 +21,8 @@ - - + + diff --git a/agents-tools.html b/agents-tools.html index 11923afba2..af584a13ef 100644 --- a/agents-tools.html +++ b/agents-tools.html @@ -21,8 +21,8 @@ - - + + diff --git a/agents.html b/agents.html index 89b2831e35..445b0c55e4 100644 --- a/agents.html +++ b/agents.html @@ -21,8 +21,8 @@ - - + + diff --git a/api-build.html b/api-build.html index 45bdfd1123..8b62cff56c 100644 --- a/api-build.html +++ b/api-build.html @@ -21,8 +21,8 @@ - - + + @@ -49,14 +49,14 @@ You might need to use or understand these endpoints when contributing to the Lan
  1. Send a POST request to the /build/$FLOW_ID/flow endpoint.
-

_10
curl -X POST \
_10
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: application/json" \
_10
-d '{
_10
"inputs": {
_10
"input_value": "Tell me a story"
_10
}
_10
}'

+

_10
curl -X POST \
_10
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY" \
_10
-d '{
_10
"inputs": {
_10
"input_value": "Tell me a story"
_10
}
_10
}'

  1. After receiving a job ID from the build endpoint, use the /build/$JOB_ID/events endpoint to stream the execution results:
-

_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events" \
_10
-H "accept: application/json"

+

_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY"

The /build/$FLOW_ID/events endpoint accepts an optional stream query parameter that defaults to true. To disable streaming and get all events at once, set stream to false.

-

_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?stream=false" \
_10
-H "accept: application/json"

+

_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?stream=false" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY"

Build headers​

HeaderInfoExample
Content-TypeRequired. Specifies the JSON format."application/json"
acceptOptional. Specifies the response format."application/json"
x-api-keyOptional. Required only if authentication is enabled."sk-..."

Build parameters​

@@ -69,7 +69,7 @@ For example, to stop flow execution at the Open AI model component, run the foll

Override flow parameters​

The /build endpoint also accepts inputs for data directly, instead of using the values stored in the Langflow database. This is useful for running flows without having to pass custom values through the UI.

-

_14
curl -X POST \
_14
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
_14
-H "accept: application/json" \
_14
-H "Content-Type: application/json" \
_14
-d '{
_14
"data": {
_14
"nodes": [],
_14
"edges": []
_14
},
_14
"inputs": {
_14
"input_value": "Your custom input here",
_14
"session": "session_id"
_14
}
_14
}'

+

_15
curl -X POST \
_15
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
_15
-H "accept: application/json" \
_15
-H "Content-Type: application/json" \
_15
-H "x-api-key: $LANGFLOW_API_KEY" \
_15
-d '{
_15
"data": {
_15
"nodes": [],
_15
"edges": []
_15
},
_15
"inputs": {
_15
"input_value": "Your custom input here",
_15
"session": "session_id"
_15
}
_15
}'

See also​

API keys

-

Langflow provides an API key functionality that allows users to access their individual components and flows without traditional login authentication.

+

You can use Langflow API keys to interact with Langflow programmatically.

+

The API key has the same permissions and access as you do when you launch Langflow. This means your API key can only access your own flows, components, and data. You cannot access other users' resources with your own Langflow API keys. +An API key represents the user who created it. If you create a key as a superuser, then that key will have superuser privileges. +Anyone who has that key can authorize superuser actions through the Langflow API, including user management and flow management.

+

In Langflow versions 1.5 and later, most API requests require a Langflow API key, even when AUTO_LOGIN=true.

+

The only exceptions are the MCP endpoints: /v1/mcp, /v1/mcp-projects, and /v2/mcp. +These endpoints don't require authentication, regardless of the AUTO_LOGIN setting.

+
Auto-login and API key authentication in earlier Langflow versions

If you are running a Langflow version earlier than 1.5, if AUTO_LOGIN=true, Langflow automatically logs users in as a superuser without requiring authentication, and API requests can be made without a Langflow API key.

If you set SKIP_AUTH_AUTO_LOGIN=true and AUTO_LOGIN=true, authentication will be skipped entirely, and API requests will not require a Langflow API key.

Generate a Langflow API key​

-

Generate a user-specific token to use with Langflow.

-

Generate an API key with the Langflow UI​

-
    +

    You can generate a Langflow API key with the UI or the CLI.

    +

    The UI-generated key is appropriate for most cases. The CLI-generated key is needed when your Langflow server is running in --backend-only mode.

    +
    1. Click your user icon, and then select Settings.
      2. -
    2. Click Langflow API, and then click Add New.
      3. -
    3. Name your key, and then click Create Secret Key.
      4. +
    4. Click Langflow API Keys, and then click Add New.
      5. +
    5. Name your key, and then click Create API Key.
    6. Copy the API key and store it in a secure location.
      7. -
    -

    Generate an API key with the Langflow CLI​

    -

    _13
    langflow api-key
    _13
    # or
    _13
    python -m langflow api-key
    _13
    ╭─────────────────────────────────────────────────────────────────────╮
    _13
    │ API Key Created Successfully: │
    _13
    │ │
    _13
    │ sk-O0elzoWID1izAH8RUKrnnvyyMwIzHi2Wk-uXWoNJ2Ro │
    _13
    │ │
    _13
    │ This is the only time the API key will be displayed. │
    _13
    │ Make sure to store it in a secure location. │
    _13
    │ │
    _13
    │ The API key has been copied to your clipboard. Cmd + V to paste it. │
    _13
    ╰──────────────────────────────

    +

Authenticate requests with the Langflow API key​

Include your API key in API requests to authenticate requests to Langflow.

API keys allow access only to the flows and components of the specific user to whom the key was issued.

-

Include the API key in the HTTP header​

-

To use the API key when making API requests, include the API key in the HTTP header:

-

_10
curl -X POST \
_10
"http://localhost:7860/api/v1/run/FLOW_ID?stream=false" \
_10
-H 'Content-Type: application/json' \
_10
-H 'x-api-key: API_KEY' \
_10
-d '{"inputs": {"text":""}, "tweaks": {}}'

-

Include the API key as a query parameter​

-

To pass the API key as a query parameter:

-

_10
curl -X POST \
_10
"http://localhost:7860/api/v1/run/FLOW_ID?x-api-key=API_KEY?stream=false" \
_10
-H 'Content-Type: application/json' \
_10
-d '{"inputs": {"text":""}, "tweaks": {}}'

+

To use the API key when making API requests, include the API key in the HTTP header:


_10
curl -X POST \
_10
"http://LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID?stream=false" \
_10
-H 'Content-Type: application/json' \
_10
-H 'x-api-key: LANGFLOW_API_KEY' \
_10
-d '{"inputs": {"text":""}, "tweaks": {}}'

Generate a Langflow secret key​

Langflow uses the Fernet library for encrypting sensitive data.

If no LANGFLOW_SECRET_KEY is provided, Langflow automatically generates one.

@@ -86,7 +103,7 @@
  • Apply them to specific component fields.

    • Component values set directly in a flow override values set in the UI and environment variables.

    -

    For more information, see Global variables.