Add an uploaded file to a knowledge collection
curl --request POST \
--url https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"fileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"chunkSize": 1000,
"chunkOverlap": 100
}
'import requests
url = "https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file"
payload = {
"fileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"chunkSize": 1000,
"chunkOverlap": 100
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fileId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
chunkSize: 1000,
chunkOverlap: 100
})
};
fetch('https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fileId' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
'chunkSize' => 1000,
'chunkOverlap' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file"
payload := strings.NewReader("{\n \"fileId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"chunkSize\": 1000,\n \"chunkOverlap\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fileId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"chunkSize\": 1000,\n \"chunkOverlap\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fileId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"chunkSize\": 1000,\n \"chunkOverlap\": 100\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"documentIds": [
""
],
"chunkCount": 0,
"collectionId": "",
"collectionName": "",
"alreadyInCollection": true,
"sourceKey": "",
"fileName": "",
"url": ""
}
}Knowledge
Add an uploaded file to a knowledge collection
Extracts text, splits it, embeds, and indexes the file into this collection.
POST
/
api
/
v1
/
knowledge
/
collections
/
{id}
/
ingest
/
file
Add an uploaded file to a knowledge collection
curl --request POST \
--url https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"fileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"chunkSize": 1000,
"chunkOverlap": 100
}
'import requests
url = "https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file"
payload = {
"fileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"chunkSize": 1000,
"chunkOverlap": 100
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fileId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
chunkSize: 1000,
chunkOverlap: 100
})
};
fetch('https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fileId' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
'chunkSize' => 1000,
'chunkOverlap' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file"
payload := strings.NewReader("{\n \"fileId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"chunkSize\": 1000,\n \"chunkOverlap\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fileId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"chunkSize\": 1000,\n \"chunkOverlap\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/knowledge/collections/{id}/ingest/file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fileId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"chunkSize\": 1000,\n \"chunkOverlap\": 100\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"documentIds": [
""
],
"chunkCount": 0,
"collectionId": "",
"collectionName": "",
"alreadyInCollection": true,
"sourceKey": "",
"fileName": "",
"url": ""
}
}Authorizations
x-api-keyx-api-key & x-username
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Headers
External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.
Path Parameters
Collection ID
Example:
"755ab29c-2864-5cfd-9c2b-4953f7314b21"
Body
application/json
File id from POST /file/upload/single/chat
Minimum string length:
1Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Split size in characters (default 1000)
Required range:
100 <= x <= 4000Example:
1000
Overlap between splits in characters (default 100)
Required range:
0 <= x <= 500Example:
100
Response
200 - application/json
File added to collection
Success status
Example:
true
Success message
Example:
"Operation completed successfully"
Show child attributes
Show child attributes
Example:
{
"documentIds": [""],
"chunkCount": 0,
"collectionId": "",
"collectionName": "",
"alreadyInCollection": true,
"sourceKey": "",
"fileName": "",
"url": ""
}
Was this page helpful?