Skip to main content
POST
/
knowledge_bases
/
{knowledge_base_id}
/
documents
Upload a document into a knowledge base
curl --request POST \
  --url https://api.example.com/knowledge_bases/{knowledge_base_id}/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-user-id: <x-user-id>' \
  --form 'file=<string>' \
  --form 'content_type=<string>'
import requests

url = "https://api.example.com/knowledge_bases/{knowledge_base_id}/documents"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
    "x-user-id": "<x-user-id>",
    "Content-Type": "multipart/form-data"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)
const form = new FormData();
form.append('file', '<string>');
form.append('content_type', '<string>');

const options = {method: 'POST', headers: {'x-user-id': '<x-user-id>'}};

options.body = form;

fetch('https://api.example.com/knowledge_bases/{knowledge_base_id}/documents', 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://api.example.com/knowledge_bases/{knowledge_base_id}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-user-id: <x-user-id>"
  ],
]);

$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://api.example.com/knowledge_bases/{knowledge_base_id}/documents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-user-id", "<x-user-id>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/knowledge_bases/{knowledge_base_id}/documents")
  .header("x-user-id", "<x-user-id>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/knowledge_bases/{knowledge_base_id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-user-id"] = '<x-user-id>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "document_id": "<string>",
  "filename": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

​
x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Path Parameters

​
knowledge_base_id
string
required

The knowledge base id.

Body

multipart/form-data
​
file
string
required

The document to index (PDF, TXT, Markdown, …).

​
content_type
string | null

Override the IANA media type used to route the upload. Defaults to the type guessed from the filename.

Response

Successful Response

Response body after uploading a document into a knowledge base.

​
document_id
string
required

Server-assigned document identifier.

​
filename
string
required

The original filename of the uploaded document.

​
status
enum<string>
required

Lifecycle state immediately after upload — always 'pending' in the happy path; surfaced so the client can seed its progress tracker without an extra round-trip.

Available options:
pending,
parsing,
chunking,
indexing,
ready,
error