jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

text-between-headers

Browse source
This commit is contained in:
Mendon Kissling 2024-06-07 16:24:32 -04:00
commit ef1f647b66
3 changed files with 12 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/docs/administration/api.mdx
View file

@ -14,9 +14,11 @@ The default values are `langflow` and `langflow`, respectively.
</Admonition>
## Generate an API Key
## Generate an API key
### With Langflow UI
Generate a user-specific token to use with Langflow.
### Generate an API key with the Langflow UI
<ZoomableImage
alt="Docusaurus themed image"
@ -33,7 +35,7 @@ The default values are `langflow` and `langflow`, respectively.
4. Click on "Create secret key".
5. Copy the API key and store it in a secure location.
### With Langflow CLI
### Generate an API key with the Langflow CLI
```bash
langflow api-key
@ -51,9 +53,11 @@ python -m langflow api-key
╰──────────────────────────────
```
## Use the API Key
## Use the Langflow API key
### Use the `x-api-key` Header
Include your API key in API requests to authenticate requests to Langflow.
### Use the `x-api-key` header
Include the `x-api-key` in the HTTP header when making API requests:
@ -108,7 +112,7 @@ api_key = "<your api key>"
print(run_flow(inputs, flow_id=FLOW_ID, tweaks=TWEAKS, apiKey=api_key))
```
### Use the Query Parameter
### Use the query parameter
Include the API key as a query parameter in the URL:

9
docs/docs/migration/migrating-to-one-point-zero.mdx
View file

@ -2,15 +2,6 @@ import Admonition from "@theme/Admonition";
# Migrating to Langflow 1.0: A Guide
<Admonition type="caution" icon="🚧" title="ZONE UNDER CONSTRUCTION">
<p>
We are currently working on updating this guide to provide the most accurate
and up-to-date information on migrating to Langflow 1.0. We will be adding
more content and examples to help you navigate the changes and improvements
in the new version.
</p>
</Admonition>
Langflow 1.0 is a significant update that brings many exciting changes and improvements to the platform.
This guide will walk you through the key improvements and help you migrate your existing projects to the new version.

11
docs/docs/migration/possible-installation-issues.mdx
View file

@ -4,14 +4,10 @@ This is a list of possible issues that you may encounter when installing Langflo
## _`No module named 'langflow.__main__'`_
**TL;DR**
1. Run _`python -m langflow run`_ instead of _`langflow run`_.
2. If that doesn't work, reinstall Langflow with _`_python -m pip install langflow --pre -U`_.
3. If that doesn't work, reinstall Langflow and its dependencies with _`python -m pip install langflow --pre -U --force-reinstall`_.
### Details
When you try to run Langflow using the command `langflow run`, you may encounter the following error:
```bash
@ -33,15 +29,12 @@ There are two possible reasons for this error:
## _`Something went wrong running migrations. Please, run 'langflow migration --fix'`_
**TL;DR**
Clear the cache by deleting the contents of the cache folder.
- Clear the cache by deleting the contents of the cache folder.
This folder can be found at:
This folder can be found at:
- **Linux or WSL2 on Windows**: `home/<username>/.cache/langflow/`
- **MacOS**: `/Users/<username>/Library/Caches/langflow/`
### Details
This error can occur during Langflow upgrades when the new version can't override `langflow-pre.db` in `.cache/langflow/`. Clearing the cache removes this file but will also erase your settings.
If you wish to retain your files, back them up before clearing the folder.