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

docs: build OpenAPI spec and cut version 1.10 (#13537)

Browse Source 
* build-api

* bump-version-to-1.10

* fix-broken-links
This commit is contained in:
Mendon Kissling
2026-06-08 14:25:14 -04:00
committed by GitHub
parent 60afa18f05
commit 2411d8036e
528 changed files with 41198 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/create-flow.js Normal file
View File

@ -0,0 +1,35 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/`;
const options = {
method: 'POST',
headers: {
"accept": `application/json`,
"Content-Type": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
body: JSON.stringify({
"name": "string2",
"description": "string",
"icon": "string",
"icon_bg_color": "#FF0000",
"gradient": "string",
"data": {},
"is_component": false,
"updated_at": "2024-12-30T15:48:01.519Z",
"webhook": false,
"endpoint_name": "string",
"tags": [
"string"
]
}),
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));

60
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/create-flows.js Normal file
View File

@ -0,0 +1,60 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/batch/`;
const options = {
method: 'POST',
headers: {
"accept": `application/json`,
"Content-Type": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
body: JSON.stringify({
"flows": [
{
"name": "string",
"description": "string",
"icon": "string",
"icon_bg_color": "string",
"gradient": "string",
"data": {},
"is_component": false,
"updated_at": "2024-12-30T18:36:02.737Z",
"webhook": false,
"endpoint_name": "string",
"tags": [
"string"
],
"locked": false,
"user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
{
"name": "string",
"description": "string",
"icon": "string",
"icon_bg_color": "string",
"gradient": "string",
"data": {},
"is_component": false,
"updated_at": "2024-12-30T18:36:02.737Z",
"webhook": false,
"endpoint_name": "string",
"tags": [
"string"
],
"locked": false,
"user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}),
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));

19
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/delete-flow.js Normal file
View File

@ -0,0 +1,19 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/${process.env.FLOW_ID ?? ""}`;
const options = {
method: 'DELETE',
headers: {
"accept": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));

24
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/export-flows.js Normal file
View File

@ -0,0 +1,24 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/download/`;
const options = {
method: 'POST',
headers: {
"accept": `application/json`,
"Content-Type": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
body: JSON.stringify([
"e1e40c77-0541-41a9-88ab-ddb3419398b5",
"92f9a4c5-cfc8-4656-ae63-1f0881163c28"
]),
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const data = await response.arrayBuffer();
console.log("Received binary response for langflow-flows.zip", data.byteLength);
})
.catch((error) => console.error(error));

32
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/import-flows.js Normal file
View File

@ -0,0 +1,32 @@
const fs = require("fs");
const path = require("path");
const fixturesDir = path.join(__dirname, "../../fixtures");
const defaultFlowImport = path.join(fixturesDir, "flow-import.json");
const flowImportPath = process.env.FLOW_IMPORT_FILE || defaultFlowImport;
const flowBuf = fs.readFileSync(flowImportPath);
const flowName = path.basename(flowImportPath);
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/upload/?folder_id=${process.env.FOLDER_ID ?? ""}`;
const formData = new FormData();
formData.append("file", new Blob([flowBuf], { type: "application/json" }), flowName);
const options = {
method: "POST",
headers: {
accept: "application/json",
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
body: formData,
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));

19
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/read-flow.js Normal file
View File

@ -0,0 +1,19 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/${process.env.FLOW_ID ?? ""}`;
const options = {
method: 'GET',
headers: {
"accept": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));

19
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/read-flows-2.js Normal file
View File

@ -0,0 +1,19 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/?remove_example_flows=true&components_only=false&get_all=false&project_id=${process.env.PROJECT_ID ?? ""}&header_flows=false&page=1&size=1`;
const options = {
method: 'GET',
headers: {
"accept": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));

19
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/read-flows.js Normal file
View File

@ -0,0 +1,19 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/?remove_example_flows=false&components_only=false&get_all=true&header_flows=false&page=1&size=50`;
const options = {
method: 'GET',
headers: {
"accept": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));

19
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/read-sample-flows.js Normal file
View File

@ -0,0 +1,19 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/basic_examples/`;
const options = {
method: 'GET',
headers: {
"accept": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));

28
docs/versioned_docs/version-1.10.0/API-Reference/javascript-examples/api-flows/update-flow.js Normal file
View File

@ -0,0 +1,28 @@
const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/flows/${process.env.FLOW_ID ?? ""}`;
const options = {
method: 'PATCH',
headers: {
"accept": `application/json`,
"Content-Type": `application/json`,
"x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,
},
body: JSON.stringify({
"name": "string",
"description": "string",
"data": {},
"project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"endpoint_name": "my_new_endpoint_name",
"locked": true
}),
};
fetch(url, options)
.then(async (response) => {
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const text = await response.text();
console.log(text);
})
.catch((error) => console.error(error));