> For the complete documentation index, see [llms.txt](https://docs.langflux.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.langflux.space/using-langflux/api.md). # API ### Prediction API * POST `/api/v1/prediction/{your-chatflowid}` Request Body

Key	Description	Type	Required
question	User's question	string	Yes
overrideConfig	Override existing flow configuration	object	No
history	Provide list of history messages to the flow. Only works when using Short Term Memory	array	No

You can use the chatflow as API and connect to frontend applications.

You also have the flexibility to override input configuration with **overrideConfig** property.

{% tabs %} {% tab title="Python" %}

import requests

API_URL = "http://localhost:3000/api/v1/prediction/<chatlfowid>"

def query(payload):
    response = requests.post(API_URL, json=payload)
    return response.json()
    
output = query({
    "question": "Hey, how are you?",
    "overrideConfig": {
        "returnSourceDocuments": true
    },
    "history": [
        {
            "message": "Hello, how can I assist you?",
            "type": "apiMessage"
        },
        {
            "type": "userMessage",
            "message": "Hello I am Bob"
        },
        {
            "type": "apiMessage",
            "message": "Hello Bob! how can I assist you?"
        }
    ]
})

{% endtab %} {% tab title="Javascript" %} ```javascript async function query(data) { const response = await fetch( "http://localhost:3000/api/v1/prediction/", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify(data) } ); const result = await response.json(); return result; } query({ "question": "Hey, how are you?", "overrideConfig": { "returnSourceDocuments": true }, "history": [ { "message": "Hello, how can I assist you?", "type": "apiMessage" }, { "type": "userMessage", "message": "Hello I am Bob" }, { "type": "apiMessage", "message": "Hello Bob! how can I assist you?" } ] }).then((response) => { console.log(response); }); ``` {% endtab %} {% endtabs %} ### Vector Upsert API * POST `/api/v1/vector/upsert/{your-chatflowid}` Request Body

Key	Description	Type	Required
overrideConfig	Override existing flow configuration	object	No
stopNodeId	Node ID of the vector store. When you have multiple vector stores in a flow, you might not want to upsert all of them. Specifying `stopNodeId` will ensure only that specific vector store node is upserted.	array	No

#### Document Loaders with Upload Some document loaders in Flowise allow user to upload files:

If the flow contains [Document Loaders](/integrations/document-loaders.md) with Upload File functionality, the API looks slightly different. Instead of passing body as **JSON**, **form-data** is being used. This allows you to upload any files to the API. {% hint style="info" %} It is user's responsibility to make sure the file type is compatible with the expected file type from document loader. For example, if a Text File Loader is being used, you should only upload file with `.txt` extension. {% endhint %} {% tabs %} {% tab title="Python" %} ```python import requests API_URL = "http://localhost:3000/api/v1/vector/upsert/" # use form data to upload files form_data = { "files": ('state_of_the_union.txt', open('state_of_the_union.txt', 'rb')) } body_data = { "returnSourceDocuments": True } def query(form_data): response = requests.post(API_URL, files=form_data, data=body_data) print(response) return response.json() output = query(form_data) print(output) ``` {% endtab %} {% tab title="Javascript" %} ```javascript // use FormData to upload files let formData = new FormData(); formData.append("files", input.files[0]); formData.append("returnSourceDocuments", true); async function query(formData) { const response = await fetch( "http://localhost:3000/api/v1/vector/upsert/", { method: "POST", body: formData } ); const result = await response.json(); return result; } query(formData).then((response) => { console.log(response); }); ``` {% endtab %} {% endtabs %} #### Document Loaders without Upload For other [Document Loaders](/integrations/document-loaders.md) nodes without Upload File functionality, the API body is in **JSON** format similar to [Prediction API](#prediction-api). ### Message API * GET `/api/v1/chatmessage/{your-chatflowid}` * DELETE `/api/v1/chatmessage/{your-chatflowid}` Query Parameters | Param | Type | Value | | --------- | ------ | ----------- | | sessionId | string | | | sort | enum | ASC or DESC | | startDate | string | | | endDate | string | | ### Tutorials * How to use LangFlux API {% embed url="" %} * How to use LangFlux API and connect to [Bubble](https://bubble.io/) {% embed url="" %}