Get presigned URL for document upload

curl --request POST \
  --url https://api.example.com/api/v1/knowledge-base/upload-url \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "filename": "<string>",
  "mime_type": "<string>",
  "file_size": 123,
  "custom_metadata": {}
}
'

import requests

url = "https://api.example.com/api/v1/knowledge-base/upload-url"

payload = {
    "filename": "<string>",
    "mime_type": "<string>",
    "file_size": 123,
    "custom_metadata": {}
}
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({
    filename: '<string>',
    mime_type: '<string>',
    file_size: 123,
    custom_metadata: {}
  })
};

fetch('https://api.example.com/api/v1/knowledge-base/upload-url', 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/api/v1/knowledge-base/upload-url",
  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([
    'filename' => '<string>',
    'mime_type' => '<string>',
    'file_size' => 123,
    'custom_metadata' => [
        
    ]
  ]),
  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://api.example.com/api/v1/knowledge-base/upload-url"

	payload := strings.NewReader("{\n  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"file_size\": 123,\n  \"custom_metadata\": {}\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://api.example.com/api/v1/knowledge-base/upload-url")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"file_size\": 123,\n  \"custom_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/knowledge-base/upload-url")

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  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"file_size\": 123,\n  \"custom_metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "upload_url": "<string>",
  "document_uuid": "<string>",
  "s3_key": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Knowledge Base

Get presigned URL for document upload

Generate a presigned PUT URL for uploading a document.

This endpoint:

Generates a unique document UUID for organizing the S3 key
Generates a presigned S3/MinIO URL for uploading the file
Returns the upload URL and document metadata

After uploading to the returned URL, call /process-document to create the document record and trigger processing.

Access Control:

All authenticated users can upload documents scoped to their organization.

POST

api

knowledge-base

upload-url

Get presigned URL for document upload

curl --request POST \
  --url https://api.example.com/api/v1/knowledge-base/upload-url \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "filename": "<string>",
  "mime_type": "<string>",
  "file_size": 123,
  "custom_metadata": {}
}
'

import requests

url = "https://api.example.com/api/v1/knowledge-base/upload-url"

payload = {
    "filename": "<string>",
    "mime_type": "<string>",
    "file_size": 123,
    "custom_metadata": {}
}
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({
    filename: '<string>',
    mime_type: '<string>',
    file_size: 123,
    custom_metadata: {}
  })
};

fetch('https://api.example.com/api/v1/knowledge-base/upload-url', 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/api/v1/knowledge-base/upload-url",
  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([
    'filename' => '<string>',
    'mime_type' => '<string>',
    'file_size' => 123,
    'custom_metadata' => [
        
    ]
  ]),
  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://api.example.com/api/v1/knowledge-base/upload-url"

	payload := strings.NewReader("{\n  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"file_size\": 123,\n  \"custom_metadata\": {}\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://api.example.com/api/v1/knowledge-base/upload-url")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"file_size\": 123,\n  \"custom_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/knowledge-base/upload-url")

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  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"file_size\": 123,\n  \"custom_metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "upload_url": "<string>",
  "document_uuid": "<string>",
  "s3_key": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization

string | null

X-API-Key

string | null

Body

application/json

Request schema for initiating document upload.

filename

string

required

Name of the file to upload

mime_type

string

required

MIME type of the file

file_size

integer | null

Size of the file in bytes (checked against the 100 MB limit)

custom_metadata

object | null

Optional custom metadata

Response

Successful Response

Response schema containing upload URL and document metadata.

upload_url

string

required

Signed URL for uploading the file

document_uuid

string

required

Unique identifier for the document

s3_key

string

required

Storage key the file should be uploaded to.

Start

Endpoints

Get presigned URL for document upload

Authorizations

Headers

Body

Response